Introduction to centrally managing custom webhooks

Introduction

General workflow to centrally manage custom webhooks

Permission requirements

Introduction

From Entuity v23.0 P03 upwards, you can use configuration sets to centrally manage the custom webhooks in your multi-server environment. With a configuration set that is enabled for custom webhooks, the central/controlling server is where HTTP webhooks are received from external devices. From that central server, you can create a custom webhook configuration that includes webhook group definitions and the associated webhook rule, condition, and event definitions for each webhook group. You can then share and synchronize these webhook group and rule definitions with other servers in the configuration set. When synchronization occurs, custom webhook groups and rules are created and/or updated on all servers in the configuration set. 

Each server in a configuration set keeps a local copy of the custom webhook configuration. As a result, custom webhook group, rule, and event definitions from the custom webhook configuration are not editable from member servers in the configuration set. You can manage custom webhook configuration definitions only from the central server. 

Custom webhook events are raised on member servers (or on the server that owns the monitored object (serverId + objectId in the webhook URL)), based on the payload contained in the webhook. The actual webhook is received only by the central server that provides public interface with the internet.

Note, for events to be raised on any server in a configuration set, Entuity recommends that the only custom webhook configuration on the server must be the custom webhook configuration of the configuration set to which the server belongs. If other custom webhook configurations exist, then synchronization of the configuration set takes priority in the database.

General workflow to centrally manage custom webhooks:

1. Create the configuration set and select its Sync Custom Webhooks checkbox to enable the configuration set for custom webhooks.
2. Assign servers to the configuration set.
3. Navigate to the Custom Webhooks page. 
4. Select the configuration set from the Server/Configuration Set dropdown field at the top-left of the page.
5. Build the custom webhook configuration, adding endpoints to the individual selected servers.
6. Optionally perform a manual sync of the configuration set. Otherwise, wait for the regular configuration set sync to occur. See this article for information on manually syncing a configuration set.

For more information on configuration sets, see this article. 

For more information on custom webhooks, see this article. 

Permission requirements

To centrally manage custom webhooks in a multi-server environment, you need the following permissions:

• the Multi-Server Administration tool permission. However, management of server configuration sets is an admin-only permission, and there is no separate tool permission for it.
• the Webhook Administration tool permission. This is required to access the Custom Webhook page and to create, edit, and remove webhooks.

See this article for more information on user permissions in Entuity.