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

To manually export or import a custom webhook configuration

RESTful API

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

To create a webhook group:

1. Navigate to the Groups tab of the Custom Webhooks page.
2. If you don't have a multi-server environment, skip to the next step. Otherwise, from the Server/Configuration Set dropdown field at the top-left of the page, select the server or configuration set for which you want to create a webhook group.
3. Click Add Group at the top of the page, or from the Overflow Menu.
   Note, you can't add a webhook group to a server that's in a configuration set. Instead, you must select the configuration set itself to add a group.
   
   
   
    The Add Endpoint Group form is displayed. 
   
   
    
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 reflect 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 Name. 
   This is the name of the key. This field by default is 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 webhook group:

1. Navigate to the Groups tab of the Custom Webhooks page.
2. If you don't have a multi-server environment, skip to the next step. Otherwise, from the Server/Configuration Set dropdown field at the top-left of the page, select the server or configuration set for which you want to edit a webhook group.
3. From the top table, select the webhook group that you want to edit. 

4. Click Edit Group from the top of the page (or from the Overflow Menu or right-click Context Menu).
   Note, you can't edit a webhook group for a server that's in a configuration set. Instead, you must select the configuration set itself to edit a group.
   
   
    

   The Edit Endpoint Group form is displayed. This form contains the same fields as when adding the webhook group (see the section earlier in this article).
   
   
    

5. Make your edits and click Done 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. If you don't have a multi-server environment, skip to the next step. Otherwise, from the Server/Configuration Set dropdown field at the top-left of the page, select the server or configuration set from which you want to delete a webhook group.
3. From the top table, select the webhook group that you want to delete. 
4. Click Delete Group at the top of the tab (or from the Overflow Menu or right-click Context Menu).
   Note, you can't delete a group from a server that's in a configuration set. Instead, you must select the configuration set itself to delete a group.
   
   
    
5. At the confirmation window, click Yes to confirm your deletion. Otherwise, click No.
   
    

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

See this article for more information on adding a device, editing, or removing a device in a webhook group.

To manually export or import a custom webhook configuration

From Entuity v23.0 P03 upwards, as an alternative to using configuration sets, and if your environment requires it, you can manually export and import the custom webhook configuration of a server or configuration set. A custom webhook configuration comprises webhook group definitions and the associated webhook rule and event definitions for each webhook group. See this article for more information on manually exporting and importing a custom webhook configuration.

For information on how to share custom webhook configurations across servers in a configuration set, which is the recommended method for centrally managing custom webhooks, see this article.

RESTful API:

See the following articles for more information on managing custom webhook groups using Entuity RESTful API:

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