API Reference
API Reference

Create a new webhook subscription

post
https://api.portal.scanifly.com/api/v1/webhooks
Body Params

Data for creating the webhook subscription

string
required

Callback URL

subscribedEvents
array of strings
required

List of events this webhook is subscribed to

subscribedEvents*
string
deprecated

Deprecated. Optional legacy token echoed back in the x-api-key header of every delivery, for receivers built before signing existed. It travels in plaintext, so it proves nothing about authenticity: it may accompany signingSecret but cannot replace it.

string
required
length ≥ 32

Key used to sign every delivery, sent as the x-scanifly-signature header. Scanifly never transmits this value, so a receiver that verifies the signature can trust the request really came from us. Store it somewhere safe: it cannot be read back.

Responses

400

Bad Request - Invalid input data.

Updated about 1 month ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?