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 :
|  |
 |
ATTENTION : Le webhook peut-être envoyé vers votre portail Via HTML pour mener des actions automatisées. |
 |
 |
|
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 :
|  |
 | Plusieurs conditions d'émission du webhook peuvent être créées. Cliquez sur « Ajouter une condition » pour afficher d'autres options :
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égorie | Champ | Description |
| User (Utilisateur) | Address | Adresse principale |
| Address2 | Adresse secondaire | |
| City | Ville | |
| CompanyName | Organisation | |
| CountryID | Identifiant du pays | |
| Courriel | ||
| EnableNotifications | Activer la réception par courriel de notifications | |
| ExpirationDate | Date de désactivation du compte | |
| FirstName | Prénom | |
| FunctionTitle | Titre ou fonction dans l'organisation | |
| ID | Identifiant unique de l'utilisateur | |
| Language | Langue | |
| LastName | Nom de famille | |
| Login | Identifiant de connexion | |
| Membre (member) | EXEMPLE D'UN CHAMP PERSONNALISÉ | |
| Password | Mot de passe | |
| PhoneHome | Téléphone résidentiel | |
| PhoneMobile | Téléphone cellulaire | |
| PhonePublic | Numéro de téléphone à afficher (cas spécifiques) | |
| PhoneWork | Téléphone au travail | |
| PortalID | Identifiant de portail | |
| PostalCode | Code postal | |
| StateID | Identifiant du pays | |
| Status | Utilisateur actif (1) ou inactif (0) | |
| TimeZone | Fuseau horaire | |
| ViaAccessMode | Mode d'accès de Via Classique (web, téléphone,...) | |
| Portal (Portail) | AllowNewAccount | Permet la création de nouveau utilisateurs |
| BranchID | Identifiant de la branche du portail | |
| CoverID | Identifiant du visuel du portail | |
| CreatedByUserID | Identifiant de l'utilisateur ayant créé le portail | |
| CreationDate | Date de création | |
| DefaultBranchID | Branche par défaut des nouveaux utilisateurs | |
| Description | Présentation du portail | |
| DisplayType | Mode d'affichage du catalogue | |
| Dns | Indique si un DNS est activé | |
| GoogleAnalyticsKey | Clé privée de compte Google Analytics | |
| HasCustomLogo | Le portail n'affiche plus son logo par défaut | |
| ID | Identifiant du portail | |
| IsDefaultPortal | Est le portail par défaut | |
| IsUsingCustomSupportInfo | Le portail n'affiche plus les informations d'assistance technique au complet | |
| Keywords | Mot-clés du portail dans la configuration Google Analytics | |
| Language | Langue d'affichage | |
| LanguageFilter | ||
| LastModificationDate | Date de la dernière modification | |
| Name | Nom administratif | |
| NewAccountButtonLabel | Libellé du bouton de création d'utilisateur | |
| NewAccountDescription | Description à la création de compte | |
| NewAccountUrl | URL de redirection à la création de compte | |
| NewUserLanguage | Langue par défaut des nouveaux utilisateurs | |
| ProviderFilter | Onglets de fournisseur du catalogue | |
| SeoDescription | Description du portail paramétré pour Google Analytics | |
| SubTitle | Sous-titre | |
| Title | Titre | |
| Url | URL 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énement | Description |
| Portail | Confirmation de réinitialisation de mot de passe | Le mot de passe d'un utilisateur a été réinitialisé avec succès |
| Connexion d'un utilisateur | Un utilisateur s'est connecté au portail | |
| Création d'un groupe d'utilisateurs | Un groupe d'utilisateurs a été créé | |
| Création d'un organigramme | Une nouvelle branche de l'organigramme a été créée | |
| Création d'utilisateur | Un nouvel utilisateur a été créé | |
| Création de portail | Un nouveau portail a été créé | |
| Désactivation d'utilisateur | Un utilisateur a été désactivé (n'a plus accès au portail) | |
| Désactivation de portail | Un portail a été supprimé | |
| Modification d'un groupe d'utilisateurs | Un groupe d'utilisateurs a été modifié | |
| Modification d'un organigramme | Un branche a été modifiée | |
| Modification d'utilisateur | Les informations d'un utilisateur ont été modifiées | |
| Modification de portail | Les paramètres d'un portail ont été modifiés | |
| Modification des droits d'un organigramme | Le profil de droits d'un utilisateur sur une branche a été modifié | |
| Réinitialisation de mot de passe | Une réinitialisation de mot de passe d'un utilisateur a été lancée | |
| Suppression d'un groupe d'utilisateurs | Un groupe d'utilisateurs a été supprimé | |
| Suppression d'un organigramme | Une branche de l'organigramme a été supprimée | |
| Supression d'utilisateur | Un utilisateur a été supprimé | |
| Activité Via HTML | à venir | à venir |
| Ressource | à venir | à venir |