Webhook

Update

You can update definition of an existing webhook: change events it's subscribed to, edit description or your metaData.

This is a partial update. Send callbackUrl on every call, and send only the other fields you want to change: any field you leave out keeps its stored value. To clear a field, send it with an empty value rather than omitting it.

put/webhook/{webhookId}

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/webhook/{webhookId}
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

webhookIdstring required

Request body

callbackUrlstring required

Give the URL Speak posts events to. Send it on every update, even when you are only changing something else. required; validated as a plain string with no length cap and no uri format check

metaDataobject

Replace the data Speak merges into the body of every delivery for this webhook. Speak adds eventType, deliveryId and the fields for the event that fired on top of it. optional, unconstrained object, any keys accepted. Omit it and the stored value is left unchanged: the controller passes the destructured value into findOneAndUpdate, and an undefined key is dropped before the update is sent rather than written over what is there.

mediaIdstring

Scope the webhook to a single media item instead of your whole account. optional, empty string allowed, no length cap

eventsstring[]

Replace the list of events this webhook receives. explicitly.optional; no minimum or maximum item count. Each item must be one of the 18 listed values, which come from WebhookEvent.

descriptionstring

Describe what this webhook does on your side so you can recognize it later. optional, empty string allowed, no length cap

Response

OK

statusstring
messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.