Webhook

IntentPlatform met à disposition un mécanisme de webhook (à destination des services d'information des tiers) permettant d'être notifié dès qu'une demande d'intervention est transmise ou qu'une mise à jour de la demande a eu lieu.

Informations générales

La configuration du webhook se réalise dans la partie administration de votre entité. Vous devez indiquer l'url sur laquelle vous souhaitez qu'intentPlatform vous transmette le webhook.

Vidéo explicative


 Plus d'informations sur le webhook 

Scénario à implémenter

 ⁠⁠Récupération de la demande d'intervention⁠ 
 ⁠⁠Annulation de la demande⁠ 
 ⁠⁠Clôture de la demande⁠ 
 ⁠⁠Récupération des pièces jointes⁠ 
 ⁠⁠Cas particuliers⁠ 

Déroulé

Un message de type webhook est émis sur l'url configurée dès lors qu'une demande d'intervention est créée sur intentPlatform et qu'elle vous est destinée ainsi que lorsqu'elle est mise à jour?

Solution technique

Au sein du message reçu sur votre url, vous retrouvez certaines informations de la demande. A l'aide du lien HAL operation_url, vous pouvez directement réaliser un appel API GET /operations/{reference} pour récupérer toutes les données caractérisant la demande d'intervention (description, criticité, localisation, contacts, etc.) et ainsi l'intégrer dans votre système.

Une fois le wehbook reçu, lancement des actions suivantes :
  • Appel API sur le champ operation_url : GET /operations/{reference}
  • Appel API pour récupérer les photos
  • Appel API pour récupérer les documents

Exemple de webhook reçu lors d'une mise à jour d'intervention :


[
  {
    "type": "operations:intervention:update",
    "id": "388eca76-d075-49ee-8eb8-01f939d1bcee",
    "event": {
      "type": "operations",
      "body": {
        "id": "590538df-a39e-4a00-9770-8c205a53a6db",
        "reference": "WEBHOOK_TEST_3",
        "contractReference": "test_bailleur_001",
        "type": "intervention",
        "description": "Intervention réceptionnée et prise en charge ",
        "status": "open",
        "event": "acknowledged",
        "serviceCode": "SC001",
        "workType": "corrective",
        "criticalLevel": "",
        "issuer": {
          "entity": {
            "id": "5853fdefc2829a04502a0734",
            "label": "Intent Staff"
          },
          "user": {
            "id": "dbb63b64-12f4-451e-ace1-47a22a71bfba",
            "name": "Service client"
          }
        },
        "operation_url": "https://api.hubintent.com/api/operations/v2/operations/WEBHOOK_TEST_3?contractReference=test_bailleur_001"
      }
    }
  }
]


Retours de webhook

Tout code entre 200 et 299 sera considéré comme un succès
Tout autre code sera traduit comme "erreur" dans notre administration