Skip to main content
GET
Get Webhook
Returns a single webhook configuration by ID.

Overview

Retrieve detailed information about a specific webhook configuration, including its health status, subscribed events, and configuration details.

Authentication

string
required
Bearer token with read:webhooks scope

Path Parameters

string
required
The webhook configuration ID (UUID v4)

Response

string
Unique identifier for the webhook
string
The API key ID this webhook belongs to
string
The endpoint URL receiving webhook notifications
string
Human-readable name for the webhook
string
Description of the webhook’s purpose
array
Custom headers configured for this webhook. Sensitive header values are masked.
array
Array of subscribed event type labels, spelled in the webhook’s own vocabulary
string
Which spelling this webhook receives for the five conversation events: NEUTRAL or LEGACY.NEUTRAL is the default for webhooks created since the option existed, and delivers conversation.completed, conversation.failed, conversation.started, conversation.rescheduled and conversation.cancelled. LEGACY — every webhook created before it — delivers the same five as interview.*. Nothing else differs: the same subscriptions fire on the same occasions, and ANALYSIS_*, SOURCING_*, ENRICH_* and ping carry one spelling either way. See Event name vocabulary.
boolean
Whether the webhook is currently active
number
Maximum retry attempts for failed deliveries
number
Request timeout in milliseconds
number
Current count of consecutive delivery failures
string
ISO 8601 timestamp when circuit breaker was triggered (null if closed)
string
ISO 8601 timestamp when webhook was created
string
ISO 8601 timestamp when webhook was last updated

Example Request

Example Response

Error Responses

List Webhooks

List all webhook configurations

Update Webhook

Update webhook configuration