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é.
...
Bloc de code |
---|
{ "event": "myEvent", "hookUrl": "callbackExternalUrl" } |
event : Evènement auquel l’on on souhaite s’abonner.
hookUrl : URL externe vers laquelle on va envoyer une réponse à chaque fois que le trigger l'évènement sera déclenché.
Le endpoint va renvoyer des données qui serviront éventuellement à se désabonner par la suite :
Bloc de code |
---|
{ "result": { "codeWebhookSubscription": "mySubscriptionCode" } } |
Désabonnement
Pour se désabonner, le principe est le même en appelant le endpoint EPT_WebhookUnsubscribe avec les paramètres suivant en spécifiant le code récupéré lors de l’abonnement à l'évènement :
Bloc de code |
---|
{ "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 tel 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.
Bloc de code |
---|
{ "event": "myEvent" } |
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 :
Bloc de code { "result": { "codecustomer": "1143-00004COLOMB", "name": "DivaltoCOLOMBE DIAMANTS", "address1": "11, rue IcareRue Maurice Barres ", "address2": "", "address3": "", "postalCode": "6796078000", "city": "EntzheimVERSAILLES", "phoneNumber": "0388645060111220520", "faxNumber": "133220520", "mobilePhoneNumber": "611220520", "email": "contact@divaltocontact@soc.com", "country": "FRFRANCE", "province": "", "codeBaseCulture": "FR-FR", "civility": "", "type": "Customer", "branchOfficeName": "Agence-01", "userName": "ClaudeVincent TENARDIERMOREL", "url": "https://weavy.divalto.com/page/customer/1143000000000420000000080" } }
NewProspect
Déclenché lors de la création d’un prospect coté weavy.Structure des données envoyées par un exemple :
Bloc de code { "result": { "codecustomer": "1143-000042010000000015", "name": "DivaltoOLYMPIQUE DE MARSEILLE", "address1": "1133, TERRASSE DE rueLA IcareMARTINE", "address2": "CTRE ENTRAINEMENT ROBERT LOUIS DREYFUS", "address3": "", "postalCode": "6796013012", "city": "EntzheimMARSEILLE 12", "phoneNumber": "0388645060", "faxNumber": "", "mobilePhoneNumber": "", "email": "contact@divalto.com", "country": "FRFRANCE", "province": "", "codeBaseCulture": "", "civility": "", "type": "CustomerProspect", "branchOfficeName": "", "userName": "ClaudeFrédéric TENARDIERDUBOIS", "url": "https://weavy.divalto.com/page/customer/114300000000042010000000015" } }
NewSuspect
Déclenché lors de la création d’un suspect coté weavy.Structure des données envoyées par un exemple :
Bloc de code { "result": { "codecustomer": "1143201-0000400035", "name": "Divaltoassurance plus ", "address1": "11,1 rue Icaredes cigognes ", "address2": "", "address3": "", "postalCode": "679606700", "city": "Entzheimstrasbourg", "phoneNumber": "0388645060", "faxNumber": "", "mobilePhoneNumber": "", "email": "contact@divalto.com", "country": "FR", "province": "", "codeBaseCulture": "", "civility": "", "type": "CustomerSuspect", "branchOfficeName": "", "userName": "ClaudeFrédéric TENARDIERDUBOIS", "url": "https://weavy.divalto.com/page/customer/114300000000042010000000035" } }
NewSubcontractor
Déclenché lors de la création d’un sous-traitant coté weavy.Structure des données envoyées par un exemple :
Bloc de code { "result": { "codecustomer": "1143-000046030000000012", "name": "DivaltoST DIVALTO", "address1": "11, rue Icare", "address2": "", "address3": "", "postalCode": "6796067100", "city": "EntzheimStrasbourg", "phoneNumber": "0388645060", "faxNumber": "", "mobilePhoneNumber": "", "email": "contact@divalto.com", "country": "FRFRANCE", "province": "", "codeBaseCulture": "", "civility": "", "type": "CustomerSubcontractor", "branchOfficeName": "", "userName": "Claude TENARDIERCoordinateur de services 1 BO", "url": "https://weavy.divalto.com/page/customer/114300000000046030000000012" } }
NewDeal
Déclenché lors de la création d’une affaire coté weavy.
Structure des données envoyées par un exemple :Bloc de code { "result": { "codedeal": "6730000000002", "customerName": "A1C1", "label": "Vitrine de Noel 2023", "type": "Deal type 1", "dealNumber": "", "status": "Drafting", "creationDate": "2023-09-22 12:05:40", "url": "https://weavy.divalto.com/page/deal/6730000000002" } }
NewOpportunity
Déclenché lors de la création d’une opportunité coté weavy.
Structure des données envoyées par un exemple :Bloc de code { "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" } }
...