Lexicon Garden

place.stream.server.updateWebhook

Update an existing webhook configuration.

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.

description

string

A description of what this webhook is used for.

  • maxLength: 500

events

array

The types of events this webhook should receive.

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

id

requiredstring

The ID of the webhook to update.

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

string · uri

The webhook URL where events will be sent.

Output

application/json

Errors

WebhookNotFound

The specified webhook was not found.

Unauthorized

The authenticated user does not have access to this webhook.

InvalidUrl

The provided webhook URL is invalid or unreachable.

DuplicateWebhook

A webhook with this URL already exists for this user.

Similar lexicons

semantic match

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