Webhooks #

Les webhooks peuvent être utilisés pour générer des notifications externes de modifications d'utilisateurs et/ou de clients. Ces notifications, lorsqu'elles sont combinées avec le REST API sont essentiels pour automatiser le provisionnement des utilisateurs et maintenir à jour les systèmes de configuration/facturation externes.

Les événements de web hook se déclenchent pour les événements C.R.U.D sur les utilisateurs et les clients. Le REST API peut ensuite être utilisé par l'application réceptrice pour interroger les informations spécifiques sur les modifications à l'aide des ID fournis dans la charge utile du webhook.

Paramètres #

Paramètre	Options	Description
Type d'entité	Utilisateur, Client	L'entité pour laquelle le déclencheur peut se déclencher. Créez plusieurs déclencheurs pour capturer les modifications de l'utilisateur et du client.
Événement	Créé / mis à jour / supprimé	Sélectionnez un ou plusieurs types d'événements sur lesquels le déclencheur se déclenchera. *Remarque : le type d'événement à l'origine d'un déclencheur est inclus dans la charge utile.
URL	https://	Fournir un HTTPS URL que la gâchette appellera lorsqu'elle sera tirée.
Méthode de la requête	GET, POST, PUT	Choisissez la méthode de requête requise pour le webhook.
Format de la requête	JSON, données de formulaire	Choisissez le format de requête requis pour le webhook si POST ou PUT sont sélectionnées comme méthode de demande.
Données utiles supplémentaires	Paire clé/valeur	Si nécessaire, des informations statiques supplémentaires peuvent être ajoutées à la charge utile du webhook. Entrez des données supplémentaires sous forme de paires clé/valeur, si nécessaire.
Tentatives de nouvelle tentative	0 - 10	Par défaut 1. Entrez le nombre de fois que le webhook doit réessayer si le

warning
La configuration du déclencheur de webhook est mise en cache pour améliorer les performances. Tout nouveau déclencheur ou modification apportée à des déclencheurs existants peut prendre jusqu'à 10 minutes avant d'entrer en vigueur.

info
Le délai d'expiration d'une demande de webhook est de 10 secondes. Le temps entre les nouvelles tentatives est égal à la Nombre de tentatives x 2 secondes

Données de charge utile #

Le tableau ci-dessous présente les données fournies dans la charge utile du déclencheur.

Paramètre	Description
triggerID	ID unique du déclencheur pour lequel la demande de webhook est déclenchée.
id	L'identifiant de l'entité qui change (ID utilisateur ou ID locataire).
tenantId	ID de locataire du client auquel l'événement est associé.
eventType	Le type d'événement qui génère le webhook. Soit créer, Mise à jour ou supprimer
données personnalisées	S'il est configuré contre le déclencheur, toutes les informations supplémentaires de la paire clé/valeur de la charge utile seront transmises ici.

tip
Le triggerId peut être trouvé en modifiant un déclencheur configuré dans le portail des revendeurs et en copiant le GUID à partir de la fin du URL. par exemple https://reseller.myreports.com/en-GB/webhooks/00000000-0000-0000-0000-000000000000

Exemple JSON charge utile: #

Exemple JSON Format de charge utile pour PUT/POST Requêtes:

{
    "triggerId": "00000000-0000-0000-0000-000000000000",
    "id": "1468547c-a945-41d4-95e3-ffffffffffff",
    "tenantId": "a0ea7445-df78-4487-ffffffffffff",
    "configurationType": "user",
    "eventType": "update",
    "customData": {
        "myitemkey1": "myitemval1",
        "myitemkey2": "myitemval2"
    }
}

Exemple de charge utile de données FORM #

Exemple de charge utile de données de formulaire pour PUT/POST Requêtes:

[triggerId, 00000000-0000-0000-0000-000000000000], [tenantId, a0ea7445-df78-4487-ffffffffffff], [id, 1468547c-a945-41d4-95e3-ffffffffffff], [configurationType, user], [eventType, update],[myitemkey1, myitemval1], [myitemkey2, myitemval2]

Exemple GET demander #

Si la méthode Request de GET est configuré pour le Webhook, les données de charge utile sont transmises en tant que paramètres de chaîne de requête dans la demande.

http://example.url.com?triggerId=00000000-0000-0000-0000-000000000000&tenantId=a0ea7445-df78-4487-ffffffffffff&id=1468547c-a945-41d4-95e3-ffffffffffff&configurationType=user&eventType=update&hook=get&myitemkey1=myitemval1&myitemkey2=myitemval2