What are webhooks?

Webhooks allow you to talk to any backend or third-party services. It is a combination of elements that collectively create a notification and reaction system. Webhooks provide a powerful method to track the state of events and to take action within your erxes account. Read on to ensure your webhooks function seamlessly with your integration.

Outgoing Webhook

Send event notifications with webhooks When you manually add a contact or an integration creates a new contact automatically, erxes will send relevant data through HTTPS POST request to the webhook URL.

Follow these steps to set up your outgoing webhook with your erxes integration:

1. Create a webhook endpoint in your third-party software that you want to integrate. This endpoint URL must have an SSL certificate. Because erxes sends only HTTPS POST requests.
2. Go to Settings and choose Outgoing Webhooks:
   
   
    
3. Click on “Add Webhook”. Enter your webhook endpoint and choose the events or triggers you want to notify the third-party software. You can select multiple actions. Click on “Save”.
   
   
   
    
4. erxes generates a token for every webhooks. You can copy your token to the clipboard from the webhooks list. This token will help identify erxes as a trusted source for receiving data:
   
   

It’s time to test the webhook. Create any actions you’ve selected as a trigger. For example, in this case we will create a new customer on erxes. You will receive the following data on the webhook:

As you can see here, you will need your third-party software to make sense of this data and populate it within another software. If your software has the ability to receive data through webhooks, please refer to their guide titled “Incoming Webhooks”.

But if you use automation software, you’ll just need to connect this webhook to the final “destination” with it. For example, this is how it would look like with Integromat, Pabbly Connect, etc.

1. Create Outgoing Webhook on erxes
2. Capture this webhook by creating a workflow on your automation software
   1. Input erxes webhook URL and token
   2. Parse the received data with JSON
   3. Set the action by choosing an app and action
   4. Map out which data field goes where

Incoming Webhook

Receive event notifications with webhooks Incoming webhooks are a key feature to receive data from external sources into erxes. Follow these steps to set up any incoming webhooks:

1. Navigate to the Settings -> AppStore and scroll down to the Webhook:
   
   
    
2. Click on the “Add” button and type in a name and select Brand and Channel for your webhook. 
3. There are a script and example payload section. In the script section, you can write your own script to convert data to format that erxes accepts. Click “Save”.
4. Click anywhere on the Webhook box to expand the items and click on the “Show” button:
   
   
    
5. The integration detail section shows you a webhook URL and token. Webhook URL is a randomly generated unique URL that receives data from external sources. Also you must add a token to the request header so that erxes can confirm the request.