Register a webhook endpoint

Register a webhook delivery target -- secret is stored as the endpoint's HMAC signing key, scoped to the caller's own customer, and never logged.

Idempotent on (customer, url): re-registering the same target returns the SAME id rather than a second row, so a retrying caller ends up with one endpoint it can hand straight to POST /v1/watches. Omitted secret is generated server-side and returned once, in secret.

Requires the webhooks scope.

post/v1/webhooks

Request

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

Request body

urlstring required
secretstring nullable

Response

Successful Response

idinteger required
urlstring required
createdboolean required
secretstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.