...
| Sommaire |
|---|
Introduction
Ce document décrit la création de webhooks spécifiques.
Avant de créer vos propres webhooks, il est conseillé de lire l’ensemble des documents présents dans le chapitre WebHooks.
Et tout particulièrement de bien comprendre le document sur les Surcharges.
Déclaration webhooks
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.
...
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.
...
URL : Url qui permettra d’appeler le process
Présentation
Lors de la création d’un nouveau webhook, cinq scripts sont obligatoires.
...
Vous pouvez vous contenter de la trame de base, vu que vos règles seront déjà dans le script de règles.
Créer webhook sur une table standard
Création d’un nouveau webhook sur la table standard “sw_data_supplier” qui contient des champs spécifiques en surcharge FINAL.
On peut voir également que le champ “final_suppliercategory_ID” s’appuie sur une table spécique spécifique “sw_data_final_suppliercategory”.
...
Pour la mise à jour de “sw_data_final_supplieraddress“, une description est donnée dans le chapitre sur la création d’un webhook sur une table spécifique.
Pour l’affiche des données liées dans “sw_data_final_suppliercategory“, il faut donc au minimum également ajouter les deux scripts de définition de cette table.
Script de définition : FINAL_WebhookDefinition_final_suppliercategory :
| Bloc de code | ||
|---|---|---|
| ||
// FINAL_WebhookDefinition_final_suppliercategory
// Webhook definition
tableName = "final_suppliercategory"
specificOverload = CALL_SCRIPT( "FINAL_WebhookDefinitionOverload_<varscript>tableName</varscript>" )
tableSchema = DB_GET_TABLEINFO( "sw_data_<varscript>tableName</varscript>" )
tableSchemaDocument = DOCUMENT_CREATE_FROM_JSON( tableSchema )
languageCode = VARGET_SHELL( "languageCode", "WebhookDefinition" )
authorizedTables = TRANSLATE( "[{'tableName':'<varscript>tableName</varscript>'}]" )
JSONFieldsDefinition = TRANSLATE( "
{
'languageCode': '<varscript>languageCode</varscript>',
'strictFilterMode': 1,
'relatedTablesCount': 0,
'relatedTables': [ ],
'authorizedTables': <varscript>authorizedTables</varscript>,
'simpleFieldsList': 'CodeSupplier,label',
'extendedFieldsListToExclude': '',
'defaultFilters': [
],
'strictFilters': [
],
'strictOrderBy': [
],
'outOfMainTableFields': [
],
'standardOverload': {
},
'specificOverload':
<varscript>specificOverload</varscript>,
'simpleFields': [],
'extendedFields': [],
'strictFilterFields': [],
'defaultFilterFields': [],
'strictOrderByFields': []
}
" )
INCLUDE( "FuncWebhook_BuildDefinition" ) |
Script de surcharge de définition : FINAL_WebhookDefinitionOverload_final_suppliercategory :
| Bloc de code | ||
|---|---|---|
| ||
// FINAL_WebhookDefinitionOverload_suppliercategory
languageCode = VARGET_SHELL( "languageCode", "WebhookDefinition" )
specificOverload = TRANSLATE( "
{
'extendedFieldsListToExclude': '',
'fieldsList': {
},
strictFilters: [
],
'strictOrderBy': [
],
'outOfMainTableFields': [
]
}
" )
RETURN( "<varscript>specificOverload</varscript>" ) |
Créer webhook sur une table standard si scripts déjà existants
Création d’un nouveau webhook sur la table standard “sw_data_symptom”.
...
| Bloc de code | ||
|---|---|---|
| ||
// FINAL_WebhookRulesOverload_symptom code = TRANSLATE( "<varscript>arg1</varscript>" ) verb = TRANSLATE( "<varscript>arg2</varscript>" ) dataInput = TRANSLATE( "<varscript>arg3</varscript>" ) ruleFields = TRANSLATE( "<varscript>arg4</varscript>" ) jsonResponse = DOCUMENT_CREATE_DOCUMENT() response = DOCUMENT_SERIALIZE( jsonResponse, "json" ) RETURN( response ) |
| Ancre | ||||
|---|---|---|---|---|
|
Création d’un nouveau webhook sur la table spécifique “sw_data_final_supplieraddress”.
...
| Bloc de code | ||
|---|---|---|
| ||
// FINAL_WebhookRulesOverload_final_supplieraddress code = TRANSLATE( "<varscript>arg1</varscript>" ) verb = TRANSLATE( "<varscript>arg2</varscript>" ) dataInput = TRANSLATE( "<varscript>arg3</varscript>" ) ruleFields = TRANSLATE( "<varscript>arg4</varscript>" ) jsonResponse = DOCUMENT_CREATE_DOCUMENT() response = DOCUMENT_SERIALIZE( jsonResponse, "json" ) RETURN( response ) |
Compléter webhook existant
...
pour mise à jour
Sur le webhook “Intervention” pour la méthode PUT, je veux également mettre à jour des données concernant les opérations.
Ceci va concerner les tables “sw_data_interventionoperationrange“ et “sw_data_interventionoperationtype“.
Script de définition : FINAL_WebhookDefinition_interventionoperationrangeFINAL_WebhookDefinition_interventionoperationtype WebhookDefinition_intervention
Le script de définition “WebhookDefinition_intervention“ existe déjà en standard. Donc on y touche pas.
Script de surcharge de définition : WebhookDefinitionOverload_intervention
Le script de surcharge de définition “WebhookDefinitionOverload_intervention“ est déjà prévu en standard. Il suffit donc de surcharger ce script.
On reprend la propriété “authorizedTables“ du standard, complétée avec les 2 nouvelles tables.
| Bloc de code | ||
|---|---|---|
| ||
// WebhookDefinitionOverload_intervention
languageCode = VARGET_SHELL( "languageCode", "WebhookDefinition" )
specificOverload = TRANSLATE( "
{
'extendedFieldsListToExclude': '',
'authorizedTables': [{'tableName':'intervention'}, {'tableName':'interventionequipment'}, {'tableName':'interventionpart'}, {'tableName':'interventionoperationrange'}, {'tableName':'interventionoperationtype'}],
'fieldsList': {
},
strictFilters: [
],
'strictOrderBy': [
],
'outOfMainTableFields': [
]
}
" )
RETURN( "<varscript>specificOverload</varscript>" ) |
Complément :
Il faut au minimum créer les scripts de définition pour “interventionoperationrange“ et “interventionoperationtype“ vu qu’ils n’existent pas en standard.
Script de définition : FINAL_WebhookDefinition_interventionoperationrange
| Bloc de code | ||
|---|---|---|
| ||
// FINAL_WebhookDefinition_interventionoperationrange
tableName = "interventionoperationrange"
specificOverload = CALL_SCRIPT( "FINAL_WebhookDefinitionOverload_<varscript>tableName</varscript>" )
tableSchema = DB_GET_TABLEINFO( "sw_data_<varscript>tableName</varscript>" )
tableSchemaDocument = DOCUMENT_CREATE_FROM_JSON( tableSchema )
languageCode = VARGET_SHELL( "languageCode", "WebhookDefinition" )
authorizedTables = TRANSLATE( "[{'tableName':'<varscript>tableName</varscript>'}]" )
JSONFieldsDefinition = TRANSLATE( "
{
'languageCode': '<varscript>languageCode</varscript>',
'strictFilterMode': 1,
'relatedTablesCount': 0,
'relatedTables': [ ],
'authorizedTables': <varscript>authorizedTables</varscript>,
'simpleFieldsList': '',
'extendedFieldsListToExclude': '',
'defaultFilters': [
],
'strictFilters': [
],
'strictOrderBy': [
],
'outOfMainTableFields': [
],
'standardOverload': {
},
'specificOverload':
<varscript>specificOverload</varscript>,
'simpleFields': [],
'extendedFields': [],
'strictFilterFields': [],
'defaultFilterFields': [],
'strictOrderByFields': []
}
" )
INCLUDE( "FuncWebhook_BuildDefinition" ) |
Script de surcharge de définition : FINAL_WebhookDefinitionOverload_interventionoperationrange
| Bloc de code | ||
|---|---|---|
| ||
// FINAL_WebhookDefinitionOverload_interventionoperationrange
languageCode = VARGET_SHELL( "languageCode", "WebhookDefinition" )
specificOverload = TRANSLATE( "
{
'extendedFieldsListToExclude': '',
'fieldsList': {
},
strictFilters: [
],
'strictOrderBy': [
],
'outOfMainTableFields': [
]
}
" )
RETURN( "<varscript>specificOverload</varscript>" ) |
Script de définition : FINAL_WebhookDefinition_interventionoperationtype
| Bloc de code | ||
|---|---|---|
| ||
// FINAL_WebhookDefinition_interventionoperationtype
tableName = "interventionoperationtype"
specificOverload = CALL_SCRIPT( "FINAL_WebhookDefinitionOverload_<varscript>tableName</varscript>" )
tableSchema = DB_GET_TABLEINFO( "sw_data_<varscript>tableName</varscript>" )
tableSchemaDocument = DOCUMENT_CREATE_FROM_JSON( tableSchema )
languageCode = VARGET_SHELL( "languageCode", "WebhookDefinition" )
authorizedTables = TRANSLATE( "[{'tableName':'<varscript>tableName</varscript>'}]" )
JSONFieldsDefinition = TRANSLATE( "
{
'languageCode': '<varscript>languageCode</varscript>',
'strictFilterMode': 1,
'relatedTablesCount': 0,
'relatedTables': [ ],
'authorizedTables': <varscript>authorizedTables</varscript>,
'simpleFieldsList': '',
'extendedFieldsListToExclude': '',
'defaultFilters': [
],
'strictFilters': [
],
'strictOrderBy': [
],
'outOfMainTableFields': [
],
'standardOverload': {
},
'specificOverload':
<varscript>specificOverload</varscript>,
'simpleFields': [],
'extendedFields': [],
'strictFilterFields': [],
'defaultFilterFields': [],
'strictOrderByFields': []
}
" )
INCLUDE( "FuncWebhook_BuildDefinition" ) |
Script de surcharge de définition : FINAL_WebhookDefinitionOverload_interventionoperationtype
| Bloc de code | ||
|---|---|---|
| ||
// FINAL_WebhookDefinitionOverload_interventionoperationtype
languageCode = VARGET_SHELL( "languageCode", "WebhookDefinition" )
specificOverload = TRANSLATE( "
{
'extendedFieldsListToExclude': '',
'fieldsList': {
},
strictFilters: [
],
'strictOrderBy': [
],
'outOfMainTableFields': [
]
}
" )
RETURN( "<varscript>specificOverload</varscript>" ) |