Module Webhook FR

Introduction

Le module WebHook ajoute la possibilité d'envoyer un message JSON suite à un évenement trigger de Dolibarr.

Installation

Ce module est livré en standard avec la distribution de Dolibarr, aussi il est déjà installé.

Configuration

Pour utiliser ce module, il vous faut d'abord l'activer. Pour cela, après s'être connecté avec un compte administrateur, aller sur la page "Accueil - Configuration - Modules".

Choisissez l'onglet dans lequel apparaît le module puis cliquez sur "Activer".

Le module est alors activé.

Si un pictogramme apparaît sur la vignette ou à la fin de la ligne du module, cliquez dessus pour accéder à la page de paramétrage spécifique à ce module.

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 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.

Exemple:

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 :

{
   "triggercode" : "TRIGGER_CODE",
   "object" : {DolibarrObject}
}

Exemple de message envoyé par Dolibarr lors de l'exécution de l'événement COMPANY_CREATE:

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

...