Principe d'appel SW en mode WebHook

Owned by Bertrand Littel
Last updated: 09/08/2022
2 min read

Disponible depuis le Runtime Harmony 408

Consultez la page suivante Paramétrage SW WebHook pour plus d’informations, notamment sur les pré-requis.

 

(1) CODE WEBHOOK

L’appelant doit nécessairement connaître le code webhook (clé chaîne de caractères) à appeler.

Ce code est indiqué dans le paramétrage des WebHook, via le zoom dédié, accessible depuis le zoom des actions de services (Harmony : Paramétrage / Actions des services ou ERP : Administration / Paramètres / Action des services) en cliquant sur le bouton “Appel du zoom webhook”

A partir de la liste des WebHook, il existe plusieurs manières de récupérer le code webhook :

  • Par recopie du code figurant dans la colonne “Code WebHook”

  • Par clic sur le bouton “Envoi par mail” qui génère un mail contenant les codes, ainsi qu’un mise en pièce jointe

  • Par passage en mode fiche (F4) qui permet de cliquer sur le bouton “Copier dans le presse papier”

    • Attention, le presse papier ne fonctionne pas en mode navigateur

Exemple : MONWEBHOOKACADEMY123456789012363F53

 

(2) URL WEBHOOK

L’URL d’un WebHook est constituée de 3 parties : URL de base de type REST + '/' + Code webhook + ‘?' + Paramètres du webhook selon le service appelé

Et est donc construite ainsi:

[TypeDeConnexion]://[Serveur]:[Port]/[ServiceWebHook]/[MonCodeWebHook]?[Parametres cle1=valeur&cle2=valeur2]

  • La section ServiceWebHook étant sous la forme : base commune de l'URL + '/api/v1/WebHook'

  • La section MonCodeWebHook étant le code webhook récupéré précédemment

  • La section Parametres étant la liste des paramètres envoyés au webhook sous la forme de paramètres Http : cle=valeur ou cle1=valeur1&cle2=valeur2

 

Voici un exemple d’appel d’un webhook qui reçoit 2 paramètres : dos et refreshCustomer

Exemple sur un poste local :

http://localhost:8080/DhsDivaltoServiceDivaApiRest/api/v1/Webhook/MONWEBHOOKACADEMY123456789012363F53?dos=998&refreshCustomer=C0000001

Exemple en Divalto cloud :

https://api.divaltocloud.com/123456/TEST1/api/v1/WebHook/MONWEBHOOKACADEMY123456789012363F53?dos=998&refreshCustomer=C0000001

 

La réponse à un webhook se limite en général à un “400” ou “200” ou “0” pour indiquer que “le message est bien parvenu”, avec un message complémentaire indiquant soit la réussite ou la raison de l'échec.

Un webhook n’a pas pour vocation a retourner des informations

 

Exemple de réponse à cet appel sous Postman (démonstration) :