What are Webhooks?

In practice, Webhooks (also known as HTTP push APIs or Web Callbacks and in Portuguese we would say: Web Hooks ) are used so that a system or application can send information or data to other systems and applications passively, which makes the process really fast (practically in real time).

Despite using a concept similar to that of APIs, a webhook does not require validations, data can travel in a “one-way street” and is generally activated by event triggers.

Once a certain event has occurred, the canadacell numbers triggers an HTTP request (usually of the POST type) so that the other application receives the data (usually in XML or Json format) at a certain URL.

How do GemMail Webhooks work?
Simple, they work when you create your campaign, just enter the destination URL. The data is sent in JSON format.

Opening webhooks
When creating a campaign, you can add opening webhooks at the time you are configuring your campaign.

To add a Webhook URL click the “+ Show More Options” button.

The screen will expand downwards showing some ways to interact with the campaign, look for the “Subscriber webhooks after opening the campaign” box, in “Webhook URL” enter the domain of your application that will receive the data from GemMail.

When someone opens the campaign or clicks on any of the links assigned to the webhooks, GemMail will write an event to the queue and when the task (system cron) runs, GemMail will process these events and send the correct data to the webhook URL you have registered. In case sending to a URL fails, GemMail will retry 5 times.

The data will be sent in this format:

From then on, the show is yours, your integrations will probably use connections to other applications' APIs and you will have to follow their documentation.