webhooks

Create a webhook endpoint

Create an endpoint. The response includes the signing secret once; after that, only a preview of it is available, since it is stored encrypted and cannot be retrieved in full. The endpoint URL is checked at creation and again before every delivery, since a hostname that resolved to a public address at save time could later be re-pointed at an internal address. Only content.recalled and content.restored events are actually sent today, even though the event catalog lists more.

The response carries the signing secret ONCE. Store it: later reads return only secretPreview.

Notes.

  • Validation failures are 400 bad_request, where most other routes answer 422 validation_error.
post/v1/webhooks

Request

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

Request body

urlstring required

An https URL on the public internet (private and loopback hosts are refused).

eventsstring[]

Events to deliver. Default: none. An unknown name is refused.

descriptionstring

Label; cut to 200 characters.

Response

Success.

Example response

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

Changes

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