Un service externe peut s’abonner à un évènement, de sorte à recevoir une requête HTTP contenant des données à chaque fois que l'évènement est déclenché.
Pour cela il suffit d’appeler le endpoint EPT_WebhookSubscribe ( https://api.weavy.divalto.com/v1/EntryPoints/{{projectCode}}/process/?c=EPT_WebhookSubscribe )
avec un Bearer token de connexion valide dans la partie headers et un body composé de
{
"event": "myEvent",
"hookUrl": "callbackExternalUrl"
}
event : Evènement auquel l’on souhaite s’abonner.
hookUrl : URL externe vers laquelle on va envoyer une réponse à chaque fois que le trigger sera déclenché.
Le endpoint va renvoyer des données qui serviront éventuellement à se désabonner par la suite :
{
"result": {
"codeWebhookSubscription": "mySubscriptionCode"
}
}
Pour se désabonner, le principe est le même en appelant le endpoint EPT_WebhookUnsubscribe avec les paramètres suivant :
{
"codeWebhookSubscription": "mySubscriptionCode"
}
Il existe également un troisième endpoint lié aux abonnements webhook, EPT_WebhookPerformList, qui est utilisé par un service distant pour récupérer des échantillons de données de test tel qu’ils seront envoyés par le hook, permettant ainsi de tester à la demande les données renvoyées sans avoir à déclencher l'évènement manuellement.
{
"event": "myEvent"
}
Liste des évènements WebHook standards
NewOpportunity.
Déclenché lorsqu’une opportunité est créée coté weavy.
Exemple de donnée envoyées :{ "result": { "codedeal": "2010000000014", "customerName": "A L'ATELIER DE DIJON", "label": "Ma nouvelle opportunité", "type": "Appel d'offres", "dealNumber": "", "status": "Active", "creationDate": "2023-10-31 00:00:00", "url": "https://weavy.divalto.com/page/project/2010000000014" } }