Webhooks
Register a webhook
Subscribe an https endpoint to one event. An account may hold only one webhook per event, and the endpoint must resolve to a public address.
Authorization
ApiKey AuthorizationBearer <token>
API key issued to the partner, sent with the Bearer prefix — for example: Authorization: Bearer su_key_9f2c4d1ab3….
Keys minted on the live instance are prefixed su_key_ and keys minted on sandbox su_test_key_. The two instances keep separate key tables and separate hosts, so a sandbox key sent to the live host — or the reverse — answers Invalid API key. rather than falling back to the other environment.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhooks/" \ -H "Content-Type: application/json" \ -d '{ "event": "checkout.succeeded", "endpoint_url": "http://example.com" }'{ "id": "whk_a1b2c3d4e", "event": "checkout.succeeded", "endpoint_url": "https://partner.example.com/hooks/suqo", "is_active": true, "created_at": "2026-07-03T10:15:00Z"}