Watchers & Webhooks API

Créé par Julien Pauthier, Modifié le Jeu, 20 Juin à 2:45 H par Julien Pauthier

Watchers

Vous pouvez gérer vos watchers directement depuis votre backoffice, depuis la console Console développeurs :

Le switch Automatique permet de définir si le watcher doit être déclenché automatiquement (lorsqu'un objet défini en tant que Type de données est créé, modifié ou supprimé), ou actionné via un workflow spécifique.

Création de votre watcher

Dans la section Général vous avez plusieurs champs à renseigner :

Nom : le nom de votre choix (conseil : choisissez un nom évident en rapport avec la fonction du watcher).
Adresse : correspond à l’URL endpoint sur votre système tiers (votre endpoint Salesforce par exemple).
Méthode HTTP : méthode utilisée pour vos besoins selon les principes REST (POST, GET, PUT, PATCH, DELETE).

Schema : Si vous ne souhaitez pas utiliser le structure JSON associée par défaut à chaque type d'objet, vous pouvez ici définir le schéma (JSON, XML voire CSV) de votre appel API. Par exemple vous pouvez définir les noms des champs de votre destination côté Salesforce. Ainsi, si votre schéma Salesforce est (pour un champ custom) :

{
        "name": "Client_Lastname__c",
        "type": [
          "null",
          "string"
        ]
}

Vous aurez besoin de la valeur du champ name, soit Client_Lastname__c. Ainsi, dans le schéma du watcher, Client_Lastname__c deviendra la clé. Maintenant, nous avons besoin de transmettre une valeur à ce champ contenu dans le schéma de l’objet Agendize. Pour y accéder, nous allons utiliser le système de JsonPath. Si l’objet visé est la fiche d’un client, alors la valeur sera ${$.client.lastName}. Le schéma final pour ce champ sera le suivant :

{
   "Client_Lastname__c": "${$.client.lastName}"
}

Dans la partie Headers vous pouvez renseigner les paramètres dont vous avez besoin sous forme de clé/valeur.

Enfin, pour le droit d'’accès API, vous aurez la possibilité de choisir entre une authentification basique HTTP ou OAuth2 :

Dans le cas d'une authentification OAuth2, vous avez à renseigner les champs suivants (à titre d'exemple, pour Salesforce vous pourrez trouver les informations ci-dessous dans la gestion de vos applications connectées dans vos paramètres côté Salesforce) :

Id client : correspond à la Clé consommateur de votre application Salesforce.
Secret client : correspond au Secret consommateur de votre application Salesforce.
Scopes : ce champ peut être renseigné de manière optionnelle afin de définir les types de ressources auxquelles le client (Agendize) peut accéder (dans le cas de certaines applications dont Salesforce, le scope offline doit être ajouté)
Url d’autorisation : pour obtenir l’URL d’autorisation Salesforce, veuillez vous référer à la documentation de votre produit.
Url de la génération du token d’accès : pour obtenir l’URL d’autorisation Salesforce, veuillez vous référer à la documentation de votre produit.
Refresh token : si les informations ci-dessus sont correctes, un token pourra être généré, dernière étape qui autorise la connexion entre Salesforce et Agendize (le jeton ne doit pas avoir de date d'expiration).

Côté Salesforce, il faut indiquer l'URL de callback : https://VOTRESERVEUR.agendize.com/console/developers/watchers-oauth

Association du watcher à un workflow

Vous pouvez également associer ce nouveau watcher à un workflow pour filtrer les événements déclenchant son exécution :