Get webhook endpoint by ID

GET

/webhook-endpoints/{id}

Parameters

Path Parameters

id

required

string

Webhook endpoint ID

Responses

200

object

created_at

required

string format: date-time

created_by

required

string

updated_at

required

string format: date-time

updated_by

required

string

is_soft_deleted

required

boolean

version

required

number

encryption_key_name

required

string

encryption_key_version

number

vault_key_version

number

id

required

string

url

required

HTTPS URL to POST events to

string

description

Human-readable label for this endpoint

string

enabled

required

Whether the endpoint is actively receiving deliveries

boolean

rate_limit_rps

required

Per-endpoint delivery rate limit (requests per second)

number

default: 50

signing_secret_rotated_at

Timestamp of the last signing secret rotation

string

payloadFormat

UI affordance for the payload shape (standard | slack | teams | custom). The render engine treats every non-standard endpoint identically.

string

default: standard

Allowed values: standard slack teams custom

payloadTemplate

Body template (JSON string) with {{ path }} placeholders. NULL ⇒ standard Standard-Webhooks envelope (no behaviour change).

string

headerTemplates

Header name → template string map applied to deliveries.

object

key

additional properties

string

contentType

Content-Type sent with the rendered delivery body.

string

default: application/json

consecutive_failures

Number of consecutive failed deliveries. Drives endpoint auto-disable: when it reaches the service threshold the endpoint is set enabled=false. A successful delivery resets it to 0. Read-only; surfaced so the console can distinguish an auto-disabled endpoint from a manually-paused one and prompt re-enable.

number

0

disabledAt

When the endpoint was auto-disabled by the platform (set together with enabled=false when consecutive_failures crosses the service threshold). NULL when the endpoint has never been auto-disabled, or after a re-enable clears it. Lets the console show an auto-disabled endpoint distinctly from a manually-paused one.

string

disabledReason

Why the endpoint was auto-disabled (e.g. ‘auto_consecutive_failures’). NULL when not auto-disabled / after re-enable. Paired with disabledAt; a first-class signal so the console does not have to infer auto-disable from (!enabled && consecutive_failures >= threshold).

string

404

Endpoint not found