webhooks

Send a test webhook delivery

Send a real, signed sample delivery to this endpoint now. It is a genuine delivery rather than a simulation, so it exercises the same signature verification your receiver uses in production. The payload has the same fields as a real event of that type, filled from one of your screens where possible, plus test: true. Pick the event with event in the body; by default the test uses the first event the endpoint is subscribed to. This call returns 409 if the endpoint is not subscribed to that event.

Sends a real, signed delivery of one subscribed event now and records it in the delivery log. data carries every documented key of that event (the same shape a real event has), filled from a screen in the workspace when there is one and with sample values otherwise, plus test: true. A failed send is NOT an HTTP error: the answer is 200 with ok: false.

Notes.

  • A test payload has data.test: true. Real events never carry test.
  • Needs the permission at the workspace root: a location-scoped key is refused.
post/v1/webhooks/{id}/test

Request

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

Path parameters

idstring required

Webhook endpoint id.

Request body

event'screen.offline' | 'screen.online' | 'content.recalled' | 'content.restored' | 'approval.requested' | 'approval.decided' | 'emergency.started' | 'emergency.cleared'

The event to test. Default: the first event the endpoint is subscribed to.

Response

Success.

Changes

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