Webhooks

Update a webhook subscription

Required scope: webhooks:write. Partial update — at least one field required. Re-enabling (active: true) resets the failure streak. A new secret is re-encrypted; omit to keep existing.

patch/v1/webhooks/{id}

Request

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

Path parameters

idstring uuid required

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
secretstring
event_typesstring[]
activeboolean

Response

Updated subscription (secret omitted).

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.