Webhooks

In the Marketing Suite configuration menu you can find the menu Webhooks, previously called Feedback Loops. Webhooks are processes that notify their user of events that happen in real time through HTTP POST. This allows you to always have the most recent results of your mailing. Please note that this functionality is currently only available in the Marketing Suite.

While Webhooks are very useful, they should be used with caution as they can generate large amounts of calls. If you are unsure about your server capacity or do not need real-time feedback you can also view the statistics or logfiles or use one of Copernica's APIs.

There are several types of Webhooks. The articles linked below explain these types in more detail:

Webhooks with Marketing Suite

Webhooks can be used to sync data that passes through Copernica directly into your own application. Webhooks require a script on your own server to execute whenever information is provided through the Webhook. You can set several triggers in the Webhooks menu such as opens, clicks, profile edits and bounces.

The data you receive is very rich and allows you to easily link it to the data already present in your system. Copernica receives the IP address and HTTP headers of the incoming request and adds the e-mail address, profile data and linked tags to send to you. Based on this information it is easy to add the information to the correct profile.

By navigating to a database or collection you can also easily view all Webhooks that are linked to it, making it easy to see which Webhooks apply to this specific set of data.

Setting up Webhooks

The first step for setting up a Webhook is to navigate to the CONFIGURATION menu, where you can find the Webhooks menu under the 'Account' section. To create a Webhook you pick a type and then add the callback URL, where the data will be sent to after configuration.

The next step is to verify your web address. This extra step ensures that your potentially confidential data will be sent to the correct server. In the Marketing Suite you will find a link to download the verification file, which will be different for every new Webhook. The file should be placed in the root of your webserver or in the directory of the script that will handle the incoming HTTP POST requests. So if your script is in the following location:

"https://example.com/dir/script.php"

You should have the text file, which will be named something like "smtpeter-xxxxx.txt" in the same location:

"https://example.com/dir/smtpeter-xxxxx.txt"

You can now verify the callback URL by clicking the link in the Marketing Suite. You may delete the text file after verification. You can test your new Webhook by clicking 'Manage' next to it and using the testing tool or the 'Check now' button in the Webhook menu to test all your Webhooks.

Security

To protect your endpoint from abuse and false information injection, Copernica signs all requests to your endpoint, so you can be sure it's actually Copernica sending you the data.

More information