Skip to main content
POST
RegisterWebhook

Authorizations

X-API-Key
string
header
required

Your API key, prefixed sc_live_ or sc_test_.

Body

application/json
url
string

url is the HTTPS endpoint to deliver events to.

events
string[]

events are the event types to subscribe to (at least one), e.g. "order.fulfilled", "order.failed", "order.refunded", "wallet.low_balance", "wallet.credited".

Response

200 - application/json

Success

webhook
webhook · object

webhook is the registered endpoint.

secret
string

secret is the signing secret, shown only once. Store it; verify each delivery with it. It is never returned again.