Register webhook

Creates a new webhook that listens for specified events in a workspace.

POST /api/v1/webhooks

API key in header x-api-key

curl 'https://transcript.lol/api/v1/webhooks' \
  --request POST \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "event": "TRANSCRIPT_CREATED",
  "url": "https://example.com",
  "workspaceId": "workspace_01JXY9AZK4KV"
}'

{
  "event": "TRANSCRIPT_CREATED",
  "workspaceId": "workspace_01JXY9AZK4KV",
  "createdById": "created_by_01JXY9AZK4KV",
  "url": "https://example.com"
}

New webhook object

Body

application/json

Webhook options

event WebhookEvent · enum required

Events you want to subscribe to.

To subscribe to multiple events, create multiple webhooks with the same url and different event types.

values

TRANSCRIPT_CREATED
TRANSLATION_CREATED
INSIGHT_CREATED

url string required

URL where you will be notifed when the event occurs

workspaceId string required

ID of the workspace on which you get notified about the events

Body

Responses