Skip to main content
GET
List Webhooks
Lists all webhook configurations for your API key.

Overview

The list webhooks endpoint returns all webhook configurations associated with your API key. Use this to monitor webhook health, check subscription status, and manage your webhook configurations.

Authentication

string
required
Bearer token with read:webhooks scope

Query Parameters

string
Filter webhooks by company ID. If provided, returns only webhooks associated with that specific company (excludes global webhooks). If omitted, returns all webhooks including global ones. Useful for ATS integrations managing multiple companies.

Response

array
Array of webhook configuration objects
number
Total number of webhook configurations

Webhook Configuration Object

string
Unique identifier for the webhook
string
The API key ID this webhook belongs to
string
Company ID this webhook is associated with. Null if webhook receives events for all companies (global webhook).
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 (e.g., “conversation.completed”), 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

Monitoring Webhook Health

Check webhook health by examining consecutiveFailures and circuitOpenedAt:

Create Webhook

Create a new webhook configuration

Webhooks Guide

Learn about webhook events and payloads