Skip to main content
POST
Create a subscription

Authorizations

Authorization
string
header
required

Partner API key. Send as Authorization: Bearer sss_pk_....

Body

application/json
url
string<uri>
required

An absolute https:// URL.

topics
enum<string>[]
required

The order topics deliver only for orders created through the Order API.

Minimum array length: 1
Available options:
passport.sealed,
room.order_attached,
room.passport_sealed,
order.created,
payment.cleared,
signature.completed,
shipment.delivered,
trust.assessment_requested,
trust.assessment_completed,
trust.assessment_superseded,
recording.review_required,
recording.quote_ready,
recording.approved,
recording.fulfillment_queued,
recording.mailed,
recording.delivered_to_recorder,
recording.accepted,
recording.recorded,
recording.rejected,
recording.receipt_sealed

Response

Subscription created.

id
string<uuid>
secret
string

Signing secret prefixed sss_whsec_. Shown exactly once.

url
string
topics
string[]
signatureHeader
string
Example:

"SignSealShip-Signature"