Créer et gérer les webhooks

TABLE DES MATIÈRES
Introduction
Découvrir les avantages des webhooks
Créer un webhook sur le portail Via HTML
Règles d'émission des webhooks
Liste des champs de règles
Exemple de données par défaut
Liste des catégories et des événements Via HTML

Notes
I. La nouvelle version de Via HTML est présentement offerte en mode «Beta». Nous vous tiendrons informés de prochains développements et maintiendrons la présente documentation à jour;
II. Veuillez noter que le genre masculin est utilisé de façon générique dans les articles d'assistance pour en alléger le contenu.

III. Les webhooks forment une fonctionnalité avancée du produit et s'adresse généralement à vos équipes techniques (TI).

Introduction

Le portail Via HTML inclut plusieurs événements, ou déclencheurs (triggers), qui peuvent être signalés automatiquement à un autre système, par exemple. Ces appels informatiques automatisés ne nomment « Webhooks » et utilisent les variables de l'API.

Le présent article explique la mise en place de webhooks sur votre portail Via HTML et non le format JSON utilisé pour passer ces appels.


Découvrir les avantages des webhooks

Dans certains cas, il est possible que votre organisation désire mettre en place des actions automatisée ou des échanges entre deux ou plusieurs systèmes lorsqu'une ou plusieurs actions se déroulent sur votre portail Via HTML. Comme présenté en introduction, vous pouvez consulter les différentes variables API dans les Guides API des différents produits.

Créer un webhook sur le portail Via HTML

Pour créer un nouveau webhook sur votre portail Via HTML, rendez-vous dans les « Réglages avancés » du menu « Administration », puis sous l'onglet « Webhooks ». À partir de cet endroit, vous pourrez consulter la liste des webhooks déjà existants.
Pour créer un nouveau webhook, cliquez sur « Nouveau Webhook ». La page de création de nouveau webhook contient plusieurs options :
  • Nom du Webhook *nom administratif de votre nouveau webhook;
  • Catégorie de l'événement : définit la composante du système touchée par l'événement;
  • Événement : définit le déclencheur du webhook;
  • URL de Webhook * : entrez l'adresse de destination du webhook.
ATTENTION : Le webhook peut-être envoyé vers votre portail Via HTML pour mener des actions automatisées.
  • Activer les données personnalisées : désactive les données par défaut et permet d'envoyer ses propres données;
  • Données à ajouter dans l'entête (au format JSON) : informations d'entête à envoyer dans l'appel;
  • Données personnalisées à envoyer : données de remplacement des données par défaut.

Règles d'émission des webhooks

Pour gérer les règles d'émission des webhooks, vous devez préalablement avoir créé un webhook et vous rendre dans ses paramètres. Rendez-vous dans les « Réglages avancés » du menu « Administration », puis sous l'onglet « Webhooks ». Cliquez sur le webhook à modifier. Vous trouverez maintenant un onglet « Règles ».

* Dans cet exemple, le webhook ne partirait que lorsqu'un nouvel utilisateur serait réputé entrer « Hydro Québec » dans le champs « Organisation » (API: CompanyName) du formulaire de création d'utilisateur lors de sa création d'utilisateur sur le portail. L'utilisation d'un webhook émerge donc d'un besoin précis.

L'option de « Validation » doit tout d'abord être définie à l'aide du menu déroulant :

  • Validation : conditions à remplir pour l'émission (et/ou);
Plusieurs conditions d'émission du webhook peuvent être créées. Cliquez sur « Ajouter une condition » pour afficher d'autres options : 
  • Champ : valeur sur laquelle baser la règle. Consultez la Liste des champs;
  • Opérateur : caractéristique de traitement du champ sélectionné;
  • Valeur : définissez la valeur recherché dans le champ sélectionné.

ATTENTION : n'oubliez pas de rendre votre webhook « Actif » à l'aide du bouton prévu à cet effet.

Liste des champs de règles

