Un webhook est un mécanisme qui permet de fournir à d'autres applications des informations liées à différents événements au sein d'une campagne de jeu ou de la plateforme Adictiz Box.
Retrouvez-les dans la section Mon Compte > Mes Webhooks.
Les évènements disponibles :
Soumission d'un formulaire : données envoyées lors de la soumission d'un formulaire dans une campagne de jeu. Dans le cas d'une campagne avec plusieurs formulaires, les webhooks sont soumis à chaque validation de formulaire avec les données associées.
Attribution d'une dotation à un Instant Gagnant ("Dotation distribuée") : données envoyées lorsqu'un utilisateur d'une campagne remporte une dotation sur un module d'instant gagnant.
Création d'une nouvelle campagne de jeu : données envoyées lors de la création d'une campagne sur la plateforme Adictiz Box
Participation à un jeu : données envoyées lors de la génération d'une participation (score réalisé, média publié, etc.).
Média modéré : données envoyées lors de la modération d’un média
Envoi d’emails de partage : données envoyées lors d’un partage par email à un ou plusieurs destinataires.
Participation au module de type Quiz : données envoyées lors de la participation d’un utilisateur à un jeu de Quiz. Chaque requête correspond à une question du Quiz. Si le Quiz comporte 3 questions, alors il sera renvoyé 3 événements distincts.
Connexion via le SSO : données envoyées lors d'une connexion via un SSO après une connexion ou une création de compte.
Connexion via une JWT : données envoyées lors d'une authentification à la campagne via JWT. Le webhook retourne toute les données du noeud API ainsi que le partnerUserID
Transactions : données envoyées lors d’une transaction détectée par le pixel de conversion installé sur votre site e-commerce.
FileUpload : données d'upload de fichier(s) par les utilisateurs de la campagne.
Pour chaque webhook, les données sont envoyées à l'URL configurée via la méthode POST, au format JSON dans le body de la requête.
IPs de sortie :
52.31.162.5 (A supprimer à partir de Janvier 2024)
54.77.225.202 (A supprimer à partir de Janvier 2024)
35.241.193.158
146.148.125.165
35.187.48.192
À savoir : nos IPs de sortie de la plateforme Adictiz Box vont basculer progressivement d'ici la fin d'année 2023 et les 2 IPs suivantes seront à supprimer dans votre whitelist (à compter du 1er janvier 2024) :
52.31.162.5
54.77.225.202
Événement "FormSubscribe" : Soumission de formulaire
Les données sont envoyées lors de la soumission d'un formulaire dans une campagne Adictiz Box. Dans le cas d'une campagne avec plusieurs formulaires, les webhooks sont soumis à chaque validation de formulaire avec les données associées.
Les données renvoyées sont les suivantes :
{
"timestamp":1539704351, // Date d'envoi
"request_id":"sb4dk8nyiwf", // Identifiant unique de requête
"event_type":"FormSubscribe", // Nom de l’événement
"data":{
"civility":"",
"lastname":"",
"firstname":"",
"email":"",
"emailConfirmation":"",
"address":"",
"zipCode":"",
"city":"",
"country":"",
"birthday":"",
"deskPhone":"",
"mobilePhone":"",
"loyalty":"",
"reglement":"",
"newsletter":"",
"optin_partner":"",
"optin_mobile":"",
"state":"",
"nickname":"",
"pinterest_board":"",
"shops":"",
"session_id":"",
"ip_address":"",
"identifier":"",
"user_id":"", // Identifiant unique de l'utilisateur (unique par campagne)
"language":"fr",
"utm_source":,
"utm_medium": "",
"utm_campaign": "",
"utm_content": "",
"utm_term": "",
"device": "",
"date_operation":"",
"operation_id":"5bc605e34be94bb251285bb7", // Identifiant unique de l'opération
"operation_name":"", // Nom de la campagne
"custom_1": "",
"custom_2": "",
"custom_3": "",
"custom_4": "",
"custom_5": "",
"custom_6": "",
"custom_7": "",
"custom_8": "",
"custom_9": "",
"custom_10": ""
}
}
Événement "Instant Win" : Attribution d'une dotation à un Instant-Gagnant
Il s'agit des données envoyées lorsqu'un utilisateur d'une campagne remporte une dotation sur un module d'instant gagnant. Les données renvoyées sont les suivantes :
{
"timestamp":1539762124,
"request_id":"6vux1479adj",
"event_type":"InstantWin",
"data":{
"prize_id":"", // identifiant de la dotation
"prize_type":"", // type de dotation : normal, code
"prize_name":"", // nom de la dotation
"prize_description":"", // description
"prize_picture":"", // url du visuel
"prize_value":"", // valeur de la dotation
"user_id":"", // identifiant unique de l'utilisateur
"distributionDate":"", // date de la distribution (déblocage) de la dotation
"gainDate":"", // date du gain réel de la dotation
"data":{ // données additionnelles variables selon le type de dotation (ifeelgoods, URL, code etc..)
"link":"",
"codes":""
},
"session_id":"",
"ip_address":"",
"operation_id":"", // Identifiant unique de l'opération
"operation_name":"" // Nom de la campagne
}
}
Événement "MediaGalleryModerated" : Modération de médias
Il s'agit des données envoyées lors de la modération d’un média.
Les données renvoyées sont les suivantes :
{
"email":"[email protected]",
"moderate":1,
"campaignId":"5bc5922f4be94bb2516f61c7"
}
Événement "OperationCreate" : Création de campagne
Il s'agit des données envoyées lors de la création d'une campagne.
Les données renvoyées sont les suivantes :
{
"timestamp": 1465826098,
"request_id": "575ebb3299fd7910666580",
"event_type": "OperationCreate",
"data": {
"operation_id": "", // identifiant unique de l'opération
"name": "", // nom de la campagne
"timestamp_start": "", // date de début campagne
"timestamp_end": "", // date de fin campagne
"time_zone": "", // fuseau horaire ex : "Europe/Brussels"
"default_locale": "" // langue par défaut ex : fr_FR
}
}
Événement "GameParticipation" : Participation à un jeu
Il s'agit des données envoyées lors de la génération d'une participation (score réalisé, média publié, etc.).
Les données renvoyées sont les suivantes :
// UserContent
{
"timestamp":1539763114,
"request_id":"rzjy8nwu0ed",
"event_type":"GameParticipation",
"data":{
"operationId":"5bc6e63e4be94bb251412c7a",
"pageId":98543,
"pageType":"form",
"userId":"5bc6eba9532f834e3022fed8",
"gameParticipationType":"form",
"gameData":{
"date":"2018-10-17 07:58:33",
"data":{
"isFilled":true
},
"sessionId":"5bc6eb9a0231ae50090946f5"
},
"session_id":"",
"ip_address":"",
"operation_id":"",
"operation_name":""
}
}
Le noeud GameData est variable, et dépend du module concerné :
// UserGame
{
"timestamp":1539763114,
"request_id":"rzjy8nwu0ed",
"event_type":"GameParticipation",
"data":{
"operationId":"5bc6e63e4be94bb251412c7a",
"pageId":98543,
"pageType":"flappy",
"userId":"5bc6eba9532f834e3022fed8",
"gameParticipationType":"flappy",
"gameData": {
"date": "2017-05-12 13:19:29",
"datetime": 1494595169,
"score": 0,
"score_type": "pts",
"duration": 2,
"status": false,
"data": null
},
"session_id":"",
"ip_address":"",
"operation_id":"",
"operation_name":""
}
}
Événement "SSO Connexion" : Connexion réussie via le SSO
Il s'agit des données envoyées lors d'une connexion via SSO après une connexion ou une création de compte. Le webhook retourne toute les données du noeud API ainsi que le partnerUserID.
Les données renvoyées sont les suivantes :
{
"timestamp":1539766795,
"request_id":"krd45ewzbt",
"event_type":"SSOConnexion",
"data":{
"email":"",
"firstname":"",
"lastname":"",
"civility":"",
"optin_partner":"",
"optin_tierce":"",
"creationDate":"",
"operationId":"5bc6f9304be94bb25163c2a9",
"userId":"5bc6fa0b0231ae60091f2684",
"partnerId":"1334397545445900",
"session_id":"5bc6f9320231ae5ec94e44aa",
"ip_address":"",
"source_ids":[
],
"operation_id":"5bc6f9304be94bb25163c2a9",
"operation_name":"Grand Jeu"
}
}
Événement "JWT Connexion" : Connexion réussie via une JWT
Il s'agit des données envoyées lors d'une authentification à la campagne via JWT. Le webhook retourne toute les données du noeud API ainsi que le partnerUserID.
Les données renvoyées sont les suivantes :
{
"timestamp":1572440674,
"request_id":"6r9hu7chzog",
"event_type":"JWTConnection",
"data":{
"email":"",
"firstname":"",
"lastname":"",
"civility":"",
"optin_partner":"",
"optin_tierce":"",
"operationId":"5bc6f9304be94bb25163c2a9",
"userId":"5bc6fa0b0231ae60091f2684",
"partnerUserID":"1334397545445900",
"session_id":"5bc6f9320231ae5ec94e44aa",
"ip_address":"",
"source_ids":[
],
"operation_id":"5bc6f9304be94bb25163c2a9",
"operation_name":"Grand Jeu"
}
}
Événement "EmailShare" : Envoi d’emails de partage
Il s'agit des données envoyées lors d’un partage par email à un ou plusieurs destinataires. Les données renvoyées sont les suivantes :
{
"timestamp":1539764057,
"request_id":"eobql8mmgxe",
"event_type":"EmailShare",
"data":{
"user":{
"id":"",
"firstname":"",
"lastname":"",
"email":""
},
"receivers":[
"" // Destinataires
],
"operation_id":"", // ID unique de la campagne
"operation_name":"" // Nom de la campagne
}
}
Événement "QuestionParticipation" : Participation à un module Quiz
Il s'agit des données envoyées lors de la participation d’un utilisateur à un jeu de Quiz. Chaque requête correspond à une question du Quiz. Si le Quiz comporte 3 question, alors il sera renvoyé 3 évènements distincts. Les données renvoyées sont les suivantes :
{
"timestamp":1539763323,
"request_id":"pk160yii4x",
"event_type":"QuestionParticipation",
"data":{
"user_id":"5bc6ec5e0231ae50b303be79",
"questions":[
{
"id_question":"a0d9f890-cf1d-44db-9c5d-4e2f28270956",
"label_question":"Question 1",
"answers":[
{
"id":"455c464d-7c71-4e08-bbb2-f620206f8c21",
"label":"Réponse 1"
}
],
"is_correct":true,
"points":0
}
],
"campaign_customized_id":[
],
"lang":"fr",
"operation_id":"5bb23f424be94bb2510386dd",
"operation_name":"Quiz"
}
}
Événement "Transactions"
Il s'agit des données envoyées lors d’une transaction détectée par le pixel de conversion installé sur votre site e-commerce. Les données renvoyées sont les suivantes :
{
"timestamp": 1465826098, // Date d’envoi de l’évènement
"request_id": "575ebb3299fd7910666580", // Identifiant unique de l’évènement
"event_type": "Transaction", // Nom de l’évènement
"data": {
"operation_id": "", // Identifiant unique de la campagne
"name": "", // Nom de la campagne
"user_id": "", // Identifiant unique de l’utilisateur
"command_date": "", // Date et heure de la transaction
"command_number": "", // N° de la transaction
"command_amount": "", // Montant de la transaction
"command_currency": "" // Devise de la transaction
}
}
Événement "FileUpload"
Il s'agit des données envoyées lorsqu’un utilisateur effectue un upload de média sur une campagne. Chaque requête correspond à un média. Les données renvoyées sont les suivantes :
{
“timestamp”: 1632148759,
“request_id”: “d97dapgzie”,
“event_type”: “FileUpload”,
“data”: {
“user_id”: “6148982a30b1ba64f53184ef”,
“upload_id”: “61489d15d9661b0460601047_61489d17d19bbe4269235aa0",
“upload_type”: “image/png”,
“upload_name”: “61489d15c3f088.29722501.png”,
“upload_url”: “https://f.a-fs.me/diffusion/4396/33559/252364/61489d16c1ef2.png”,
“upload_date”: “2021-09-20 14:39:17",
“operation_id”: “614896c3c9eae0424276a116",
“operation_name”: “Campagne vierge”,
“upload_description”: “description”,
“upload_short_description”: “short description”
}
}
Une fois que vous avez renseigné l'url d'appel, vous pouvez l'ajouter à votre compte Adictiz Box :
