Skip to main content

Folder Actions

Actions allow real-time communication through HTTP requests. These device actions are easy to use and are 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 - Folder​

Name​

Define the name of your folder 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 Types​

Force Sync​

Forces the selected shared folders to sync.

Upload File​

Uploads a file into a folder.

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

Click on the Generate Example Link button to open a modal.

API Key (Always Required)​

An API key is necessary for webhook authentication and security.

File Content​

Insert the Base64 text of the file.

Action Type Comparison​

FieldUpload FileForce Sync
API Key✔️✔️
File Name✔️❌
File Content✔️❌
Overwrite Existing✔️❌
Valid From✔️❌
Valid To✔️❌

Final Steps​

Generate a webhook call link for use within content as touch actions.

Test Action​

Test the action on the selected target before deployment.

Last updated on