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 server configuration sets to centrally manage the custom webhooks in your multi-server environment. With a server 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 and event definitions for each webhook group. You can then share and synchronize these webhook group and rule definitions with other remote servers that are members of the configuration set. When synchronization occurs, custom webhook groups and rules are created and/or updated on all member servers. 

Each member server 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 server 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.

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 Selection dropdown field in the top-left of the page.
5. Build the custom webhook configuration, adding endpoints for individual selected servers.

For more information on server 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:

• 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.