Changes

no edit summary
Line 2: Line 2:  
<!-- Do NOT edit this section
 
<!-- Do NOT edit this section
 
     Links below are automatically managed by PolyglotBot
 
     Links below are automatically managed by PolyglotBot
     You can edit links on the English source page : Module_Website -->
+
     You can edit links on the English source page : Module_WebHook -->
[[en:Module_Webhook_EN]]
+
[[en:Module_Webhook]]
 
<!-- END interlang links -->
 
<!-- END interlang links -->
   −
{{TemplateDocUser}}
+
{{TemplateDocUserFR}}
 
{{TemplateModFR}}
 
{{TemplateModFR}}
   Line 19: Line 19:       −
= Ajouter une cible =
+
== Ajouter une cible ==
   −
L'ajout de cible est la seule configuration nécessaire pour ce module. Pour ce faire il vous faut aller dans la configuration du module puis de cliquer sur le menu Cible.Ensuite il vous suffit de cliquer sur le plus en haut de la page et de remplir un ou plusieur événement déclenchables et de remplir une URL à qui envoyer un JSON.
+
L'ajout de cible est la seule configuration nécessaire pour ce module. Pour ce faire il vous faut aller dans la configuration du module puis de cliquer sur le menu Cible.Ensuite il vous suffit de cliquer sur le plus en haut de la page et de remplir un ou plusieurs événements déclenchables et de remplir une URL à qui envoyer un JSON. Des informations sur le système de Triggers est disponible sur cette page [[Système_de_Triggers|Système de Triggers]].
   −
= Format du JSON =
+
'''Exemple:'''
 +
 
 +
[[Image:Image of Webhook configuration.png]]
 +
 
 +
= Exécution =
 +
 
 +
Ainsi une fois la configuration effectuée, à chaque fois qu'un événement métier se produit dans Dolibarr pour les triggers définis dans la configuration, un appel sera effectué vers l'URL ciblée. Le message sera un message JSON comme cet exemple :
 +
 
 +
 
 +
<syntaxhighlight lang="json">
 +
{
 +
  "triggercode" : "TRIGGER_CODE",
 +
  "object" : {DolibarrObject}
 +
}
 +
</syntaxhighlight>
 +
 
 +
'''Exemple de message envoyé par Dolibarr lors de l'exécution de l'événement COMPANY_CREATE:'''
    
<syntaxhighlight lang="json">
 
<syntaxhighlight lang="json">
 
{
 
{
   "triggercode" : "ELEMENT DECLANCHEUR",
+
   {
  "object" : "objet dolibarr"
+
    "triggercode":"COMPANY_CREATE",
 +
    "object":
 +
      {
 +
          "id":39,"entity":1,"element":"societe","fk_element":"fk_soc","table_element":"societe","table_element_line":"","ismultientitymanaged":1,
 +
          "import_key":"","array_options":{"options_height":"","options_weight":"","options_prof":"","options_birthdate":false},
 +
          "restrictiononfksoc":1,"context":[],"canvas":"","ref_ext":"","status":"1","country_id":"117","state_id":"0",
 +
          "multicurrency_code":"EUR","note_public":"","note_private":"","comments":[],"name":"Test Webhook",...
 +
      }
 +
  }
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
...