Skip to main content
POST
Error

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

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.

Corpo

application/json
url
string<uri>
obrigatório

https:// only. Deliveries never cross plaintext, and a redirect is refused rather than followed — register the final address.

environment
enum<string>
obrigatório
Opções disponíveis:
live,
test
description
string

A label, so a list of three endpoints says which is which.

subscribed_events
string[]

Types from GET /v1/organization/webhooks/events. Omit or leave empty for every deliverable event.

Resposta

Created. secret is what deliveries are signed with.

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.

Opções disponíveis:
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>
secret
string

The signing secret (uk_wh_…). Re-showable at /secret.

environment
enum<string>
Opções disponíveis:
live,
test