Skip to main content
POST
Register a webhook (returns the signing secret once)
Registers a URL for signed event deliveries. Requires the webhooks:write scope. Returns 201 with the webhook record, the event catalog, and your signing_secret, shown exactly once.

Request example

url is required and must be HTTPS in production. event is one catalog event or * for all; an unknown event name is a 400 listing the valid catalog.

Response example

Store the secret now; every later view is masked. Verification code is in the Webhooks guide.

Errors

  • 400 bad_request, unknown event name (the message lists the catalog).
  • 422 unprocessable, missing or non-HTTPS url.
Terms used here: order, API key, scope, webhook, dead-letter. Full list in the terminology annexure.

Next steps

Authorizations

X-ScripX-Key
string
header
required

Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.

Body

application/json
url
string<uri>
required
event
string

Response

OK

registered
boolean
webhook
object
signing_secret
string

shown ONCE at registration

events
string[]