Skip to main content

ScreenStateChangedWebhook

The screen state changed webhook is called when a bartender selects a new state for the screens.

Details
TypeHTTP POST request with a JSON body to your URL
AfterUpon manual request of a new screen state.
Configuration variablesNone.
AuthenticationSignature in X-Signature header: Read more

Data Schema

{
desiredState: string
}

A string indicating the desired state will be sent. The following table denotes the possible values:

ValueText displayed to the bartender
openOpen
last-callLast Call!
closedClosed
evacuationDANGER! Evacuation mode!

Example POST Body

{
desiredState: "last-call"
}

In this example, the bartender has requested to switch to the "Last Call" state of the screens.