Lexicon Garden

place.stream.server.createWebhook

Create a new webhook for receiving Streamplace events.

Repository @stream.place did:plc:rbvrr34edl5ddpuwcubjiost not from the namespace authority
Details · procedure
Kindprocedure
Authorityserver.stream.place
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

active

boolean

Whether this webhook should be active upon creation.

  • default: false

description

string

A description of what this webhook is used for.

  • maxLength: 500

events

requiredarray

The types of events this webhook should receive.

itemsstring
  • enum: chat | livestream | follow | mention | stream.received

muteWords

array

Words to filter out from chat messages. Messages containing any of these words will not be forwarded.

itemsstring
  • maxLength: 100

name

string

A user-friendly name for this webhook.

  • maxLength: 100

prefix

string

Text to prepend to webhook messages.

  • maxLength: 100

rewrite

array

Text replacement rules for webhook messages.

suffix

string

Text to append to webhook messages.

  • maxLength: 100

url

requiredstring · uri

The webhook URL where events will be sent.

Output

application/json

Errors

InvalidUrl

The provided webhook URL is invalid or unreachable.

DuplicateWebhook

A webhook with this URL already exists for this user.

TooManyWebhooks

The user has reached their maximum number of webhooks.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.