How do I create, edit or delete a webhook group?

To create a webhook group

To edit a webhook group

To delete a webhook group

To add, edit or remove a device in a webhook group

RESTful API

For an introduction to custom webhooks in Entuity, please see this article.

To create a webhook group:

1. Navigate to the Groups tab of the Custom Webhooks page.
2. Click Add Group at the top of the page, or via the Overflow Menu.
   
   
   
   
3. The Add Endpoint Group form will open on the right. 
   
   
   
   
4. Enter a Group Name, and specify the Server on which this group will exist from the dropdown field. When naming the group, Entuity recommends that the name reflects the devices in the group, because no checks are undertaken to validate the devices' manufacturer(s). Note, you will not be able to use the same name as a group that already exists.
5. Specify the Authentication Type from the dropdown field. This is the authentication method that managed devices can employ when sending webhooks out to receiving endpoint devices. When a webhook is received, the specified authentication endpoint will be used to validate the source of the webhook before the payload is evaluated. Choose from one of the following:
   • Basic
   • API Key Header
   • API Key Body
   • API Key Query
6. Enter the required Authentication Field. This is the name of the key. From Entuity v20.0 P03 upwards, this field by default will be populated with 'Apikey'. This field is the 'name' of the header field that will provide the api key itself. An http header field has the format 'name=value'. Note, this field is not applicable if the Basic Authentication Type is selected.
7. Click Done to save the webhook group, otherwise click Cancel.

To edit a webhoook group:

1. Navigate to the Groups tab of the Custom Webhooks page.
2. From the top table, select the webhook group that you would like to edit. Click Edit Group from the top of the page, or via the Overflow Menu or right-click Context Menu.
   
   
   
   
3. This will open the Edit Endpoint Group form on the right of the page. This contains the same fields as when adding the webhook group.
   
   
   
   
4. Make your desired edits and then click Done in the top right to save your changes ,otherwise click Cancel.

To delete a webhook group:

A webhook group can only be deleted if it does not contain any endpoint devices.

1. Navigate to the Groups tab of the Custom Webhooks page.
2. From the top table, select the webhook group that you would like to delete. Click Delete Group at the top of the page, or via the Overflow Menu or right-click Context Menu.
   
   
   
   
3. A dialog window will open, asking you to confirm your choice.
   
   
   
   

To add, edit or remove a device in a webhook group:

Please see this article for help and information on adding a device, editing or removing a device in a webhook group.

RESTful API:

Please see the following for help and information on managing custom webhook groups via Entuity RESTful API:

• List and create custom webhook groups
• Inspect or delete a custom webhook group