BRbraiv
Webhooks

Create a webhook endpoint

Registers an HTTPS destination. Store the signing secret immediately; it is returned only once. Required scope: webhooks:write.

post/webhook-endpoints

Request

  • Base URL
    https://api.braiv.co/v1
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Headers

Idempotency-Keystring

Caller-generated key for safe POST retries. The API retains the first JSON response for 24 hours. Reusing a key with another path or body returns 409 IDEMPOTENCY_REPLAY.

Request body

urlstring uri required

Public HTTPS delivery destination.

Response

Endpoint created and one-time signing secret returned.

idstring required

Created webhook endpoint ID.

urlstring uri required

Registered HTTPS delivery destination.

secretstring required

Signing secret returned once at creation.

eventsWebhookEventName[] required

Event names delivered to this endpoint.

Changes

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