Les webhooks 1.0 de Qualifio

Avertissement : Cette documentation s'applique uniquement au webhook 1.0, qui est déprécié. Pour plus d'infos sur le webhook 2.0, lisez la documentation correspondante ou migrez.

Utilisez des webhooks pour être informé des nouvelles participations dans vos campagnes. Dans ce tutoriel, nous vous expliquerons les étapes à suivre pour utiliser un webhook avec Qualifio.

Qu'est-ce qu'un webhook ?

Un webhook (aussi appelé "crochet web") est un moyen pour une application comme Qualifio de fournir des informations en temps réel à d'autres applications (votre CRM, votre plateforme d'email marketing, Google Sheets ou Trello, par exemple). Dans le cadre de Qualifio, le webhook fournit des données à d'autres applications quand une nouvelle participation survient dans votre campagne, ce qui signifie que vous recevez les données immédiatement.

Mise en place d'un webhook

La première étape consiste à nous donner une URL à laquelle nous pouvons envoyer les données. Pour ce faire, il faut

1. Activer le webhook à partir du module Intégrations & Partenaires dans le back-office de Qualifio

Les webhooks sont configurés via les Paramètres du compte sous Intégrations & Partenaires > Webhooks.

Screenshot_2020-07-15_at_15.44.19.png

2. Configurer une URL fournie par votre application

Vous devrez cliquer sur Paramétrer puis, dans le champ prévu à cet effet, spécifier l'URL qui vous permettra de recevoir les demandes de notification.

Screenshot_2019-07-26_at_15.53.05.png

Screenshot_2020-07-15_at_15.45.28.png

Note : Pour protéger vos données et celles de vos participants, vous devez utiliser une URL HTTPS authentifiée.

Une fois que vous avez enregistré une URL pour recevoir des infos via le webhook, Qualifio enverra une notification à cette URL chaque fois qu'il y aura une nouvelle participation pour une de vos campagnes pour laquelle le webhook a été activé.

3. Activer le webhook dans vos campagnes

Dans votre compte, vous devez :

Accéder au menu "Paramètres" ;
Ouvrir la section des "Règles de push de données" ;
Sélectionnez les endroits où vous souhaitez activer votre webhook (par défaut/site/Master Form/campagne).

Note
Si vous souhaitez en savoir plus sur les Règles de push de données, cliquez ici.

Données prises en charge

Besoin de plus d'informations sur le mappage des données et les champs inclus dans le webhook ? Vous pouvez télécharger la liste de toutes les données incluses dans le webhook.

Pour inclure plus de champs, vous pouvez utiliser des variables de mapping ou, dans certains cas spécifiques, des variables SSO. Leur valeur sera envoyée dans le webhook.

Les champs non présents dans le formulaire ou sans variable associée ne sont pas envoyés.

Qu'en est-il des opt-ins ?

Les opt-ins peuvent être inclus s'ils sont liés à une variable. La valeur envoyée peut être

1 – si le ou la participant(e) a accepté l'opt-in en cochant la case ou en sélectionnant "Oui".
0 – si le ou la participant(e) n'a pas accepté l'opt-in et n'a pas coché la case ou a sélectionné "Non".

Pour éviter les opt-outs, veuillez ajouter une règle d'importation de votre côté pour ignorer la valeur "0" des opt-ins.

Format du webhook

Les notifications du webhook ont des charges utiles ("payloads"), qui contiennent des informations sur la participation, telles que le type de navigateur ou les données du participant.

Ce JSON a le format suivant :

{
  "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"
  }
}

Par défaut, la limite maximale de webhooks est de 1 par compte. Si vous avez besoin d'utiliser des webhooks différents pour chacun de vos sites ou dans chacune de vos campagnes, c'est possible ! Veuillez prendre contact avec votre Expert(e) Qualifio ou avec notre Helpdesk.

Les utilisateurs Admin peuvent gérer les webhooks au niveau du compte et du site.
Les utilisateurs Marketeer peuvent gérer les webhooks au niveau de la campagne, en fonction de leurs permissions.

Lire aussi :