Skip to main content
POST
Create webhook subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required
Maximum string length: 2048
events
enum<string>[]
required
Minimum array length: 1
Available options:
order.created,
order.updated,
order.assigned,
order.status_changed,
order.payment_status_changed
active
boolean

Response

The created webhook subscription. The signing secret is shown once, here, on creation.

id
integer
required
url
string<uri>
required
Example:

"https://partner.example.com/webhooks/digital-florists"

events
enum<string>[]
required
Available options:
order.created,
order.updated,
order.assigned,
order.status_changed,
order.payment_status_changed
active
boolean
required
disabled_reason
enum<string> | null
required
Available options:
endpoint_4xx,
endpoint_unsafe,
entitlement_lost,
manual,
delivery_failures_exhausted,
null
Example:

null

secret_last_four
string | null
required
Example:

"a1b2"

last_delivered_at
string<date-time> | null
required
Example:

null

created_at
string<date-time> | null
required
Example:

"2026-06-27T10:15:00+01:00"

updated_at
string<date-time> | null
required
Example:

"2026-06-27T10:15:00+01:00"

signing_secret
string
required

Plaintext signing secret. Shown once on creation or rotation.

Example:

"f8c7e6d5c4b3a2918070605040302010f8c7e6d5c4b3a2918070605040302010"

Last modified on July 5, 2026