A webhook is an URL call system to provide other applications with information related to different events within a game campaign or the Adictiz Box platform.
Find them in the section My Account > My Webhooks.
For each webhook, data is sent to the URL via the POST method.
The data is sent in JSON format in the request's body.
Output IPs :
52.31.162.5 (To be deleted from January 2024)
54.77.225.202 (To be deleted from January 2024)
35.241.193.158
146.148.125.165
35.187.48.192
Please note: our exit IPs from the Adictiz Box platform will be gradually switched over between now and the end of 2023 and the following 2 IPs will be removed from your whitelist (from 1 January 2024):
52.31.162.5
54.77.225.202
"FormSubscribe" event: Form submission
The data is sent when submitting a form in an Adictiz Box campaign.
In case you have a campaign with multiple forms, webhooks are submitted to each form validation and the data is accumulated. The data returned is as follows:
{
"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": ""
}
}
"Instant Win" Event: Reward assigned via an Instant Win
Data are sent when a user win a reward via an Instant Win module in any of your live Adictiz Box campaign.
You can find a JSON object example below :
{
"timestamp": 1465826338,
"request_id": "575ebc220c0080.14860437",
"event_type": "InstantWin",
"data": {
"prize_id": "", // Reward ID
"prize_type": "", // Reward type : normal, ifg (ifeelgoods), code
"prize_name": "", // Reward name
"prize_description": "", // Description
"prize_picture": "", // Picture URL
"prize_value": "", // Reward price
"user_id": "", // User unique ID (unicity is managed by campaign)
"distributionDate": "", // Availability date of the reward
"gainDate": "", // Winning date of the reward
"data": "" // Additional data that can vary depending on the reward type (ifeelgoods, URL, code etc..)
}
}
"OperationCreate" event: New campaign created
Data are sent when a new campaign is created in the platform.
You can find a JSON object example below :
{
"timestamp": 1465826098,
"request_id": "575ebb3299fd79.10666580",
"event_type": "OperationCreate",
"data": {
"operation_id": "", // Campaign unique ID
"name": "", // Campaign name
"timestamp_start": "", // Start date of the campaign
"timestamp_end": "", // End date of the campaign
"time_zone": "", // Time zone of the campaign, ex : "Europe/Brussels"
"default_locale": "" // Default language of the campaign, ex : en_US
}
}
"GameParticipation" Event: New game participation
Data are sent when a new participation occurred in any of your live Adictiz Box campaign.
You can find a JSON object example below :
// UserContent
{
"timestamp": 1494595353,
"request_id": "5915b7190b0e77.68487088",
"event_type": "GameParticipation",
"data": {
"operationId": "57cd7dca2c1d86087e62aff3",
"pageId":"5915b6ae55618"
"pageType": "videoUpload",
"userId": "57cd7dca2c1d86087e62aff3",
"gameParticipationType": "UserContent",
"gameData": {
"mediacontest_id": {
"$id": "5915b718b7746826007b23c6"
},
"datetime": "2017-05-12 13:22:33",
"timestamp": 1494595353
}
}
}
The GameData node can vary depending on the associated module :
// UserGame
{
"timestamp": 1494595169,
"request_id": "5915b661d911e3.84560538",
"event_type": "GameParticipation",
"data": {
"operationId": "57cd7dca2c1d86087e62aff3",
"pageId":"5915b6ae55618"
"pageType": "flappy",
"userId": "57cd7dca2c1d86087e62aff3",
"gameParticipationType": "UserGame",
"gameData": {
"date": "2017-05-12 13:19:29",
"datetime": 1494595169,
"score": 0,
"score_type": "pts",
"duration": 2,
"status": false,
"data": null
}
}
}
"SSOConnection" Event: SSO connection success
Data are sent when a user signs up or logs in using a SSO connector. The JSON object contains the API node data and the partnerUserID.
You can find a JSON object example below :
{
"timestamp": 1494835857,
"request_id": "59196291d19038.71379665",
"event_type": "SSOConnexion",
"data":{
"operationId": "584927903a1d0ee1db44544b",
"userId": "584927903a1d0ee1db44544b",
"partnerId": "xxx", // Unique Partner User ID
// API node data
"firstname": "Marc",
"lastname": "Assin",
"email": "[email protected]",
"rules": 1
}
}
"JWTConnection" Event : JWT connection success
Data are sent when a user logs in using a JWT token. The JSON object contains the API node data and the partnerUserID.
You can find a JSON object example below :
{
"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"
}
}
"MediaGalleryModerated" Event: Media Moderation
This is the data sent during the moderation of a media. You can find a JSON object example below :
{
"email":"[email protected]",
"moderate":1,
"campaignId":"5bc5922f4be94bb2516f61c7"
}
"EmailShare" Event : Sending sharing emails
This is the data sent when sharing by email to one or more users.
You can find a JSON object example below :
{
"timestamp":1539764057,
"request_id":"eobql8mmgxe",
"event_type":"EmailShare",
"data":{
"user":{
"id":"",
"firstname":"",
"lastname":"",
"email":""
},
"receivers":[
"" // Destinataires
],
"operation_id":"", // Unique name of the campaign
"operation_name":"" // Campaign name
}
}
"QuestionParticipation" Event : Participation in a Quiz module
This is the data sent when a user participates in a quiz game. Each request matches a question from the Quiz. If the Quiz has 3 questions, then 3 separate events will be returned. You can find a JSON object example below :
{
"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"
}
}
"Transactions" Event
This is the data sent during a transaction detected by the conversion pixel installed on your e-commerce site. The data returned are as follows:
{
"timestamp: 1465826098, // Date of sending of the event
"request_id": "575ebb3299fd7910666580", // Unique event identifier
"event_type": "Transaction", // Name of the event
"data": {
"operation_id": "", // Unique campaign identifier
"name": "", // Name of the campaign
"user_id": "", // User's unique identifier
"command_date": "", // Date and time of the transaction
"command_number": "", // Transaction number
"command_amount": "", // Transaction amount
"command_currency": "" // Currency of the transaction
}
}
"FileUpload" Event
This is the data sent when a user uploads media to a campaign. Each request corresponds to a media. The data returned are the following:
{
“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”
}
}
Once you have created the reminder URL, you can add it to your Adictiz Box account:
