Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
workspace

Update Workspace Webhook

Update the specified workspace webhook

patch/v1/workspace/webhooks/{webhook_id}

Path parameters

webhook_idstring required

The unique ID for the webhook

Example:G007vmtq9uWYl7SUW9zGS8GZZa1K

The unique ID for the webhook

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

is_disabledboolean required

Whether to disable or enable the webhook

namestring required

The display name of the webhook (used for display purposes only).

retry_enabledboolean nullable

Whether to enable automatic retries for transient failures (5xx, 429, timeout)

request_headersobject nullable

A list of request headers to include with the webhook delivery (optional)

eventsWorkspaceWebhookEventType[] nullable

The complete set of workspace-level events this webhook should be subscribed to. The webhook is added to the events in the list and removed from any not in the list. Omit to leave the current event subscriptions unchanged.

Example request

{
  "is_disabled": true,
  "name": "My Callback Webhook",
  "retry_enabled": true,
  "events": [
    "voice_library_removal_notice",
    "speech_to_text"
  ]
}

Response

Successful Response

statusstring required

The status of the workspace webhook patch request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned.

Example response

{
  "status": "ok"
}