screens

Trigger a screen interaction

Send a real-time trigger to a screen: refresh, next, go-to-scene, or send-event. The screen receives it immediately.

post/v1/screens/{id}/trigger

Request

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

Path parameters

idstring required

Screen id.

Request body

kind'refresh' | 'next' | 'prev' | 'go-to-page' | 'go-to-scene' | 'send-event' required
pageinteger

go-to-page: 1–100.

sceneIdstring

go-to-scene: the scene to show.

eventstring

send-event: the event name the content listens for.

payloadstring

send-event: an optional string payload.

Response

Success.

Changes

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