Skip to main content
GET
Get webhook by ID

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Webhook ID

Response

Successful response

id
string
required

Opaque webhook identifier.

Example:

"507f1f77bcf86cd799439016"

name
string
required

Webhook name, unique within your organization

Example:

"Production webhook"

url
string<uri>
required

Webhook endpoint URL (must use HTTP/HTTPS)

Example:

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

events
enum<string>[]
required

Subscribed event types. New and updated subscriptions require at least one event.

Available options:
retrieval_request.status_changed,
retrieval_request.action_required,
retrieval_request.documents_available
Example:
description
string | null
required

Optional webhook description

Example:

"Production webhook for retrieval events"

is_enabled
boolean
required

Whether webhook is enabled

Example:

true

consecutive_failures
integer
required

Count of consecutive events that failed after all delivery attempts

Example:

0

last_failure_at
string<date-time> | null
required

Last event that failed after all delivery attempts (ISO 8601), or null

last_success_at
string<date-time> | null
required

Last successful event delivery (ISO 8601), or null

auto_disabled_at
string<date-time> | null
required

When Tavrn automatically disabled this webhook after 5 consecutive failed deliveries (ISO 8601), or null. Cleared when you set is_enabled to true.

last_failure
object | null
required

Most recent unsuccessful delivery attempt, or null. Test events are excluded.

secret_hint
string
required

Last 4 characters of webhook secret (for identification)

Example:

"...Ab12"

created_by
string
required

User or API key that created the webhook

created_at
string<date-time>
required

Creation timestamp (ISO 8601)

Example:

"2025-02-01T12:34:56Z"

updated_at
string<date-time>
required

Last update timestamp (ISO 8601)

Example:

"2025-02-01T12:34:56Z"