logo

Push API

The Push API provides real-time forwarding, allowing users to receive data from Sensorbee in real-time as it is posted in the server. This type of integration is useful for applications that require up-to-the-moment data, such as those used for monitoring or tracking environmental parameters. By using the Push API, users can receive data as it is posted in the server, without needing to rely on periodic polling or other less efficient methods.

Needed Parameters:

  • Push API Name (Required)
    • The name you want to call your push API (example: “Station 1 Push API”).
  • Endpoint URL (Required)
    • An HTTP POST endpoint, where the push API payload will be sent.
  • Description (optional)
    • Any description that you can think of.
Figure 1 - Create Push API Step 1
Figure 1 - Create Push API Step 1
  • Header Params (Optional)
    • In case your endpoint requires some header parameters like “apiKey” or “Bearer” token, you can add them in the Headers grid on a key-value pair order.
Figure 2 - Create Push API Step 2
Figure 2 - Create Push API Step 2
After the Push API is created, you can now assign it to a base unit. Please see Device Management Info for details on how to assign an integration to a base unit.

JSON Payload

When the push API is successfully assigned to a base unit / device, a JSON payload will then be forwarded to your endpoint every polling interval. The content of the JSON payload uses the Smart City Template, which contains all significant parameters needed for monitoring the air quality and the environment.

Powered by Notaku