Skip to main content
POST
Rotate signing secret

Authorizations

X-API-Key
string
header
required

Path Parameters

endpoint_id
string<shortuuid>
required

UUID of the webhook endpoint. Returned as the id field on every endpoint response.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A webhook endpoint as read from the API.

Returned by GET /webhooks/endpoints/{endpoint_id}/, the list view, and the rotate-secret/test endpoints. signing_secret is masked except on the initial create response and on the rotate-secret response — see :data:_SIGNING_SECRET_READ_DESC.

id
string<shortuuid>
required

UUID identifier of the endpoint. Use this in path params and the deliveries-list endpoint_id filter.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
url
string
required

Target URL the webhook payload will be POSTed to. HTTPS is required in production; http:// is accepted only by the local development server. Maximum 2048 characters. The request body is the raw event JSON; the signature lives in the X-Closient-Signature header (see signing_secret for the verification recipe).

Maximum string length: 2048
signing_secret
string
required

HMAC-SHA256 signing secret for verifying the X-Closient-Signature header on inbound deliveries. Returned in full only on creation and rotation; subsequent GET/LIST responses return a masked form (<first-8-chars>...). Verification recipe: compute HMAC-SHA256(secret, f"{timestamp}.{raw_body}") where timestamp is the t= portion of the header, then hmac.compare_digest against the v1= portion. Reject if the timestamp is older than 5 minutes (replay protection). During a 24-hour rotation grace period the header carries an additional v1old= signature using the prior secret — accept either.

is_active
boolean
required

Whether this endpoint should receive deliveries. false pauses delivery without deleting historical records or losing the signing secret — useful while debugging a customer-side outage. New events are not enqueued for inactive endpoints.

api_version
enum<string>
required

Envelope version this endpoint receives. Pinned when the endpoint is created and never moved by Closient — shipping a new envelope version does not change what an existing endpoint gets, so an integration can keep running untouched indefinitely. PATCH this field when your parser is ready for a newer shape. v1 is the pre-catalog envelope (event_type / version / event_id / timestamp / data); 2026-07-01 is the current CloudEvents-shaped envelope (type / specversion / id / time / source / data) and additionally carries the cursor used for replay-on-reconnect.

Available options:
v1,
2026-07-01
created_at
string<date-time>
required

Server-side ISO 8601 timestamp (UTC) of when the resource was first persisted.

updated_at
string<date-time>
required

Server-side ISO 8601 timestamp (UTC) of the resource's last modification.

metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.

description
string
default:""

Optional human-readable label for this endpoint. Surfaced in the brand portal's webhooks list alongside the URL — useful when a single account has separate staging / production endpoints. Maximum 255 characters. Has no effect on delivery.

Maximum string length: 255
event_types
string[]

Event types this endpoint subscribes to, drawn from the catalog at GET /webhooks/event-types/. Two forms are accepted: a full wire value (recall.opened) or a domain prefix (recall), which subscribes to every event in that domain including ones added after you subscribe — the recommended form for safety-critical domains. Values outside the catalog are rejected with 422 rather than silently accepted, so a typo cannot leave you subscribed to nothing. An empty list means every event type (fail-open); use is_active=false to pause delivery instead.