Quick Guide on How to Use the Email Event Webhook

The purpose of this document is to provide a quick guide for the proper functioning of the Email Event Webhook.

The event webhook establishes one-way communication, where a system, in this case, the webhook provider, automatically sends data to a specific URL called the webhook endpoint when a particular event occurs.

Event webhooks are used for a wide range of purposes, including data synchronization, real-time information updates, and process automation.

1. 🧬 What is a Webhook?

A webhook is a form of integration between systems and applications that allows the delivery of specific information or data from one system to another. In this case, it refers to the events generated from each email sent from campaigns created in MasivApp or sent via the API.

How Does the Webhook Work?

How to Get Started?

2. 🛠️ Configuración por defecto

The default configuration corresponds to the basic information that will be sent to the webhook.

Default Configuration

Example of Default Payload

3. 🚩Prerequisites for the webhook

The following are the prerequisites to consider when creating the endpoint to receive events for each submission made from Masiv Email:

<aside> 💡 Important: The endpoint payload must initially correspond to the default webhook configuration described in section 2 and be updated with the custom information requested as needed.

</aside>

4. ⚙️ Registration and Customization Request