Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

Headers

X-Organization-Id
string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing. Absent, the session's default organization answers.

Path Parameters

id
string<uuid>
required

The webhook endpoint's id.

Body

application/json
url
string<uri>
description
string
subscribed_events
string[]
status
enum<string>
Available options:
enabled,
disabled

Response

Updated.

id
string<uuid>
url
string<uri>

Where deliveries are POSTed. https:// only.

description
string
subscribed_events
string[]

Types from the published catalogue. Empty means every deliverable event — a new type then starts arriving without anything being changed here.

status
enum<string>

disabled is either your decision or the auto-disable after sustained failure. A disabled endpoint is queued nothing.

Available options:
enabled,
disabled
consecutive_failures
integer

Deliveries that spent every attempt, back to back. Any success resets it.

disabled_at
string<date-time> | null
disabled_reason
string
recent_failures
integer

Deliveries that gave up in the last 24 hours.

created_at
string<date-time>