Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

API key authentication. Use format: Authorization: Bearer tavrn_sk_live_...

Body

application/json
name
string
required

Webhook name, unique within your organization

Required string length: 1 - 100
Example:

"Production webhook"

url
string<uri>
required

Webhook endpoint URL (must use HTTP/HTTPS)

Maximum string length: 2048
Example:

"https://client.example.com/webhooks/tavrn"

events
enum<string>[]
required

Event types to subscribe to (at least one required)

Minimum array length: 1
Available options:
retrieval_request.status_changed,
retrieval_request.action_required,
retrieval_request.documents_available
Example:
description
string | null

Optional webhook description

Maximum string length: 500
Example:

"Production webhook for retrieval events"

Response

Webhook created successfully (secret is ONLY returned here!)

Creation response. Read or list the webhook for delivery health fields.

id
string
required

Opaque webhook identifier.

Example:

"507f1f77bcf86cd799439016"

name
string
required

Webhook name, unique within your organization

Example:

"Production webhook"

url
string<uri>
required
Example:

"https://client.example.com/webhooks/tavrn"

description
string | null
required

Optional webhook description

events
enum<string>[]
required
Available options:
retrieval_request.status_changed,
retrieval_request.action_required,
retrieval_request.documents_available
secret
string
required

Webhook secret, returned only on creation. Store it securely.

Example:

"whsec_XyZ789AbCdEfGhIjKlMnOpQrSt"

is_enabled
boolean
required
Example:

true

auto_disabled_at
string<date-time> | null
required

Always null when the webhook is created

last_failure
object | null
required

Always null when the webhook is created

created_at
string<date-time>
required
Example:

"2026-10-08T12:00:00.000Z"