Webhooks #

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

Les événements Web hook se déclencheront pour les événements C.R.U.D sur les utilisateurs et le client. Le REST API peut ensuite être utilisé par l'application destinataire pour interroger les informations spécifiques sur les changements à l'aide des identifiants fournis dans la charge utile du webhook.

Paramètres #

Paramètre	Options	Descriptif
Type d'entité	Utilisateur, Client	L'entité pour laquelle la gâchette peut se déclencher. Créez plusieurs déclencheurs pour capturer les changements 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 qui provoque un déclencheur est inclus dans la charge utile.
URL	https://	Fournir un HTTPS URL que le déclencheur sonnera lorsqu'il sera tiré.
Méthode de demande	GET, POST, PUT	Choisissez la méthode de demande requise pour le webhook.
Format de la demande	JSON, Données de formulaire	Choisissez le format de demande requis pour le webhook si POST ou PUT sont sélectionnés comme méthode de demande.
Données supplémentaires sur la charge utile	Paire clé/valeur	Au besoin, des informations statiques supplémentaires peuvent être ajoutées à la charge utile du webhook. Entrez toutes les données supplémentaires sous forme de paires clé/valeur, au besoin.
Tentatives de nouvelle tentative	0 - 10	Défaut 1. Entrez le nombre de fois que le webhook doit réessayer si à un moment donné il y a un échec

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

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

Données sur la charge utile #

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

Paramètre	Descriptif
Identifiant de déclenchement	L'identifiant unique du déclencheur pour lequel la demande de web hook est déclenchée.
Identifiant	L'identifiant de l'entité qui change (identifiant d'utilisateur ou identifiant de locataire).
locataireId	L'ID du locataire client auquel l'événement est associé.
eventType	Le type d'événement qui génère le web hook. Soit créer, mise à jour ou supprimer
customData	S'il est configuré par rapport au déclencheur, toute information supplémentaire sur la paire clé/valeur de la charge utile sera transmise ici.

tip
Le triggerId peut être trouvé en modifiant un déclencheur configuré dans le portail des revendeurs et en copiant le fichier GUID à partir de la fin du URL. p. ex. 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 Demandes :

{
    "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 Demandes :

[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 Demande #

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

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