webhooks

Update a webhook endpoint

Change a webhook endpoint's URL, event subscriptions, description, or enabled state. Re-enabling an endpoint clears any automatic disable and resets its failure count, since re-enabling means the receiver has been confirmed fixed.

Notes.

  • Needs the permission at the workspace root: a location-scoped key is refused.
  • Validation failures are 400 bad_request, where most other routes answer 422 validation_error.
patch/v1/webhooks/{id}

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Webhook endpoint id.

Request body

urlstring

An https URL on the public internet.

eventsstring[]

Replaces the subscription. An unknown name is refused.

descriptionstring

Cut to 200 characters.

enabledboolean

true also clears an automatic switch-off and the failure count.

Response

Success.

Example response

{
  "data": {
    "id": "whe_7a8b9c0d1e2f3a4b"
  }
}

Changes

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