Les webhook Métier permettent de manipuler une entité (client, contact, ...) à partir de l'extérieur via un appel de type http.
Les webhook Métier implémente une structure commune de leur contrat JSON.
Entête
Le JSON lors de l'appel au webHook devra contenir les éléments suivants :
{
"header":
{
"caller": how called the webhook ie.: infinity
"callerVersion": version of the caller ie. 1.2.3.4
"languageCode": FR, EN, DE, PT, ES, IT, FR-CA, EN-CA
"userCode": user how called the webhook
"callDateTime": initial call date/time, usefull when retries or whatever network issue
"markForExport": value for srvExport of the table, can be 0, 1, 2 (optional, default is 1)
"webhookVersion": version of the webhook for top-down compatibility, can be 1 or 2 (optional, default is 2). Today is used for webhook intervention, equipment and contract.
},
"action":
{
"verb": "value", // GET, PUT, DELETE, LIST, DEFINITION
"parameters": //depends on the verb
{
}
},
"data":
{
depends on the webhook (used for verb = PUT to insert/update the data)
}
}
Avec les possibilités suivantes selon le verb :
GET : lire un enregistrement
PUT : écrire un enregistrement
DELETE : supprimer un enregistrement
LIST : lister plusieurs enregistrements
DEFINITION : obtenir les propriétés de l'objet métier ainsi que les listes de valeurs possibles associées
"verb": GET
"parameters":
{
"code": code of the record to get (mandatory)
"resultType":
"simple" : main info of the record (by default)
"extended": all columns of the record
"extendedRelated": all columns of the record + given context (one entity per foreign key)
"settings": depends of the webhook (optional)
{
}
}
"verb": PUT
"parameters":
{
// for webhook file
"entity": "value",
"extension": "value"
}
"verb": DELETE (V1: delete only record at a time)
"parameters":
{
"code": code of the record to delete (mandatory)
"deleteType":
"logical": no real delete in db (by default)
"physical": real delete, possible if record is not referred to elsewhere
"simulation": simulate the delete (can be used to know in advance if a record can be deleted)
}
"verb": LIST
"parameters":
{
"listType":
"simple": main info of the record (by default), the columns are determined by each webhook
"extended": all columns of the record
"extendedRelated": not used for verb=LIST
"pageNumber": "xx" // used to read the page of the records list, 1 page = 10 records (optional, default pageNumber is 1)
You can read the list page per page until maxPageNumber (result of maxPageNumber given in the "response")
"settings": depends of the webhook (optional)
{
}
"filters": depends of the webhook called here, not mandatory, each filter added will result is an AND in the query (for example intervention)
For a filter operator "equal" it is possible to give more values separated by "|" (ie "email": "email1|email2|email3")
{
"codeIntervention": "value", filter is equal
"codeCustomer": "value", filter is equal
"codeContract": "value", filter is equal
"startDate": "value", filter is greater or equal to
"endDate": "value", filter is lesser or equal to
"interventionType": "value", filter is equal
}
"orderBy" : "value" // depends of the webhook (optional), order the returned records (for example webhook event, the value can be "eventDateDesc" to order the records by event date descending)
"topRows": "xx" // limit the returned records (optional)
}
"verb": DEFINITION
"parameters":
{
"baseculture_id": "value" // (optional) Culture to use to return labels. If not given, the LanguageCode of the header will be used by default.
}
Pour le verb PUT il faut alimenter le bloc data qui contiendra les données à créer/mettre à jour. Ce bloc est différent pour chaque webhook. Consultez la fiche expert de chaque webhook pour le détail.
"data":
{
"xxxxx":
{
"codexxxxx": "value", // optional
"field1": "value",
"field2": "value",
....
}
}
La possibilité est donné de faire des PUT par LOT en passant un tableau de data.
La variable Webhook.PUT.MaxElementAtOnce défini le nombre maximum d'éléments qui peuvent être passés à la fois (par défaut : 10). Ceci permet de tenir compte du timeout réseau.
"data":
[{
"xxxxx":
{
"codexxxxx": "value", // optional
"field1": "value",
"field2": "value",
....
}
},
{
"xxxxx":
{
"codexxxxx": "value", // optional
"field1": "value",
"field2": "value",
....
}
},
{
....
}]
L'initialisation du code d'un enregistrement se fera par ordre de priorité de la manière suivante lors de la création :
Code fourni dans le json (et qu'il n'existe pas encore sinon on sera en modification)
Utilisation du numbering si existant sur le code de l'entité.
Code = ID de l'enregistrement (codexxxxx = xxxxx_ID)
Réponse
Standard response of a webhook:
{
"label": "Webhook Intervention", //name of the called webhook
"codeScript": "WebhookIntervention", //script called by the webhook
"resultType": "JSON",
"result": "see below",
"statistics": {
"durationMs": 1360, //duration of execution time
"consumedTimeOnDatabaseMs": 990, //DB time used
"selectQueryCount": 3, //number of select query done
"insertQueryCount": 0, //number of insert query done
"updateQueryCount": 0, //number of update query done
"deleteQueryCount": 0, //number of delete query done
"readTokenCount": 1842,
"executedFunctionCount": 258, //number of function called
"translatorHitCount": 552, //number of translations done
"languageHitCount": 0
}
}
Détail du résultat :
"result":
{
"common":
{
"resultCode": "0", //0 if ok otherwise specific error of the webhook
"errorMessage": "" //if resultCode <>0, text of the error in english (V1)
},
"response":
{
depends on the webhook
}
}
Pour le verb PUT, la réponse aura 1 section :
"response":
{
"maxElementAtOnce": "10" // max elements that can be passed at once
"data":
[{
"action": "value", // inserted or updated
"xxxxx_ID": "value", // with xxxxx = table and value is ID created/updated
"codexxxxx": "value" // with xxxx = table and value is code created/updated
}]
}
S'il s'agit d'un PUT par lot, le détail du résultat sera un tableau dimensionné selon la section "data" passée en entrée :
"result":
{
"results":
[{
"common":
{
"resultCode": "0", //0 if ok otherwise specific error of the webhook
"errorMessage": "" //if resultCode <>0, text of the error in english (V1)
},
"response":
{
"maxElementAtOnce": "10" // max elements that can be passed at once
"data":
[{
"action": "value", // inserted or updated
"xxxxx_ID": "value", // with xxxxx = table and value is ID created/updated
"codexxxxx": "value" // with xxxx = table and value is code created/updated
}]
}
},
{
"common":
{
"resultCode": "0",
"errorMessage": ""
},
"response":
{
"maxElementAtOnce": "10" // max elements that can be passed at once
"data":
[{
"action": "value",
"xxxxx_ID": "value",
"codexxxxx": "value"
}]
}
},
{
...
}]
}
Pour le verb DELETE, la réponse aura 1 section :
"response":
{
"data":
[{
"action": "deleted"
}]
}
Pour le verb LIST ou GET, la réponse aura 2 sections :
"response":
{
"maxPageNumber": xx, // verb=LIST : number of pages of records
"pageSize": 10, // verb=LIST : number of records per page
"data":
[{ depends of the webhook}],
"fieldList":
[{
"entityName": "value", // name of the table (ie intervention)
"fields":
[{
"fieldName": "value", // name of the field (ie codeintervention, customer_ID, …)
"fieldType": "value", // type of the field : varchar, text, int, double, bool, datetime, timestamp, foreignkey
"fieldLength": "value", // length of the field : informed for varchar, text
"fieldLabel": "value" // label of the field : depends on the value of the languageCode from the header (default : FR)
},
{
"fieldName": "value",
"fieldType": "value",
"fieldLength": "value",
"fieldLabel": "value"
},
{
...
}],
"related":
[{
"entityName": "value",
"fields":
[{
...
}]
},
{
"entityName": "value",
"fields":
[{
...
}]
},
{
...
}]
}]
Pour le verb DEFINITION, la réponse aura 2 sections :
"response":
{
"data":
[{ depends of the webhook}],
As an example for contact
"generictype_ID_civility":
[{
"code": "CIVILITY-MR",
"label": "Mister"
},
{
"code": "CIVILITY-MME",
"label": "Madame"
},
{
"code": "CIVILITY-MRS",
"label": "Miss"
}],
"fieldList":
[{
"entityName": "value", // name of the table (ie intervention)
"fields":
[{
"fieldName": "value", // name of the field (ie codeintervention, customer_ID, …)
"fieldType": "value", // type of the field : varchar, text, int, double, bool, datetime, timestamp, foreignkey
"fieldLength": "value", // length of the field : informed for varchar, text
"fieldLabel": "value", // label of the field : depends on the value of the languageCode from the header (default : FR)
"fieldNameToShow": "value", // field alias for GET and LIST
"alias": "value", // field alias for PUT
"canGet": "value", // field can be read (0, 1)
"canInsert": "value", // field can be updated for a new record (0, 1)
"canUpdate": "value", // field can be updated for a existing record (0, 1)
"mandatory": "value", // field is mandatory in sent json (0, 1)
"canotBeNull": "value", // field cannot be null or empty in sent json (0, 1)
"dataType": "value" // data type for generictype foreignkey field
},
{
"fieldName": "value",
"fieldType": "value",
"fieldLength": "value",
"fieldLabel": "value",
"fieldNameToShow": "value",
"alias": "value",
"canGet": "value",
"canInsert": "value",
"canUpdate": "value",
"mandatory": "value",
"canotBeNull": "value",
"dataType": "value"
},
{
...
}],
"related":
[{
"entityName": "value",
"fields":
[{
...
}]
},
{
"entityName": "value",
"fields":
[{
...
}]
},
{
...
}]
}]