webhooks

Register a webhook subscription (Edge+)

Creates an HTTPS webhook on an Edge-or-higher API key with webhook:write scope. The HMAC secret is returned exactly once. Delivery is at least once and uses X-BBS-Signature: t=<unix>,v1=<hex>, where the HMAC-SHA256 input is "t.raw_body". Non-2xx responses are retried after 30s, 2m, 10m, and 1h (five attempts total).

post/v1/webhooks

Request

  • Base URL: https://api.bigballsdata.com
  • URL: https://api.bigballsdata.com/v1/webhooks
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

idstring
urlstring uri required
eventsstring[] required
secretstring

HMAC-SHA256 secret. Shown once at creation.

createdAtstring date-time
enabledboolean
consecutiveFailuresinteger
parkedAtstring date-time nullable
parkedReasonstring nullable

Response

created; secret is present only in this response

Changes

No recorded changes to this operation across all 2 revisions of this API.