Create a webhook endpoint
The endpoint signing secret is returned only once, in the `secret` field of the creation response. See webhooks.md.
The endpoint signing secret is returned only once, in the secret field of the creation response. See webhooks.md.
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Header Parameters
A unique key that makes this mutation safe to retry. Repeats replay the stored response; reuse with a different body returns 409 idempotency_conflict.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "https://example.com/storebay/webhooks", "enabled_events": [ "agreement.signed", "invoice.paid", "payment.succeeded" ] }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "webhook_endpoint", "url": "https://example.com/storebay/webhooks", "enabled_events": [ "agreement.signed", "invoice.paid", "payment.succeeded" ], "api_version": "2026-07-03", "status": "active", "description": "string", "failure_count": 0, "last_success_at": "2019-08-24T14:15:22Z", "last_failure_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "secret": "whsec_1f2e3d4c5b6a" }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "validation_error", "message": "One or more fields are invalid.", "details": [ { "field": "email", "issue": "must be a valid email address" } ] }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}