Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Path Parameters

id
string
required

The webhook endpoint id.

Response

The webhook endpoint

A registered webhook endpoint. The signing secret is never included in this representation; custom header values are redacted.

id
string
name
string
url
string
events
enum<string>[]

A terminal async-job event a webhook endpoint can subscribe to:

  • async_job.completed: an async job finished successfully
  • async_job.failed: an async job finished with an error
Available options:
async_job.completed,
async_job.failed
headers
object

Custom delivery header values, redacted.

include_response
boolean
allow_private_network
boolean
disabled
boolean
max_retries
integer
retry_backoff_initial_seconds
integer
retry_backoff_max_seconds
integer
attempt_timeout_seconds
integer
max_response_payload_kbs
integer
max_concurrent_deliveries
integer
consecutive_failures
integer

Number of consecutive failed deliveries; reset on the next success.

last_success_at
string<date-time>
last_failure_at
string<date-time>
config_hash
string
created_at
string<date-time>
updated_at
string<date-time>