ThingsBoard Documentation

Documentation for using ThingsBoard IoT Platform.

Using RPC capabilities

ThingsBoard allows you to send Remote Procedure Calls (RPC) from server-side applications to devices and vice versa. Basically, this feature allows you to send commands to devices and receive results of commands execution. Similarly, you can execute a request from the device, apply some calculations or other server-side logic on the back-end and send the response back to the device. This guide covers ThingsBoard RPC capabilities. After reading this guide, you will get familiar with the following topics:

RPC call types

Thinsboard RPC feature can be divided into two types based on a originator: device-originated and server-originated RPC. In order to use more familiar names, we will name device-originated RPC calls as a client-side RPC and server-originated RPC as server-side RPC.


Server-side RPC can be divided into one-way and two-way:

Device RPC API

ThingsBoard provides a convenient API to send and receive RPC commands from applications running on the device. This API is specific for each supported network protocol. You can review API and examples on the corresponding reference page:

Server-side RPC API

ThingsBoard provides System RPC Service that allows you to send RPC calls from server-side applications to the device. In order to send an RPC request you need to execute an HTTP POST request to the following URL:



The request body should be a valid JSON object with two elements:

For example:

curl -v -X POST -d @set-gpio-request.json http://localhost:8080/api/plugins/rpc/twoway/$DEVICE_ID \
--header "Content-Type:application/json" \
--header "X-Authorization: $JWT_TOKEN"
  "method": "setGpio",
  "params": {
    "pin": "23",
    "value": 1

Please note that in order to execute this request, you will need to substitute $JWT_TOKEN with a valid JWT token. This token should belong to either

You can use the following guide to get the token.

RPC Rule Nodes

It is possible to integrate RPC actions into processing workflow. There are 2 Rule Nodes for working with RPC requests.

RPC widgets

See widgets library for more details.