Déclaration webhook

Dans Divalto weavy Studio : Outils > Gérer les webhooks

Webhook

Le webhook ne nécessite aucune authentification mais doit être lié à un compte API public.

Son URL d’appel sera de la forme : https://api.weavy.divalto.com/v1/entrypoints/{companyCode}/webhook/?c={codeEntryPoint}

Code utilisateur : Code du webhook

Lors de la création d’un webhook spécifique, il est conseillé d’utiliser un code utilisateur bien identifiable.

Les webhooks n'étant pas surchargeables, ceci permettra d’identifier correctement les webhooks standards des webhooks spécifiques.

Libellé : Libellé du webhook

Description : Description

Code script : Code du script qui sera appelé lors de l’exécution du webhook

Compte API : Compte utilisateur de type API publique qui sera utilisé pour l’authentification

URL : Url qui permettra d’appeler le webhook

Process

C’est l'équivalent du webhook, mais le process nécessite une authentification préalable avec un compte utilisateur valide.

Les scripts utilisés seront exactement pareils, il n’y a aucune différence entre un webohook et un process.

Son URL d’appel sera de la forme : https://api.weavy.divalto.com/v1/entrypoints/{companyCode}/process/?c={userCode}

Code utilisateur : Code du process

Lors de la création d’un process spécifique, il est conseillé d’utiliser un code utilisateur bien identifiable.

Les process n'étant pas surchargeables, ceci permettra d’identifier correctement les process standards des process spécifiques.

Libellé : Libellé du process

Description : Description

Code script : Code du script qui sera appelé lors de l’exécution du process. C’est exactement le même script que pour un webhook.

Compte API : On utilisera automatiquement le compte utilisé pour l’authentification

URL : Url qui permettra d’appeler le process

Présentation

Lors de la création d’un nouveau webhooks, cinq scripts sont obligatoires.

Des exemple précis seront données dans la suite de ce document.

Script d’entrée : Ce script est appelé dans la déclaration du webhook.

Le code du script devra être de la forme : {Prefix}_Webhook{EntityName}

Script de définition : C'est dans ce script que l'on déclare la définition de l'entité. C'est une "carte d'identité" qui va définir les champs, les filtres, etc...

Le code du script devra être de la forme : {Prefix}_WebhookDefinition_{entityname}.

Script de surcharge de définition : Il est obligatoire même pour un webhook spécifique.

Le code du script devra être de la forme : {Prefix}_WebhookDefinitionOverload_{entityname}.

Script de règles : C’est dans ce script que l’on applique les règles métiers. Ces règles s’appliqueront lors de la méthode PUT (ajout/mise à jour).

Le code du script devra être de la forme : {Prefix}_WebhookRules_{entityname}

Script de surcharge de règles : Il est obligatoire même pour un webhook spécifique.

Le code du script devra être de la forme : {Prefix}_WebhookRulesOverload_{entityname}

Créer webhook sur table standard

FINAL_WebhookSupplier

FINAL_WebhookDefinition_supplier

FINAL_WebhookDefinitionOverload_supplier

FINAL_WebhookRules_supplier

FINAL_WebhookRulesOverload_supplier

Créer webhook sur table spécifique

FINAL_WebhookSupplierAddress

FINAL_WebhookDefinition_final_supplieraddress

FINAL_WebhookDefinitionOverload_final_supplieraddress

FINAL_WebhookRules_final_supplieraddress

FINAL_WebhookRulesOverload_final_supplieraddress

Compléter webhook existant

FINAL_WebhookDefinition_interventionoperationrange

FINAL_WebhookDefinition_interventionoperationtype