Skip to main content
POST
/
api
/
partner
/
webhooks
Create a subscription (dashboard session)
curl --request POST \
  --url https://signsealship.com/api/partner/webhooks \
  --header 'Content-Type: application/json' \
  --cookie __Host-session= \
  --data '
{
  "url": "https://example.com/hooks/signsealship",
  "topics": [
    "room.order_attached",
    "room.passport_sealed"
  ]
}
'
const options = {
method: 'POST',
headers: {cookie: '__Host-session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://example.com/hooks/signsealship',
topics: ['room.order_attached', 'room.passport_sealed']
})
};

fetch('https://signsealship.com/api/partner/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://signsealship.com/api/partner/webhooks"

payload = {
"url": "https://example.com/hooks/signsealship",
"topics": ["room.order_attached", "room.passport_sealed"]
}
headers = {
"cookie": "__Host-session=",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secret": "<string>",
  "url": "<string>",
  "topics": [
    "<string>"
  ],
  "signatureHeader": "SignSealShip-Signature"
}
{
"error": "<string>"
}

Authorizations

__Host-session
string
cookie
required

SignSealShip dashboard login session cookie. Used only by the /api/partner/webhooks routes.

Body

application/json
url
string<uri>
required

An absolute https:// URL.

topics
enum<string>[]
required
Minimum array length: 1
Available options:
passport.sealed,
room.order_attached,
room.passport_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"