Managing webhooks

Webhooks are automated messages that are sent from one online system to another. They are sent when specific events occur.

Using webhooks, you can synchronise information and actions between ComplyAdvantage Mesh and your internal applications, without requiring manual updates or checks.

Here's an example: When a case is closed in Mesh, Mesh could send a webhook to your internal customer relationship management (CRM) system. Your CRM system would receive this webhook and could then trigger its own automated process. This could update your internal customer record to say that the case has been resolved. 

Mesh can send webhooks when the following events take place:

1. A case is created.
2. The state of a case is updated: For example, a state might change from Not started to In progress.
3. A customer onboarding workflow is completed.

In this article, you'll see how to manage webhooks using the Mesh web application.

It is also possible to manage webhooks using an application programming interface (API). 

Creating a webhook using the Mesh web application

1. Select the Settings button in the top right of the screen.
   
2. Select Webhooks in the menu on the left. 
3. You see the webhooks that have been created.
   
4. Select the New button in the top right.
5. Enter the webhook name. The webhook name is just for your own reference. Choose the event that you want to trigger, and the URL where your application will receive the message. 
   
   
6. When you complete all the form fields, the Send test button is enabled. Click the button to send an example payload to the URL you have specified. This test is optional.
7. Click the Create button.
8. You see a success notification.
   
9. Your new webhook has an Active status in the webhooks list.
   

Changing a webhook’s status using the Mesh web application

1. Select the Settings button in the top right of the screen.
2. Select Webhooks in the menu on the left. 
3. You see the webhooks that have been created.
   
4. Click the webhook you want to change the state of.
5. Change the State to either Active or Inactive.
   
6. Click Save in the top right.
7. You see a success notification.
   
8. Use the arrow next to the webhook name to return to the webhooks list.
   
9. Your webhook shows the updated state.