Getting started with the webhook 2.0

Tabata Vossen -

This page reviews the differences in the webhook 1.0 and the webhook 2.0 and how to migrate into the 2.0 version.

Ever since we launched our webhook a couple of years ago, it has been the number one integration for our customers. This is why today we’re overjoyed to bring you new updates about Qualifio’s webhook integration. After lots of investigation and extensive testing, our new payload – which contains a wider range of data – and latest improvements are in and fully functional.

→ Ready to start using the webhook 2.0? To allow these new improvements, you need to migrate to the webhook 2.0. Below we explain how Qualifio account admins can prepare their migration from the webhook 1.0 to the webhook 2.0. Have fun and happy webhooking!

Getting started

Begin using the webhook 2.0 in just three steps:

  • Enable and prepare your webhook 2.0 in Qualifio
  • Adapt your import rules and test your new webhook
  • Delete your webhook 1.0 integration

Prepare your webhook 2.0

To enable the webhook 2.0 integration in your account, open Qualifio and click on the Settings tab. Then, go to the Integrations & partners section and search Webhook 2.0 or filter using the Webhooks tab. Turn on the webhook 2.0 and click Configure.

Webhooks are available:

  • Per account
  • Additionally per website
In Qualifio, the maximum number of webhooks per account and per website is limited to one.

Screenshot_2021-01-19_at_16.05.09.png

Here, you can provide endpoints to receive notifications about participations. We recommend you ensure that the webhook is served over https.

If you specify a name and value for authentication, these will be sent with the webhook request in the header. Your webhook endpoint can check that to verify that the request is legitimate.

A sample webhook payload looks like this: https://integrations.qualifio.com/schemas/webhook/v2/index.html#root_ex1 

Please review this page to learn more about webhook 2.0.

Next, go to Settings > Push rules. You can use this new section to manage how your webhook 2.0 will push data from your Qualifio campaigns.

Screenshot_2021-04-27_at_10.22.25.png

This new screen allows you to be notified only when participations take place on specific websites or in specific campaigns. Read our docs for a complete and detailed overview of the Push rules module.

Test your webhook

Before you go ahead and delete your webhook 1.0 integration, you’ll need to make sure your environment is ready. Once you set up your new webhook, you must update any services or systems that use Qualifio data (webhook payload) and adjust import rules for things like updates, analytics or alerting.

Also, variables can be added or changed using mapping variables.

Delete your webhook 1.0 integration

Your new webhook should now deliver data to your other applications. Once you moved to the webhook 2.0, you can turn the webhook 1.0 off in the integration settings in your Qualifio account.

I migrated to the webhook 2.0. Now what?

When you start using the webhook 2.0, we don’t remove the webhook 1.0. This version is considered deprecated as of February 9, 2021. However, there is currently no deadline for the migration.

More questions or problems?

If you have any more questions or run into any issues, just let us know.