Webhooks are setup in the Admin app on the Company Page, which is accessed via the side menu (1).
The webhooks panel (2.) shows the details of existing webhooks. This includes the column ‘Data Source’, which shows is the sensor name providing the trigger. The column ‘Condition’ shows whether the webhook has an error or not. The column ‘Status’ shows whether the webhook is ‘Stopped’ or ‘Running’.
The menu for each existing webhook (3.), provides options to open the configuration page, to start or stop the webhook and to delete it.
The top-level menu has the option to add new webhooks (4.).
The Add Webhook page
To create a new webhook, fill out the form, working from top to bottom. Start by giving your Webhook a short and unique description (5.) which will ensure you can identify what it is used for.
Then select the machine and sensor to provide the data.
You can then select what will trigger the webhook.
Sensor state changes are either normal, cautionary or emergency and based on rules defined in the sensor configuration. This will only work for sensors which have sensor status rules defined. Note that there is a frequency limit on state changes of up to two messages per minute.
If you select Sensor value changes, then you can also choose the frequency (6.) you wish the webhook to run at. Note that the webhook only sends changes, not repeats in value.
For the Endpoint you provide the URL (7.) you wish the webhook to be sent to. You can then choose either Basic Authentication method with a name and password or for No Authentication.
Lastly, if you need to add extra information to your webhook messages, this can be added in the form of tags. Up to 20 tags can be added. For example, you could add a machine ID which is recognised by another software system, or the location of a machine. To add a tag, click the top panel menu (8.). Open the side menu (9.) to Configure or Delete an existing tag.
Click ‘Create’ to create the webhook.
The Configuration page
The Configuration page for existing webhooks is very similar to the page for adding new ones. There are however a few minor differences.
The first difference is that if the Basic Authentication method has been setup, a small button on the password field allows the password to be changed (10.).
Secondly, there is an extra panel at the bottom of the page which shows Last execution and response (11.). This is particularly useful for troubleshooting.