Register a webhook (returns the signing secret once)
Webhooks
Register a webhook
Register a ScripX webhook endpoint and receive the HMAC signing secret exactly once, subscribing to one event or the full catalog.
POST
Register a webhook (returns the signing secret once)
Registers a URL for signed event deliveries. Requires the
Store the secret now; every later view is masked. Verification code is in the Webhooks guide.
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
Errors
400 bad_request, unknown event name (the message lists the catalog).422 unprocessable, missing or non-HTTPSurl.
Next steps
- Webhook events, what each event means.
- Failures and replay.