How do I manually export or import a custom webhook configuration?

Applicable to Entuity v23.0 P03 upwards. 

Introduction

What's included in a custom webhook configuration export/import

To export a custom webhooks configuration

To import a custom webhooks configuration

Introduction

The recommended way to share custom webhook configurations across servers in your network is to use configuration sets that are enabled for custom webhooks. However, if you have servers in separated environments, or if you have more than one consolidation server in your environment, you might want to manually export and then import a custom webhook configuration. In this situation, the custom webhook configuration is exported as a single JSON-formatted text file.

You might want to manually export and import a custom webhook configuration when:

• preparing for failover 

• migrating to a standalone recovery server

• extracting a configuration set draft for offline review or transfer

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

What's included in a custom webhook configuration export/import:

The export/import process can provide the portable transfer of the following:

• webhook groups

• webhook authentication types

• webhook rules

• rule conditions

• event definitions

• optional stored payload samples, keyed by webhook group name (groupName)

To manually export a custom webhook configuration:

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 Selection dropdown field at the top-left of the page, select the server or configuration set for which you want to export a custom webhook configuration.
3. Click Export Configuration at the top of the tab (or from the Overflow Menu or right-click Context Menu).
   
   
    
   The Export Custom Webhook Configuration form is displayed.
   
   
    
4. Do one of the following:
   • If you are exporting from a configuration set, click Done to start the export. 
   • If you are exporting from a server, choose whether to Include Sample Payloads in the export, and then click Done. 
     
      

To import a custom webhook configuration:

You can't import a custom webhook configuration to a configuration set.

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 Selection dropdown field at the top-left of the page, select the server to which you want to import the custom webhook configuration.
3. Click Import Configuration at the top of the tab (or from the Overflow Menu or right-click Context Menu).
   
   
    
   The Import Custom Webhook Configuration form is displayed.
   
   
4. From the Import Policy dropdown field, select whether the import adds to (Merge (additive)) or replaces (Replace (full sync)) the existing custom webhook configuration on the server.
5. Choose whether to Import Sample Payloads on the server.
6. Specify if you want the import to be a Dry Run. 
   With a dry run:

   • no database writes are made.

   • no group/rule/payload records are changed.

   • counters reflect what would have happened.

   • conflicts and errors are still reported. 

7. In the File Input section, click Browse Files and then navigate to, select, and open the custom webhook configuration import file(s).
8. Click Done to import the file(s) and return to the Custom Webhooks page. Otherwise, click Cancel. 
   The newly imported custom webhook groups, rules, and sample payloads (if selected for import) are now displayed on the Groups tab of the Custom Webhooks page.