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 under the Groups tab on the Custom Webhooks page, that group's endpoint devices will display in the Webhook Endpoint 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 will 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 Custom Webhooks page.
   
   
   
   
2. The Add Device for Endpoint form will open on the right of the screen.
   
   
   
   
3. At the top of the form is the URL that the device will use to send the payload.
4. Click Applicable Device to open an explorer from which you can select a device to register to this group.
5. Specify whether to enable Payload Collection. If disabled, this will prevent the saving of any further payloads.
6. In the Payload Maximum field, specify the maximum number of payloads that Entuity will store at any one time. For example, if you specify a payload maximum of 3, then the 3 most recent payloads will be stored. When a new payload is received, the oldest of the 3 saved would then be deleted and replaced with the new one. Note, the payload maximum cannot be edited if payload collection is disabled.
7. Click Done at the top right of the form when you have made your desired changes, otherwise click Cancel.

To edit an endpoint device in a webhook group:

1. Navigate to the Groups tab of the Custom Webhooks page, and select the webhook group from which you want to edit a device.
2. In the Webhook Endpoints table below, select the device that you want to edit.
3. You have a number of options available:
   
   
   
   
   • Edit - click Edit above the table, or via the Overflow Menu or right-click Context Menu. This will open the Edit Device for Endpoint form, from where you can change the Payload Collection and Payload Maximum fields.
     
     
     
     
   • Generate Authentication - click this to generate a new authentication for the device. This needs to be copied to the device itself for it to be used. This is dependant on the type of authentication given in the webhook group (e.g. secret key).
   • Copy Authentication - click this to copy the authentication key, if any. This is dependant on the type of authentication given in the webhook group (e.g. secret key).
   • Copy URL - click this 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, and select the webhook group from which you want to remove a device.
2. In the Webhook Endpoints table below, select the device that you want to remove. Click Delete above the table, or via the Overflow Menu or right-click Context Menu.
   
   
   
   
3. A deletion confirmation will appear. Click Yes.
   
   

RESTful API:

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

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