Device Actions
Actions allow real-time communication through HTTP requests. These device actions are easy to use and particularly useful when implementing Action batches in your content.
- They are typically triggered by an event, such as a command sent to a device.
- When the event occurs, the device makes an HTTP request to the URL configured for the action.
- To distinguish API calls, create individual API keys for each action.
Add Action - Devices
Name
Define the name of your device action.
Event ID
An "event ID" is a unique identifier assigned to each action call. It helps track and manage different events sent by the actions to your system. This ID ensures individual handling of each event.
Note: This event ID must be unique.
Action Type
- Assign Content – Learn more: Assign Content to Devices
- Disable Emergency / Enable Emergency – Learn more: Assign Emergency Content
- Load URL – The selected device will load the entered URL(s).
- Resume Loop / Pause Loop – Start/Pause the selected loop(s).
- Preview Content – Learn more: Content Preview
- Refresh Content – Refreshes the selected content(s).
- Restart Device – Restarts the selected device(s).
- Send Sensor Event Data – Triggers sensor events inside content. Learn more: Sensor Events
- Show Toast Message – Displays a toast message with the given content.
- Snooze Device / Wake Up Device – Remotely control the device status between awake and snooze modes.
Target Type
Choose from All, Device, Device Group, or Device Tag as the target type.
Target
Select the target channel for the action.
Note: Multiple targets will be supported in future updates.
Teams
Assign teams to manage and view the data source.
Note: This option is available only if at least one team is configured for the customer.
How to Trigger an Action?
Create an API Key
Learn more: API Key
Generate Example Link
Click on the Generate Example Link
button to open a modal.
Fields for Link Generation:
API Key (Always Required)
An API key is necessary for webhook authentication and security.
Message
Define the content of the toast message.
Sensor Output
Specify the sensor event you want to send via action.
Action Type Comparison
Action Type | API Key | Message | Sensor Output |
---|---|---|---|
Assign Content | ✔️ | ❌ | ❌ |
Disable Emergency | ✔️ | ❌ | ❌ |
Enable Emergency | ✔️ | ❌ | ❌ |
Load URL | ✔️ | ❌ | ❌ |
Pause Loop | ✔️ | ❌ | ❌ |
Preview Content | ✔️ | ❌ | ❌ |
Refresh Content | ✔️ | ❌ | ❌ |
Restart Device | ✔️ | ❌ | ❌ |
Resume Loop | ✔️ | ❌ | ❌ |
Send Sensor Event Data | ✔️ | ❌ | ✔️ |
Show Toast Message | ✔️ | ✔️ | ❌ |
Snooze Device | ✔️ | ❌ | ❌ |
Wake Up Device | ✔️ | ❌ | ❌ |
Set Volume | ✔️ | ✔️ | ❌ |
Final Steps
Copy Link
Generate a webhook call link for use within content as touch actions.
Test Action
Test the action on the selected target before deployment.