Skip to content

Webhooks

Webhooks allow you to call back your application when a batch of events have been processed (every 5 minutes).

Configuration

To configure a webhook you must specify:

  • Url - the absolute path to your webhook endpoint
  • Headers - a set of key value pairs which will be sent as http request headers
  • Update interval - the minimum amount of time between webhook requests

Request

The webhook will [POST] JSON content to the endpoint you provide. The JSON request body will have the following format:

{
  "type": "timeseries_updated",
  "timestamp": 1708639562,
  "updates": [
    {
      "set_id": "DW2S423SDFSD",
      "tag": "my-tag",
      "start_timestamp": 1708638000,
      "end_timestamp": 1708634000
    }
  ]
}

Each update contains all the set and tag id's that data has been inserted into, along with the easliest and latest timestamp of the data points inserted in each tag within the current batch.

If your endpoint does not return a success status code (200-299) five times in a row it will be disabled automatically and you will have to manually re-enable it.