DocsAPI ReferenceRegister a webhook endpoint
POST/api/v1/workspaces/{workspace_id}/webhooks

Registers a new HTTPS endpoint to receive webhook events via Svix. If `filter_types` is omitted, the endpoint receives all events. Valid event types: `bot.status_changed`, `bot.completed`, `transcription.ready`, `recording.ready`, `transcription.segment`.

Path Parameters

workspace_idstringrequirede.g. "aaaaaaaa-0000-0000-0000-000000000001"

Workspace UUID.

Headers

X-API-Keystringrequired

Your workspace API key (owner role required).

Content-Typestringrequired

Must be `application/json`.

Request Body

application/json

urlstringrequired

HTTPS URL to deliver events to.

Example: "https://your-server.com/webhooks/serveka"

descriptionstring

Human-readable label.

Example: "Production event handler"

filter_typesarray

Event types to subscribe to. Omit to receive all events.

Example: ["bot.completed","transcription.ready","recording.ready"]

Responses

201Webhook endpoint registered.
{
  "id": "ep_2abc1234...",
  "url": "https://your-server.com/webhooks/serveka",
  "description": "Production event handler",
  "disabled": false,
  "filter_types": [
    "bot.completed",
    "transcription.ready",
    "recording.ready"
  ],
  "created_at": "2026-05-12T10:00:00Z"
}
422Unknown event type in `filter_types`.
503Svix API key not configured.