Configuring Webhooks
Webhooks lets you route your data directly from the FreeWave Ingest directly to your own endpoint.
The Webhook functionality can be found in the pop-up menu when clicking your username. They can also be configured through the Devices section of the portal.
Webhooks can be created for one device, multiple devices, or all devices.
Creating Webhooks
From User Menu
When using the pop-up menu through your username and selecting Webhooks, a list of webhooks already configured appear on the page. If none are configured, you just see the Create Webhook button.
Webhooks are not associated with specific devices or access groups by default and will need to be associated after creation.
Name: This is the friendly name you'd like to give to the webhook
URL: This can be either; a DNS domain name based URL or an IP address based URL
Global: Checking this box will apply this webhook to every device in your organization
While you can create a webhook with multiple endpoints separated by a comma, it is recommended that you create a webhook for each endpoint you want to use.
From Devices Menu
After clicking Edit on your gateway in the Devices list, the webhook section is located at the bottom of the page.
Here you can create a webhook for a specific device or you can create a global webhook for all devices.
You are unable to configure Access Group-specific webhooks here as Access Groups involve both users and groups.
Managing Webhooks
Once the Webhooks have been created, they need to be associated with a device or an access group.
NB: If you want to apply the webhook to all devices, you should edit the webhook and select the Global checkbox. If you do have a Global webhook, the rest of this page does not apply.
To assign a webhook to a specific device, click within the Devices box and select the appropriate device from the list.
In the Access Groups box, you can specify an Access Group. Webhooks are designed around devices and not access groups, so this can be left blank if you do not have Access Groups set up.
Examining Messages sent to the Webhook
More information regarding examining messages sent to your webhook via the Portal can be seen here: Examining messages on the FreeWave Data Portal
Comments
0 comments
Please sign in to leave a comment.