Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <api-key>.

Body

application/json
url
string<uri>
required

HTTPS endpoint that receives delivery POSTs.

events
enum<string>[]
required

Event kinds to subscribe to. Use ["*"] for everything.

Minimum array length: 1

Webhook event taxonomy. Note that some kinds are defined but do not currently fire on the sandbox surface (e.g. right.resumed, right.expired, challenge.withdrawn, proof_pack.sealed, and the key.* kinds); subscribe to them safely for forward-compatibility.

Available options:
*,
right.issued,
right.suspended,
right.resumed,
right.revoked,
right.expired,
basis.registered,
offer.proposed,
offer.accepted,
offer.rejected,
offer.countered,
offer.withdrawn,
challenge.opened,
challenge.resolved,
challenge.withdrawn,
delivery.observed,
proof_pack.sealed,
settlement_rule.activated,
settlement_rule.superseded,
rate_card.activated,
rate_card.superseded,
dispute.opened,
dispute.resolved,
dispute.withdrawn,
dispute.escalated,
dsar_job.completed,
dsar_job.failed,
finance_period.closed,
key.issued,
key.revoked,
key.rotated
label
string
required
Required string length: 1 - 60

Response

The created subscription plus the one-time signing secret.

ok
boolean
required
data
object
required

Route-specific payload. Operation responses refine this.

contractVersion
string
required
Allowed value: "v1.0"