How do I add, edit, or remove an endpoint device in a webhook group?

Introduction

To add an endpoint device to a webhook group

To edit an endpoint device in a webhook group

To remove an endpoint device from a webhook group

RESTful API

Introduction

When you select a webhook group on the Groups tab of the Custom Webhooks page, that group's endpoint devices get displayed in the Webhook Endpoints table below.

A webhook endpoint is a managed device bound to a webhook group to create a URL (therefore the webhook endpoint is the URL and not the device itself), and so when you add a device to a webhook group, you create an endpoint URL.

To add an endpoint device to a webhook group:

1. Create a webhook group, and then select it from the Webhook Groups table on the Groups tab of the Custom Webhooks page.

2. Click Add Device at the top of the tab (of from the Overflow Menu or right-click Context Menu). 
   Note, you can only add a device to the server where the device is managed. You can't add a device to a configuration set.
   
   
    

   The Add Device for Endpoint form is displayed.
   
   
   
    

3. At the top of the form is the URL that the device(s) uses to send the payload.
4. Click Applicable Device(s) to open an explorer from which you can use the Ctrl key to select one or more devices to register to this group.
5. Specify whether to enable Payload Collection. If disabled, this prevents the saving of any further payloads.
6. In the Payload Maximum field, specify the maximum number of payloads that Entuity stores at any one time. 
   For example, if you specify a payload maximum of three, then the three most recent payloads are stored. When a new payload is received, the oldest of the three saved would then be deleted and replaced with the new one. 
   Note, the payload maximum can't be edited if Payload Collection is disabled.
7. Click Done to save your changes. Otherwise, click Cancel.

To edit an endpoint device in 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 for which you want to edit an endpoint device.
3. From the Webhooks Groups table at the top of the tab, select the webhook group for which you want to edit a device.
4. In the Webhook Endpoints table below, select the device that you want to edit.
5. You have a number of options available:
   
   
   
    
   • Edit - click Edit above the table (or from the Overflow Menu or right-click Context Menu). 
     The Edit Device for Endpoint form is displayed, where you can change the Payload Collection and Payload Maximum fields and then click Done to save your changes.
     Note, you can only edit a device on the server where the device is managed. You can't edit a device for a configuration set.
     
     
     
      
   • Generate Authentication - click General Authentication above the table (or from the Overflow Menu or right-click Context Menu) to generate a new authentication for the device. 
     For the authentication to be used, you must then copy the authentication to the device itself. This is dependent on the type of authentication given in the webhook group (for example, secret key).
   • Copy Authentication - click Copy Authentication above the table (or from the Overflow Menu or right-click Context Menu) to copy the authentication key, if any. This is dependent on the type of authentication given in the webhook group (for example, secret key).
   • Copy URL - click Copy URL above the table (or from the Overflow Menu or right-click Context Menu) to copy to the clipboard the URL that the device uses to send the payload.

To remove an endpoint device from 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 of the page, select the server from which you want to remove an endpoint device.
3. From the Webhooks Groups table at the top of the tab, select the webhook group from which you want to remove a device.
4. In the Webhook Endpoints table below, select the device that you want to remove. 
5. Click Delete above the table (or from the Overflow Menu or right-click Context Menu).
   Note, you can only delete a device from the server where the device is managed. You can't delete a device from a configuration set.
   
   
   
    
6. At the confirmation window, click Yes to confirm the deletion. Otherwise, click No.  
    

RESTful API:

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

• List all custom webhook endpoints
• Modify a specify custom webhook endpoint
• List all custom webhook endpoints for a specified webhook group