Manage ThingsBoard IoT devices, assets, customers and dashboards, read alarms and relations, and read and write attributes and time series telemetry.
Explore 61 workflow actions for ThingsBoard, including account permissions and operation limits.
46 read actions15 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Create a customer
Write
Creates a customer.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a dashboard
Write
Creates a dashboard with a title and optional configuration (layouts, widgets, aliases).
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a device
Write
Creates a device with a device profile; ThingsBoard generates its access token, which is not returned here.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create an asset
Write
Creates an asset.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a customer
Write
Deletes a customer and its users; its dashboards, assets and devices are unassigned, not deleted.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a dashboard
Write
Deletes a dashboard.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a device
Write
Deletes a device, its credentials and its relations.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete an asset
Write
Deletes an asset and its relations.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete device attributes
Write
Deletes a device's attributes with these keys in one scope.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete entity attributes
Write
Deletes an entity's attributes with these keys in one scope.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete time series
Write
Deletes an entity's time series for these keys, all of it or within a time range.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a customer
Read
Reads one customer.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get a customer by title
Read
Reads the tenant's customer with this title.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get a dashboard
Read
Reads one dashboard with its configuration.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get a device
Read
Reads one device.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get a device by name
Read
Reads the tenant's device with this name (Community Edition path).
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Community Edition path; on Professional Edition use get-device-by-name-pe.
Get a device by name (Professional Edition)
Read
Reads the tenant's device with this name.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
Get a relation
Read
Reads the relation of one type between two entities.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get alarm info
Read
Reads one alarm with its originator name and assignee.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get an alarm
Read
Reads one alarm.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get an asset
Read
Reads one asset.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get an asset by name
Read
Reads the tenant's asset with this name (Community Edition path).
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Community Edition path; on Professional Edition use get-asset-by-name-pe.
Get an asset by name (Professional Edition)
Read
Reads the tenant's asset with this name.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
Get an entity group
Read
Reads one entity group.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
Get an entity group by owner, type and name
Read
Reads the entity group with this name, type and owner.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
Get attributes
Read
Reads an entity's attributes (key, value, last update time), optionally only some keys.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get attributes by scope
Read
Reads an entity's attributes in one scope, optionally only some keys.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get highest alarm severity
Read
Answers the highest severity (CRITICAL, MAJOR, MINOR, WARNING or INDETERMINATE) among an entity's alarms.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get latest time series
Read
Reads the latest value of an entity's time series keys (all keys when left out).
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Get time series range
Read
Reads an entity's time series values in a time range, raw or aggregated.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List a customer's assets
Read
Lists a page of assets assigned to a customer.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List a customer's dashboards
Read
Lists a page of dashboards assigned to a customer.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List a customer's devices
Read
Lists a page of devices assigned to a customer.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List alarm types
Read
Lists the distinct alarm types.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List alarms
Read
Lists a page of alarms of the current user's tenant or customer.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List alarms of an entity
Read
Lists a page of alarms raised by one entity (the originator).
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List an entity group's assets
Read
Lists a page of assets in an entity group.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List an entity group's customers
Read
Lists a page of customers in an entity group.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List an entity group's devices
Read
Lists a page of devices in an entity group.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List an entity's groups
Read
Lists the IDs of the groups that contain an entity (always including the group All).
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List assets
Read
Lists a page of the tenant's assets.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List attribute keys
Read
Lists an entity's attribute key names across all scopes.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List attribute keys by scope
Read
Lists an entity's attribute key names in one scope.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List customers
Read
Lists a page of the tenant's customers.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List dashboards
Read
Lists a page of the tenant's dashboards.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List devices
Read
Lists a page of the tenant's devices.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List entity groups by owner and type
Read
Lists a page of a tenant's or customer's entity groups of one type.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List entity groups by type
Read
Lists a page of entity groups of one type.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List my assets
Read
Lists a page of assets available to the current user.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List my customers
Read
Lists a page of customers available to the current user.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List my dashboards
Read
Lists a page of dashboards available to the current user.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List my devices
Read
Lists a page of devices available to the current user.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Operation limits
Professional Edition (and ThingsBoard Cloud) only.
List relation infos from an entity
Read
Lists relations from this entity with the names of both sides.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List relation infos to an entity
Read
Lists relations to this entity with the names of both sides.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List relations from an entity
Read
Lists relations whose from side is this entity, optionally of one relation type.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List relations to an entity
Read
Lists relations whose to side is this entity, optionally of one relation type.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
List time series keys
Read
Lists an entity's time series key names.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
Save device attributes
Write
Creates or updates a device's server or shared attributes from a key-value object.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Save entity attributes
Write
Creates or updates an entity's server (any entity) or shared (devices) attributes from a key-value object.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Save time series
Write
Creates or updates an entity's time series values.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
Save time series with TTL
Write
Creates or updates an entity's time series values that expire after a time to live.
Permissions and limits
Account permissions
A ThingsBoard API key (Account, Security, API keys) for a tenant administrator or customer user with access to the entities
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in ThingsBoard. A saved workflow is not a completed provider action.
Developer ยท CONNECTION
