Live Data - Webhook

Use webhooks to be notified about ingestion.

Webhooks enable you to connect your BlueForest app to other applications and services for remote monitoring. Webhooks automatically notify other applications and services you connect whenever a data is ingested in your BlueForest app. In others words, Webhooks are user-defined HTTPs callbacks.

How to set up the webhook

Webhooks are configured in the Dashboard’s Webhooks settings section.

Receiving webhooks with an HTTPS server

BlueForest will send a POST request to the other application’s HTTPs endpoint whenever a data is ingested. An HTTPs URL must be used. BlueForest will validate that the connection to your server is secure before sending your webhook data. For this to work, your server must be correctly configured to support HTTPS with a valid server certificate.

Payload

The payload (HTTP Request Body) will contain the data ingested. When a data is received, an HTTP POST request is made to the callback URL containing a payload with the data.

Headers

Todo

Responding to a webhook

To acknowledge receipt of a webhook, your endpoint should return an empty 200 or 204 HTTP status code. All response codes outside those two values, including 3xx codes, will indicate to BlueForest that you did not receive the webhook. BlueForest will ignore any other information returned in the request headers or request body.

BlueForest will attempt to deliver your webhooks for up to ten times with an exponential back off. Webhooks cannot be manually retried after this time, though you can query for the event to reconcile your data with any missed events if data storage is activated on your BlueForest account.

Best practices

We recommend verifying webhook Authorize Header (Basic auth) HTTPs Use MQTT in prod