La tableau ci-dessous présente une description des différents champs sur lesquels vous pouvez baser votre webhook. L'action requise doit être logique d'un point de vue informatique, sinon elle ne sera pas fonctionnelle. Pour en découvrir davantage sur les utilisateurs, consultez l'article Créer et gérer les utilisateurs. Pour découvrir les différents paramètres des portails, consultez l'article Découvrir le portail et le paramétrer.
CatégorieChampDescription
User (Utilisateur)AddressAdresse principale
Address2Adresse secondaire
CityVille
CompanyNameOrganisation
CountryIDIdentifiant du pays
EmailCourriel
EnableNotificationsActiver la réception par courriel de notifications
ExpirationDateDate de désactivation du compte
FirstNamePrénom
FunctionTitleTitre ou fonction dans l'organisation
IDIdentifiant unique de l'utilisateur
LanguageLangue
LastNameNom de famille
LoginIdentifiant de connexion
Membre (member)EXEMPLE D'UN CHAMP PERSONNALISÉ
PasswordMot de passe
PhoneHomeTéléphone résidentiel
PhoneMobileTéléphone cellulaire
PhonePublicNuméro de téléphone à afficher (cas spécifiques)
PhoneWorkTéléphone au travail
PortalIDIdentifiant de portail
PostalCodeCode postal
StateIDIdentifiant du pays
StatusUtilisateur actif (1) ou inactif (0)
TimeZoneFuseau horaire
ViaAccessModeMode d'accès de Via Classique (web, téléphone,...)
Portal (Portail)AllowNewAccountPermet la création de nouveau utilisateurs
BranchIDIdentifiant de la branche du portail
CoverIDIdentifiant du visuel du portail
CreatedByUserIDIdentifiant de l'utilisateur ayant créé le portail
CreationDateDate de création
DefaultBranchIDBranche par défaut des nouveaux utilisateurs
DescriptionPrésentation du portail
DisplayTypeMode d'affichage du catalogue
DnsIndique si un DNS est activé
GoogleAnalyticsKeyClé privée de compte Google Analytics
HasCustomLogoLe portail n'affiche plus son logo par défaut
IDIdentifiant du portail
IsDefaultPortalEst le portail par défaut
IsUsingCustomSupportInfoLe portail n'affiche plus les informations d'assistance technique au complet
KeywordsMot-clés du portail dans la configuration Google Analytics
LanguageLangue d'affichage
LanguageFilter
LastModificationDateDate de la dernière modification
NameNom administratif
NewAccountButtonLabelLibellé du bouton de création d'utilisateur
NewAccountDescriptionDescription à la création de compte
NewAccountUrlURL de redirection à la création de compte
NewUserLanguageLangue par défaut des nouveaux utilisateurs
ProviderFilterOnglets de fournisseur du catalogue
SeoDescriptionDescription du portail paramétré pour Google Analytics
SubTitleSous-titre
TitleTitre
UrlURL du portail

Exemple de données par défaut

Ci-dessous se trouvent des exemples des données envoyées lors d'un webhook sur l'utilisateur ou sur le portail. 
{
"notificationType" : 19,
"notificationID" : 21369,
"portal" : {
"id" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
"title" : {
"texts" : [],
"ErrorID" : 0
},
"subTitle" : {
"texts" : [],
"ErrorID" : 0
},
"description" : {
"texts" : [],
"ErrorID" : 0
},
"coverID" : 0,
"allowNewAccount" : false,
"newAccountButtonLabel" : {
"texts" : [],
"ErrorID" : 0
},
"newAccountDescription" : {
"texts" : [],
"ErrorID" : 0
},
"creationDate" : "2008-12-09T00:00:00",
"name" : " Nom du Portail",
"language" : 0,
"newUserLanguage" : 0,
"branchID" : "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
"hasCustomLogo" : false,
"lastModificationDate" : "0001-01-01T00:00:00",
"defaultBranchID" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
"isDefaultPortal" : false,
"displayType" : 1,
"createdByUserID" : "BzEm1iKI2qP86aUK38RlVg%3d%3d",
"providerFilter" : false,
"languageFilter" : false,
"isUsingCustomSupportInfo" : false
},
"user" : {
"id" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
"login" : "Jdoe",
"firstName" : "John",
"lastName" : "Doe",
"language" : 0,
"email" : "jdoe@jdoe.ca",
"companyName" : "",
"functionTitle" : "",
"phoneHome" : "",
"phoneMobile" : " 111 111 1111",
"phoneWork" : "",
"phonePublic" : 0,
"timeZone" : 0,
"address" : " 190 rue saint joseph",
"address2" : "",
"postalCode" : "",
"city" : "Québec",
"countryId" : 0,
"stateId" : 0,
"portalId" : "0ZmJHkU8UY9k2si1sOPcGg%3d%3d",
"expirationDate" : "0001-01-01T00:00:00",
"enableNotifications" : true,
"viaAccessMode" : 1,
"status" : 0
}
}

Liste des catégories et des événements Via HTML

Ci-dessous se trouve une liste des « Événements » du système, ou des « déclencheurs » des webhooks.
CatégorieÉvénementDescription
PortailConfirmation de réinitialisation de mot de passeLe mot de passe d'un utilisateur a été réinitialisé avec succès
Connexion d'un utilisateurUn utilisateur s'est connecté au portail
Création d'un groupe d'utilisateursUn groupe d'utilisateurs a été créé
Création d'un organigrammeUne nouvelle branche de l'organigramme a été créée
Création d'utilisateurUn nouvel utilisateur a été créé
Création de portailUn nouveau portail a été créé
Désactivation d'utilisateurUn utilisateur a été désactivé (n'a plus accès au portail)
Désactivation de portailUn portail a été supprimé
Modification d'un groupe d'utilisateursUn groupe d'utilisateurs a été modifié
Modification d'un organigrammeUn branche a été modifiée
Modification d'utilisateurLes informations d'un utilisateur ont été modifiées
Modification de portailLes paramètres d'un portail ont été modifiés
Modification des droits d'un organigrammeLe profil de droits d'un utilisateur sur une branche a été modifié
Réinitialisation de mot de passeUne réinitialisation de mot de passe d'un utilisateur a été lancée
Suppression d'un groupe d'utilisateursUn groupe d'utilisateurs a été supprimé
Suppression d'un organigrammeUne branche de l'organigramme a été supprimée
Supression d'utilisateurUn utilisateur a été supprimé
Activité Via HTMLà venirà venir
Ressourceà venirà venir

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Nous sommes désolés de ne pas avoir pu répondre à votre question. Aidez-nous à améliorer cet article grâce à vos commentaires.