Webhooks

Register a webhook subscription

Required scope: webhooks:write. The secret is stored encrypted at rest and NEVER returned. Use it client-side to verify HMAC-SHA256 signatures on incoming deliveries (X-Nashboard-Signature header). See docs/webhooks-quickstart.md.

post/v1/webhooks

Request

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

Headers

X-Nashboard-Version'2026-06-13'

API version pin (ISO date). Absent → latest. Unknown or future → 400 unsupported_version. The X-Amouen-Version header name is still accepted as a deprecated alias; when both are present, X-Nashboard-Version takes precedence.

Request body

endpoint_urlstring uri required

HTTPS endpoint to receive delivery POSTs. Must not be a private/loopback host.

secretstring required

Shared secret for HMAC-SHA256 signature verification. Never returned after creation.

event_typesstring[] required

Event types to subscribe to (e.g. receipt.parsed, receipt.failed).

Response

Subscription created.

idstring uuid required
endpoint_urlstring uri required
event_typesstring[] required
activeboolean required
failure_countinteger
last_success_atstring date-time nullable
last_failure_atstring date-time nullable
created_atstring date-time

Changes

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