Skip to main content
GET
Get a webhook subscription

Path Parameters

webhook_id
string
required

Response

webhook_id
string<uuid>
required

Platform-assigned stable identifier.

name
string
required

Human-readable name for the subscription.

url
string<uri>
required

HTTPS endpoint deliveries are POSTed to.

event
string
required

The event type this subscription receives.

status
enum<string>
required
Available options:
ACTIVE,
PAUSED,
FAILED
custom_header_names
string[]
required

Names of configured custom headers. Header values are never returned.

failure_count
number
required

Consecutive delivery failures since the last success.

created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
api_version
string | null

Pinned payload API version.

last_failure_at
string<date-time> | null
last_success_at
string<date-time> | null
last_status_code
number | null
last_delivery_at
string<date-time> | null