Create a webhook subscription

The full signing secret is only returned once in this response. Store it securely; subsequent reads only return a 4-character preview. Verify webhook deliveries by recomputing HMAC-SHA256(secret, timestamp + "." + body) and comparing with the X-Pirate-Signature header.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uri
required
enabled_events
array
length ≥ 1
Defaults to *
enabled_events
string
length ≤ 500
metadata
object

Free-form string key/value bag echoed back on responses and webhook events.

Headers
string
length between 1 and 128

Optional client-supplied request ID, echoed in X-Request-Id response header.

string
length between 1 and 255

Client-supplied key (UUID v4 recommended) for safe write retries. Server stores (key, request_hash, response) and replays. Reusing with a different body returns 409 idempotency_conflict.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json