How to use webhooks

EVO webhooks allow EVO to notify other systems whenever a specific event occurs, facilitating process automation and integration between platforms. Below is a detailed step-by-step guide to creating a webhook in EVO.

What is a Webhook?

A webhook is a form of real-time notification, where the EVO system sends information to an external URL whenever a specific event occurs (such as a sale made, a customer registered, etc.). Read more.

Step 1: Obtain the Callback URL

The first step to configuring a webhook is to have a callback URL. This URL will be the point of reception for the data sent by EVO.

What is the callback URL?

It is the URL of an external server or API that will be ready to receive POST requests with the event data.

It is mandatory that the protocol is HTTPS.

A site that can be used for testing is https://webhook.site/, by registering a webhook with the URL available on the site.

Step 2: Choose the Event Type

Choose the event type that will trigger the webhook.

EVO offers several types of events, such as NewSale, CreateMember, AlterMember, among others. The available events and their descriptions are in the add new webhook endpoint.

Examples of events:

NewSale: Triggered when a sale is made.

CreateMember: Triggered when a prospect becomes a customer.

NewInvoice: Triggered whenever a new invoice is generated in the system.

Step 3: Determine the Required Parameters

When configuring the webhook, you need to fill in some mandatory parameters and, optionally, additional parameters.

Mandatory Parameters:

eventType: Type of event that will trigger the webhook (e.g., NewSale).

urlCallback: The external URL that will receive the event data.

Optional Parameters:

IdBranch: Number of the branch where the event occurred (if using multi-location).

headers: Custom headers, such as an authentication token.

filters: Applicable filters (e.g., filter only sales of a specific item).

Step 4: Send a POST Request

To register the webhook in EVO, send a POST request with the defined parameters. You can use our documentation to do this.

Example of JSON structure for the webhook:

{
   "IdBranch": "1", 
   "eventType": "NewSale", 
   "urlCallback": "https://meusistema.com/webhook/callback", 
   "headers": [
        {"name": "Authorization", "value": "Bearer token"}
    ],
   "filters": [
        {
            "FilterType": "SaleItemDescription", 
            "Value": "Product A"
        }
    ]
}

What is a Webhook?#

Step 1: Obtain the Callback URL#

Step 2: Choose the Event Type#

Step 3: Determine the Required Parameters#

Mandatory Parameters:#

Optional Parameters:#

Step 4: Send a POST Request#

Example of JSON structure for the webhook:#