Skip to main content

Webhooks

Manage webhook endpoints for receiving event notifications.

List Webhooks​

GET /v1/webhooks

Returns all webhook endpoints.

curl https://scribesight.com/api/v1/webhooks \
  -H "Authorization: Bearer sk_live_xxx"

Get Webhook​

GET /v1/webhooks/{webhookId}

Returns a specific webhook endpoint.

Create Webhook​

POST /v1/webhooks

Creates a new webhook endpoint.

Request Body​

FieldTypeRequiredDescription
urlstringYesHTTPS URL to receive events
eventsarrayYesEvent types to receive
descriptionstringNoDescription
project_idsarrayNoLimit to specific projects
curl -X POST https://scribesight.com/api/v1/webhooks \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhooks/scribesight",
    "events": ["transcription.completed", "content_analysis.completed"],
    "description": "Production webhook"
  }'

Response​

{
  "data": {
    "id": "wh_xxxxxxxxxxxx",
    "url": "https://your-server.com/webhooks/scribesight",
    "events": ["transcription.completed", "content_analysis.completed"],
    "secret": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "is_active": true,
    "created_at": "2026-01-06T15:00:00Z"
  }
}
warning

The webhook secret is only returned once at creation time. Store it securely for signature verification.

Update Webhook​

PATCH /v1/webhooks/{webhookId}

Updates a webhook endpoint.

Delete Webhook​

DELETE /v1/webhooks/{webhookId}

Deletes a webhook endpoint.

Get Webhook Deliveries​

GET /v1/webhooks/{webhookId}/deliveries

Returns delivery attempts for a webhook.

Rotate Webhook Secret​

POST /v1/webhooks/{webhookId}/rotate-secret

Rotates the webhook signing secret.

Test Webhook​

POST /v1/webhooks/{webhookId}/test

Sends a test event to the webhook endpoint.