Using webhooks

Tabata Vossen -

Use webhooks to be notified about new participations that happen in your campaigns. In this tutorial, we'll walk you through the steps to use a webhook with Qualifio.

What is a webhook?

A webhook (also called HTTP callback) is a way for an app like Qualifio to provide other applications (your CRM, email marketing platform, Google Sheet or Trello board for instance) with real-time information. In the context of Qualifio, the webhook delivers data to other applications as a new participation happens to your campaign, meaning you get the data immediately.

Setting up a webhook

The first step is giving us a URL to deliver data to. This can be done by

1. Enabling the webhook from the Integrations & Partners panel in Qualifio's back-office

Webhooks are configured via the account Settings under Integrations & Partners > Webhooks.

2. Setting up a URL from your provider

You will need to click 'Configure', then, into the given field, specify the (request endpoint) URL to receive notification requests.


Screenshot_2019-07-25_at_10.25.41.png

Note: To protect your data and your participants', we strongly recommend using an authenticated HTTPS URL.

Once you register a URL to receive webhooks, Qualifio will send a notification to that URL every time there's a new participation for any of your campaigns for which the webhook was activated.

3. Enabling the webhook in your campaign

In your form or Master Form, you need to:

  • Access the 'Data Connections' menu.
  • Open the dropdown list for real-time pushes.
  • Select your webhook to activate it for this form.

Supported data

Need more information about data mapping and the fields included in the webhook?
You can download the list of all data included in the webhook.

To include more fields, you may use custom SSO variables. Their value will be sent along with the webhook.

Webhook format

The object delivered to a webhook is a notification. Notifications have payloads, which contain the participation's information, such as browser type or participant's data. 

This JSON has the following format:

{
 "browser": {
   "device": "desktop",
   "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36"
 },
 "casualGame": {
   "score": 0
 },
 "clientId": 513,
 "configuration": "pushWebhookParticipationV1",
 "crmId": "280",
 "custom": {
   "profileId": ""
 },
 "dateStartServer": 1563972535,
 "dateendserver": "1563972558",
 "game": {
   "typeId": 1,
   "channel": {
     "dateStart": 1563746400,
     "country": "BE",
     "publishType": "widget",
     "dateEnd": 1565042340,
     "sitename": "S&Q News",
     "siteId": "1938",
     "id": "650136",
     "publishTarget": "1938"
   },
   "name": "Test Mr.Wonderful",
   "id": "650135",
   "custom": {
     "clientCampaignId": ""
   },
   "themes": [
     "481"
   ]
 },
 "id": "5BA43A1F-2714-4833-8497-6973867E6D7C",
 "ip": "109.190.218.224",
 "language": "EN",
 "newProfile": true,
 "playTime": "2019-07-24 14:48:52",
 "website": "",
 "crm": {
   "address": "Rue de la noix",
   "birthday": "567903600",
   "email": "noreply@qualifio.com",
   "firstname": "Quentin",
   "label10_bit": "1",
   "label1_bit": "1",
   "lastname": "Lebrun",
   "locality": "namur",
   "number": "12",
   "phone": "0408/27.36.40",
   "zipcode": "5000"
 },
 "sso": {
   "EMAIL": "noreply@qualifio.com",
   "FNAME": "Quentin",
   "LNAME": "Lebrun",
   "dailynews": "1",
   "sportnews": "1"
 }

By default, the maximum limit of webhooks is 1 per account. If you need to use different webhooks for each of your websites or in each of your campaigns, it is possible! Please make contact with your Qualifio Expert or with our Helpdesk.

  • Admin users can manage webhooks at the account and website level.
  • Marketeer users can manage webhooks at the campaign level, depending on their permissions.

 

Next:

Powered by Zendesk