You are here:
< Back

WebHooks can be used to trigger functions on devices, device groups or all devices, such as:

  • Load URL
  • Enable/Disable Emergency
  • Refresh Datasource
  • Pause Loop
  • Resume Loop
  • Send Sensor Event Data
  • Refresh Content

First, you need to create an API key.

This can be done in the settings menu under webhooks on the Webhook API keys tab.

Next, you need to create an action

You can trigger this action by making a GET or POST request to this endpoint:

{{server_root}}/public-api/integration/webhooks?eventId={event_id}&apiKey={api_key}

  • server_root = your server (like: https://editor.wallboard.info)
  • event_id = the event ID associated with your webhook action
  • api_key = the API key created in the first step

If you are using the send sensor event data function you need to include the ‘sensor_data’ attribute and the data in the request body.
This will only work with POST requests.

body: {
 sensor_data : "{id: '{{sensorId}}', value: '{{value}}' }"
}

You can trigger it from a code, postman or simply opening this endpoint URL in a browser.

Here is a nodeJs sample request to trigger the webhook:

const options = {
  method: 'POST',
  url: `{{server}}/public-api/integration/webhooks`,
  headers: {
    'Content-Type': 'application/json',
    'x-webhook-apikey': {{apiKey}}
  },
  body: { event_id: {{event_id}} },
  json: true 
};
request(options, function (error, response, body) { 
  if (error) throw new Error(error);
  if (body.message === 'Error') throw new Error();
  console.log(body); //message: success
});   

Comments are closed.