place.stream.server.updateWebhook
Update an existing webhook configuration.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | server.stream.place |
| Indexed |
Procedure
procedure · POSTParameters
query stringInput
application/jsonactive
booleanWhether this webhook should be active.
description
stringA description of what this webhook is used for.
maxLength: 500
events
arrayThe types of events this webhook should receive.
enum: chat | livestream | follow | mention | stream.received
The ID of the webhook to update.
muteWords
arrayWords to filter out from chat messages. Messages containing any of these words will not be forwarded.
maxLength: 100
name
stringA user-friendly name for this webhook.
maxLength: 100
prefix
stringText to prepend to webhook messages.
maxLength: 100
rewrite
arrayText replacement rules for webhook messages.
suffix
stringText to append to webhook messages.
maxLength: 100
url
string · uriThe webhook URL where events will be sent.
Output
application/jsonErrors
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 matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
place.stream.server.createWebhook
procedureCreate a new webhook for receiving Streamplace events.
-
org.tangled.webhook.updateWebhook
procedureUpdate an existing webhook. Only supplied fields are changed.
-
S3 storage configuration for backups.
-
place.stream.server.deleteWebhook
procedureDelete an existing webhook.