Vous pouvez souscrire à des webhooks pour être informés en temps réel de changements effectués par Hello Harel.
Tout d'abord, obtenez la liste des webhooks disponibles par GET /api/v1/webhooks/available. Seuls les webhooks pour lesquels votre utilisateur est autorisé seront affichés.
Vous pouvez ensuite souscrire un webhook par PUT /api/v1/webhooks en envoyant ce contenu :

{

  "event": "sales_order_validated",

  "url": "https://myapplication.com/webhooks/order_validated"

}

Une fois souscris, les événements vous concernant vous seront envoyés sous la forme d'une requête POST non authentifiée contenant une représentation JSON des objets concernés et les deux en-têtes suivants :

  • X-WEBHOOK-EVENT : l'événement déclencheur

  • X-WEBHOOK-KEY : la clé d'authentification de l'événement.

Par exemple :


POST / HTTP/1.1

X-WEBHOOK-EVENT: sales_order_validated

X-WEBHOOK-KEY: dKsZUSiLjyexoelsxExCEuXS8PUKvuJhqiNSDz-C8u4

Content-Type: application/json

User-Agent: HarelSystems HelloHarel/9.2.4



{

    "code": "ORD-20210923-0001",

    [...]

}
Le contenu de la requête du webhook est généralement le même modèle que la représentation GET /api/v1/<entity>/{id} de l'entité.