1 Introduction
2 Entête
- 2.1 Structure
- 2.2 verb PUT
  - 2.2.1 Généralités
  - 2.2.2 PUT par lot
  - 2.2.3 Transcodage
- 2.3 verb DELETE
- 2.4 verb GET
- 2.5 verb LIST
- 2.6 verb DEFINITION
3 Réponse
- 3.1 Structure
- 3.2 verb PUT
- 3.3 verb DELETE
- 3.4 verb GET
- 3.5 verb LIST
- 3.6 verb DEFINITION

Introduction

Les webhooks Métier permettent de manipuler une entité (client, contact, ...) à partir de l'extérieur via un appel de type http.
Les webhooks Métier implémentent une structure commune de leur contrat JSON.

Entête

Structure

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)      
   }
}

verb PUT

Généralités

Permet d'écrire un enregistrement (Ajout/Mise à jour).

"action":
{
    "verb": "PUT"
    "parameters":
    {
      "simulation": "value" // optional, simulates if recording is possible (0 or 1)
      
      // for webhook file
      "entity": "value",
      "extension": "value"
           
      "settings": 
        {
            // depends of the webhook (optional)
        }
    }
}

Le bloc data contient 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",
        ....
    }
}

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 s'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)

PUT par lot

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",
        ....
    }
},
{
    ....
}]

Transcodage

Le champ mémoire “internalcodexxxxx” peut être alimenté lors du passage des données.

Ce champ représente le code original de weavy avant éventuel transcodage.

Il permet donc d’effectuer du transcodage dynamique directement par le webhook.

Syntaxe :

"data":
{
    "xxxxx":
    {
        "codexxxxx": "value",
        "field1": "value",
        "field2": "value",        
        ....
        "internalcodexxxxx" : "value" 
    }
}

Tableau des possibilités :

"codexxxxx" = "A"	"internalcodexxxxx" = "B"	Résultat

"codexxxxx" = "A"	"internalcodexxxxx" = "B"	Résultat
"codexxxxx" = "A" existe en base	"codexxxxx" = "B" n’existe pas en base	Mise à jour de l'enregistrement dont "codexxxxx" = "A"
"codexxxxx" = "A" existe en base	"codexxxxx" = "B" existe en base	Mise à jour de l’enregistrement dont "codexxxxx" = "A"
"codexxxxx" = "A" n'existe pas en base	"codexxxxx" = "B" n’existe pas en base	Création de l’enregistrement avec "codexxxxx" = "A"
"codexxxxx" = ""	"codexxxxx" = "B" n’existe pas en base	Création de l’enregistrement avec "codexxxxx" = xxxxx_ID
"codexxxxx" = "A" n'existe pas en base	"codexxxxx" = "B" existe en base	Recodification de l’enregistrement "codexxxxx" = "B" en "codexxxxx" = "A" + mise à jour
"codexxxxx" = ""	"codexxxxx" = "B" existe en base	Mise à jour de l’enregistrement dont "codexxxxx" = "B"

verb DELETE

Permet de supprimer un enregistrement.

"action":
{
    "verb": "DELETE"
    "parameters": 
    {
        "code": code of the record to delete (mandatory)
        "deleteType": 
          "logical": no real delete in db (by default - not implemented at time)
          "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 GET

Permet de lire un enregistrement.

"action":
{
    "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 LIST

Permet de lister plusieurs enregistrements.

La variable Webhook.LIST.ElementPerPage défini le nombre d'éléments à retourner par page (par défaut : 10).

"action":
{
    "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 (variable Webhook.LIST.ElementPerPage) (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 (optional), each filter added will result is an AND in the query
            // For a filter operator "equal" it is possible to give more values separated by "|" (ie "email": "email1|email2|email3")
            // For a filter operator "equal" it is possible to give the value "null" who will be transformed in "IS NULL"
        }
        "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

Permet d’obtenir les propriétés de l'objet métier ainsi que les listes de valeurs possibles associées.

"action":
{
    "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.
    }
}

Réponse

Structure

{
    "label": "Webhook xxx", //name of the called webhook
    "codeScript": "Webhookxxx", //script called by the webhook
    "resultType": "JSON",
    "result":
    {
        "common":
        {
            "resultCode": "0", // 0 if ok otherwise specific error of the webhook
            "errorMessage": "" // if resultCode <> 0, text of the error in english
        },
        "response":
        {
            // depends of the webhook
        }
    },
    "statistics": 
    {
        "durationMs": xx, // duration of execution time
        "consumedTimeOnDatabaseMs": xx, // DB time used
        "selectQueryCount": xx, // number of select query done
        "insertQueryCount": xx, // number of insert query done
        "updateQueryCount": xx, // number of update query done
        "deleteQueryCount": xx, // number of delete query done
        "readTokenCount": xx, 
        "executedFunctionCount": xx, // number of function called
        "translatorHitCount": xx, // number of translations done
        "languageHitCount": xx 
    }    
}

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
        },
        "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"
            }]
        }
    },
    {
        ...
    }]
}

verb DELETE

La réponse aura 1 section.

"response": 
{
    "data": 
    [{
        "action": "deleted"
    }]
}

verb GET

La réponse aura 2 sections.

"response":
{
    "data":
    [{ 
        // depends of the webhook
    }],
    "fieldList": 
    [{
        "entityName": "value", // name of the entity (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": // for listType = "extendedRelated"
        [{
            "entityName": "value",
            "fields":
            [{
                ...
            }]
            },
        {
            "entityName": "value",
            "fields":
            [{
                ...
            }]
        },
        {
            ...  
        }]
    }] 
}

verb LIST

La réponse aura 2 sections.

"response":
{
    "maxPageNumber": xx, // number of pages of records
    "pageSize": 10, // number of records per page
    "data":
    [{ 
        // depends of the webhook
    }],
    "fieldList": 
    [{
        "entityName": "value", // name of the entity (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"
        },
        {
            ...
        }],
    }]
}

verb DEFINITION

La réponse aura 2 sections.

"response":
{
    "data":
    [{ 
        "fieldName1":
        [{
            "code": "value",
            "label": "value"
        },
        {
            "code": "value",
            "label": "value"
        },
        {
            ...
        }
        }],
        "fieldName2":
        [{
            "code": "value",
            "label": "value"
        },
        {
            "code": "value",
            "label": "value"
        },
        {
            ...
        }
        }],
        ...
    }],
    "fieldList": 
    [{
        "entityName": "value", // name of the entity (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)
            "cannotBeNull": "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",
            "cannotBeNull": "value",
            "dataType": "value"
        },
        {
            ...
        }],
        "related":
        [{
            "entityName": "value",
            "fields":
            [{
                ...
            }]
        },
        {
            "entityName": "value",
            "fields":
            [{
                ...
            }]
        },
        {
            ...  
        }]
    }]
}

06 CRM 6.2

WebHooks Généralités

Introduction

Entête

Structure

verb PUT

Généralités

PUT par lot

Transcodage

verb DELETE

verb GET

verb LIST

verb DEFINITION

Réponse

Structure

verb PUT

verb DELETE

verb GET

verb LIST

verb DEFINITION