Que reçoit-on avec le Webhook ?

Découvrez comment est structuré le JSON que nous transmet le Webhook.

1. L'entête de la donnée

{
  "id": "171216479",
  "eventType": "finished",

• id : Identifiant unique de la donnée.
• eventType : Action qui a déclenché l'envoi du Webhook. Il en existe 5 :
  • finished : Enregistrement de la donnée.
  • update : Modification de la donnée.
  • push : Transfert de la donnée.
  • pull : Récupération de la donnée sur le mobile du destinataire.
  • delete : Suppression de la donnée sur l'Interface Web.

2. La clé data

Dans la clé data, vous avez les informations liées à l'évènement de la donnée.

  "data": {
    "recipient_user_id": null,
    "answer_time": "2023-09-18T17:17:39+02:00",
    "update_answer_time": "2023-09-18T17:17:39+02:00",
    "id_tel": "0e7cf0a8-46bc-4246-a7ec-bbfd552cfa91",
    "media": [
      "c55318f923838pu319057_20230918171436_7a49b140.jpg",
      "c55318f923838pu319057_20230918171617_5f3a8c56-85ff.jpg",
      "c55318f923838su319057_20230918171701_b8518e6a.png"
    ],
    "form_id": "923838",
    "origin": "android",
    "app_version": "7.19.198",
    "device_info": "SM-G986B android(33)",
    "form_update_time": "2023-09-19 10:10:20",
    "local_uuid": "c2f42015-2315-4bd4-a34f-3530097023de",
    "format": "4",
    "id": "171854118",
    "user_id": "319057"

• recipient_user_id : Id du destinataire d'un transfert ou d'un Push. Valeur null si la donnée n'est pas transférée ou pushée.
• answer_time : Date et heure du premier enregistrement de la donnée.
• update_answer_time : Date et heure de la dernière mise à jour de la donnée.
• id_tel : Identifiant unique créé à l'installation de l'application Kizeo Forms sur le mobile. Ce numéro change si l'on désinstalle et réinstalle l'application.
• media : Liste des médias présents dans la donnée.
• form_id : Identifiant unique du formulaire.
• origin : Type d'appareil qui a réalisé l'opération :
  • web : Saisie Web.
  • android : Appareil mobile sous système d'exploitation Android.
  • ios : Appareil mobile sous système d'exploitation iOS.
• app_version : Version de l'application.
• device_info : Référence du modèle du mobile et son OS avec sa version.
• form_update_time : Date à laquelle la version du formulaire utilisé pour la saisie de la donnée a été enregistrée.
• local_uuid : Indentifiant unique de la donnée sur le mobile de saisie.
• format : Version de la structure du JSON de la donnée Kizeo Forms.
• id : Identifiant unique de la donnée.
• user_id : Identifiant unique de l'utilisateur qui a saisi la donnée.

La clé fields

Dans la clé fields, qui se trouve dans data, vous trouvez les champs de votre formulaire et la valeur saisie. Ci-dessous un exemple de la structure de cette partie du JSON.

"fields": {
      "field_id": {
        "result": value,
        "hidden": false,
        ...
      },
      "field_id": {
        "result": value,
        "hidden": true,
        ...
      },
      ...
    },

Vous avez maintenant la liste de l'ensemble des informations qui sont transmises par le Webhook.