Abonnement aux évènements Webhooks (V6.1)

L’ancrage (hook) consiste à lier un évènement weavy à une URL externe par un système d’abonnement.

Abonnement

Un service externe peut s’abonner à un évènement webhook, 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 on souhaite s’abonner.
hookUrl : URL externe vers laquelle on va envoyer une réponse à chaque fois que l'évènement sera déclenché.

Le endpoint va renvoyer des données qui serviront éventuellement à se désabonner par la suite :

{
  "result": {
    "codeWebhookSubscription": "mySubscriptionCode"
  }
}

Désabonnement

Pour se désabonner, le principe est le même en appelant le endpoint EPT_WebhookUnsubscribe en spécifiant le code récupéré lors de l’abonnement à l'évènement :

{
  "codeWebhookSubscription": "mySubscriptionCode"
}

PerformList

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 tels 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.

Liste des évènements WebHook standards

NewCustomer
Déclenché lors de la création d’un client coté weavy.
Structure des données envoyées par un exemple :
NewProspect
Déclenché lors de la création d’un prospect coté weavy.
Structure des données envoyées par un exemple :
NewSuspect
Déclenché lors de la création d’un suspect coté weavy.
Structure des données envoyées par un exemple :
NewSubcontractor
Déclenché lors de la création d’un sous-traitant coté weavy.
Structure des données envoyées par un exemple :
NewDeal
Déclenché lors de la création d’une affaire coté weavy.
Structure des données envoyées par un exemple :
NewOpportunity
Déclenché lors de la création d’une opportunité coté weavy.
Structure des données envoyées par un exemple :