Notes I. Le présent article affiche les informations en considérant que vous possédez le profil de droits nécessaire à la création et l'édition de webhooks; 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 système de gestion des apprentissages Lära 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 de formation 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. 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
Pour créer un nouveau webhook, 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 associés aux webhooks
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. Des exemples de données sont fournis après le tableau et des précisions sur les données sont disponible dans le Guide API. |
Catégorie | Champ | Description |
Portal. (portail) | AllowNewAccount | Option de portail permettant la création autonome d'un compte utilisateur. |
BranchID | Branche de l'organigramme à laquelle est associée le portail. | |
CoverID | Identifiant API du visuel utilisé pour l'arrière-plan du portail | |
CreatedByUserID | Identifiant API de l'utilisateur ayant créé le portail. | |
CreationDate | Date de création du portail. | |
DefaultBranchID | Branche par défaut des nouveaux utilisateurs se créant un compte sur le portail (Implique l'activation de "AllowNewAccount''). | |
Description | Présentation du portail se retrouvant sur la page publique. | |
DisplayType | Mode de présentation du catalogue (tuiles, calendrier ou liste). | |
Dns | Indique si un DNS est utilisé pour ce portail. | |
GoogleAnalyticsKey | Clé de la propriété Google Analytics. | |
HasCustomLogo | Indique si un logo personnalisé a été ajouté au portail. | |
ID | Identifiant API du portail. | |
IsDefaultPortal | Indique s'il s'agit du portail par défaut de l'organisation. | |
IsUsingCustomSupportInfo | Indique si des informations de soutien technique personnalisées ont été créées pour le portail. | |
Keywords | Mots-clés pour la recherche sur les moteurs de recherche. | |
Language | Langue de présentation par défaut du portail. | |
LanguageFilter | Indique si le filtre de langue est affiché au catalogue du portail. | |
LastModificationDate | Date de la dernière modification des paramètres du portail. | |
Name | Nom administratif du portail. | |
NewAccountButtonLabel | Libellé du bouton de création de nouveau compte utilisateur (Implique l'activation de "AllowNewAccount''). | |
NewAccountDescription | Description à la création de compte (Implique l'activation de "AllowNewAccount''). | |
NewAccountUrl | URL de redirection du bouton de création de compte (Implique l'activation de "AllowNewAccount''). | |
NewUserLanguage | Langue par défaut des nouveaux utilisateurs créés sur ce portail. | |
ProviderFilter | Indique si des onglets de fournisseurs ont été activés pour ce portail. | |
SeoDescription | Description du portail sur les moteurs de recherche. | |
SubTitle | Sous-titre du portail (N2). | |
Title | Titre du portail (N1). | |
Url | Adresse web du portail. | |
Catalog. (catalogue) | CreatedByUserID | Identifiant API de l'utilisateur ayant créé le catalogue. |
CreationDate | Date de création du catalogue. | |
ID | Identifiant API du catalogue. | |
Name | Nom administratif du catalogue. | |
User. (utilisateur) | Address | Adresse principale de l'utilisateur. |
Address2 | Adresse secondaire de l'utilisateur. | |
City | Ville de l'utilisateur. | |
CompanyName | Nom de l'organisation de l'utilisateur. | |
CountryID | Identifiant API du pays de résidence de l'utilisateur. | |
Adresse courriel de l'utilisateur. | ||
EnableNotifications | Indique si l'utilisateur accepte les notifications par courriel. | |
ExpirationDate | Date de désactivation du compte de l'utilisateur. | |
FirstName | Prénom de l'utilisateur. | |
FunctionTitle | Titre ou fonction de l'utilisateur au sein de son organisation. | |
ID | Identifiant API de l'utilisateur. | |
InscriptionDate | Date de création de l'utilisateur. | |
Language | Langue d'affichage de l'utilisateur. | |
LastName | Nom de famille de l'utilisateur. | |
Login | Identifiant de connexion de l'utilisateur. | |
Password | Mot de passe de l'utilisateur. | |
PhoneHome | Numéro de téléphone résidentiel de l'utilisateur. | |
PhoneMobile | Numéro de téléphone cellulaire de l'utilisateur. | |
PhonePublic | Numéro de téléphone affiché publiquement dans certains contextes très précis. | |
PhoneWork | Numéro de téléphone professionnel de l'utilisateur. | |
PortailID | Identifiant API du portail de l'utilisateur. | |
PostalCode | Code postal de l'utilisateur. | |
StateID | Identifiant API de la province, de l'état ou du territoire de l'utilisateur. | |
Status | Indique si le compte de l'utilisateur est réputé actif ou désactivé. | |
TimeZone | Fuseau horaire de l'utilisateur. | |
ViaAccessMode | Mode d'accès à Via Classique par défaut pour l'utilisateur. | |
UserGroup. (groupe) | CreatedByUserID | Identifiant API de l'utilisateur ayant créé le groupe d'utilisateurs. |
CreationDate | Date de création du groupe d'utilisateurs. | |
ID | Identifiant API du groupe d'utilisateurs. | |
Name | Nom du groupe d'utilisateurs. | |
Branch. (branche) | CreatedByUserID | Identifiant API de l'utilisateur ayant créé la branche de l'organigramme. |
CreationDate | Date de création de la branche de l'organigramme. | |
ID | Identifiant API de la branche de l'organigramme. | |
Name | Nom administratif de la branche de l'organigramme. | |
ParentID | Identifiant API de la branche supérieur de la branche de l'organigramme. | |
Workspace (formation) | AccreditationNumber | Numéro d'accréditation de la formation (règlement). |
Active | ||
AuthorizationType | Mécanisme d'autorisation lors de l'inscription à la formation. | |
AutodeclarationApprovalRequired | Indique si l'autodéclaration pour cette formation requière une approbation administrative (règlement). | |
AutodeclarationEndDate | Date de fin de la capacité à faire une autodéclaration pour la formation. | |
AutodeclarationOrganization | Nom de l'organisation dispensatrice ou liée à l'autodéclaration de la formation. | |
AutodeclarationProofRequired | Indique si le processus d'autodéclaration de la formation exige une pièce justificative (implique l'activation de "AutodeclarationProofRequired") | |
AutodeclarationProofUpload | Indique si le processus d'autodéclaration de la formation permet le téléversement d'une pièce justificative. | |
AutodeclarationSolemnDeclaration | Indique si le processus d'autodéclaration de la formation exige une déclaration solennelle. | |
AutodeclarationStartDate | Date de début de la capacité à faire une autodéclaration pour la formation. | |
CatalogID | Identifiant API du ou des catalogues auxquels la formation est associée. | |
CatalogLink | URL vers la page de présentation de la formation au catalogue public pour cette formation. Le URL donné pointe sur le portail par défaut. | |
CategoryID | Identifiant API de la catégorie à laquelle la formation est associée. | |
CertificateID | Identifiant API de l'attestation associée à la formation. | |
CoverID | Identifiant API du visuel associé à la formation. | |
CreatedByUserID | Identifiant API de l'utilisateur ayant créé la formation. | |
CreationDate | Date de création de la formation. | |
Credits | Nombre de crédits, d'heures, d'UEC ou d'UFC associés à la complétion avec succès de la formation. | |
CreditsType | Nomenclature des unités représentant la valeur de la formation. | |
Description | Présentation et détails de la formation affichée au catalogue. | |
EndDate | Date de fin de la capacité à s'inscrire à la formation (la formation disparaît du catalogue). | |
EnrolmentType | Indique la méthode d'inscription à la formation. | |
ExternalLink | Lien de redirection externe des boutons d'inscription aux session de la formation (implique une méthode d'inscription de type « Externe » à "EnrolmentType".). | |
ID | Identifiant API unique de la base de données pour la formation. | |
InstanceDaysAvailable | Valeur par défaut des nouvelles sessions : nombre de jour maximum d'accès au contenu après l'inscription à la session. | |
InstanceDaysToComplete | Valeur par défaut des nouvelles sessions : nombre de jour maximum pour compléter le contenu après l'inscription à la session. | |
IsAutodeclaration | Indique si la formation peut être utilisée dans les autodéclaration manuelles (accréditées). | |
IsCatalogLinkPublic | Indique si le lien d'accès direct à la formation est public ou privé. | |
IsOverBookingSubscription | Valeur par défaut des nouvelles sessions : Indique si la file d'attente est activée lors d'un débordement. | |
Keywords | Mots-clés associés à la formation pour la recherche dans le catalogue. | |
Language | Langue dans laquelle est donnée la formation. | |
LastModificationDate | Date de la dernière modification des paramètres de la formation. | |
MaxParticipants | Valeur par défaut des nouvelles sessions : capacité maximale de participants. | |
MinParticipants | Valeur par défaut des nouvelles sessions : capacité minimale de participants. | |
Name | Nom de la formation. | |
NbUsersQueue | Nombre d'utilisateurs inscrits en file d'attente pour l'ensemble des sessions de la formation. | |
NbUsersSubbed | Nombre d'utilisateurs inscrits pour l'ensemble des sessions de la formation. | |
ProviderID | Identifiant API du fournisseur de services associé à la formation. | |
ShortDescription | Description courte de la formation affichée au catalogue. | |
ShowAvailableSubscriptions | Indique si le nombre de places disponibles est affiché au catalogue pour chaque session de la formation. | |
StartDate | Date de début de la capacité à s'inscrire à la formation (la formation apparaît au catalogue). | |
SubscriptionType | Indique la méthode d'inscription à la formation, si les utilisateurs ont la capacité de s'inscrire par le catalogue. | |
TaxCountryID | Identifiant du pays associé au fournisseur de services de la formation. | |
TaxEnabled | Valeur par défaut des nouvelles sessions : indique si la taxation est activée pour les transactions sur les sessions de la formation. | |
TaxStateID | Identifiant de la province, de l'état ou du territoire associé au fournisseur de services de la formation. | |
Type | Type de formation de la formation. | |
VisibilityType | Type de visibilité au catalogue. | |
WebsiteID | ||
Workspace instance (session) | CreatedByUserID | Identifiant API de l'utilisateur ayant créé la session de formation. |
CreationDate | Date à laquelle la session de formation a été créée. | |
DaysAvailable | Nombre de jour maximum d'accès au contenu après l'inscription à la session de formation. | |
DaysToComplete | Nombre de jour maximum pour compléter le contenu après l'inscription à la session. | |
EndDate | Date de fin de la session. | |
ID | ||
IsFormula | Indique s'il s'agit d'une session de formation « À la carte ». | |
IsHidden | Indique si la session de formation est cachée du catalogue. | |
IsOverBookingSubscription | Indique si la file d'attente est activée lors d'un débordement. | |
LastModificationDate | Date de dernière modification des paramètres de la session de formation. | |
LocationId | Identifiant API de l'emplacement associé à la session de formation. | |
MaxParticipants | Capacité maximale d'utilisateurs inscrits à la session de formation. | |
MinParticipants | Capacité minimale d'utilisateurs inscrits à la session de formation. | |
Name | Nom de la session de formation. | |
NbUsersQueue | Nombre d'utilisateurs inscrits en file d'attente pour la session de formation. | |
NbUsersSubbed | Nombre d'utilisateurs inscrits à la session de formation. | |
StartDate | Date de début de la session de formation. | |
TaxCountryID | Identifiant du pays associé au fournisseur de services de la formation contenant la session de formation. | |
TaxEnabled | Indique si la taxation est activée pour les transactions sur la sessions de formation. | |
TaxStateID | Identifiant de la province, de l'état ou du territoire associé au fournisseur de services de la formation. | |
WebsiteID | ||
WorkspaceID | ||
Resource (ressource) | AdminCode | Code administratif associé à la ressource. |
CategoryID | ||
CompletionAllResource | ||
CompletionByResourceType | ||
CompletionManuel | ||
CompletionMinPoints | ||
CompletionMinTime | ||
CompletionPoints | ||
CompletionPointsManual | ||
CompletionResourceID | ||
CompletionVisible | ||
ContentInfo | ||
CreationDate | ||
Credits | ||
DateCondition | ||
DateEndCondition | ||
Description | Description, présentation de la ressource. | |
HasCompletion | Indique si la ressource possède une règle de complétion. | |
ID | ||
LinkedResourceID | ||
OrderIndex | Indique le rang, ou l'ordre de la ressource dans la session de formation. | |
ParentResourceID | ||
PhotoName | Nom du visuel associé à la ressource. | |
ResourceType | Type de ressource. | |
SharingItemID | ||
Title | Titre de la ressource. | |
UserID | ||
WorkspaceInstanceID | ||
Program (programme) | AuthorizationType | |
CatalogLink | ||
CategoryID | ||
CertificateID | ||
CoverID | ||
CreatedByUserID | ||
CreationDate | ||
Credits | ||
DateToComplete | ||
DaysToComplete | ||
Description | ||
EndDate | ||
EnrolmentType | ||
ExpirationType | ||
ExternalLink | ||
ID | ||
IsCatalogLinkPublic | ||
IsSinglePayment | ||
Keywords | ||
Language | ||
LastModificationDate | ||
MaxParticipants | ||
MinParticipants | ||
Name | ||
ProviderID | ||
ShortDescription | ||
ShowAvailableSubscriptions | ||
StartDate | ||
Status | ||
SubscriptionType | ||
TaxCountryID | ||
TaxEnabled | ||
TaxStateID | ||
VisibilityType | ||
Cohort (cohorte) | CreationDate | |
DateToComplete | ||
DaysAvailable | ||
DaysToComplete | ||
EndDate | ||
ExcBlockID | ||
ExcMaximumCredits | ||
ExcProgramID | ||
ExpirationType | ||
ID | ||
IsHidden | ||
IsSinglePayment | ||
LastModificationDate | ||
MaxParticipants | ||
MinParticipants | ||
Name | ||
NbUsersSubbed | ||
ProgramID | ||
StartDate | ||
Status | ||
TaxCountryID | ||
TaxEnabled | ||
TaxStateID | ||
Transaction (transaction) | AuthorizationStatus | |
Balance | ||
BasePrice | ||
BillingAddress | ||
BillingAddress2 | ||
BillingCity | ||
BillingCountryID | ||
BillingFamily | ||
BillingID | ||
BillingPostalCode | ||
BillingReferenceNumber | ||
BillingStateID | ||
BillingType | ||
BillToName | ||
CohortID | ||
Comment | ||
Currency | ||
ID | ||
IsExternal | ||
LotPurchaseDiscountPercent | ||
OnlinePaymentType | ||
OnlineTransactionID | ||
PaymentMethodType | ||
PaymentStatus | ||
PaymentTransactionID | ||
PriceName | ||
ProgramID | ||
PromoCodes | ||
ProviderID | ||
Quantity | ||
ShoppingCartTransactionID | ||
SubscribeDiscountPercent | ||
Taxes | ||
TotalPrice | ||
TransactionDate | ||
TransactionType | ||
UserID | ||
WorkspaceID | ||
WorkspaceInstanceID | ||
Autodeclaration (autodéclaration) | ApprovalStatus | |
AutodeclarationID | ||
IsManual | ||
LastModificationDate | ||
LastSubmissionDate | ||
Organization | ||
OwnerComment | ||
ReferenceString | ||
ReviewAdminComment | ||
ReviewComment | ||
ReviewDate | ||
Title | ||
WorkspaceCategoryID | ||
WorkspaceID | ||
WorkspaceTypeID | ||
Commitment (engagement) | AdminCode | |
BillingID | ||
CompletionDate | ||
CreationDate | ||
EndDate | ||
ID | ||
LastModificationDate | ||
LastSubscriptionDate | ||
RefID | ||
Status | ||
SubscribableItemStartDate | ||
Type | ||
UserID | ||
Cycle (période) | AdminName | Nom administratif de la période règlementaire. |
CycleID | Identifiant API de la période règlementaire. | |
IsActive | Indique si la période règlementaire est activée. | |
IsDeleted | Indique si la période règlementaire a été supprimée. | |
Name | ||
RuleID | Identifiant API unique de la règle filtrant les utilisateurs qui ont accès au règlement. | |
UseMembershipStatus |
Exemple de données par défaut
Ci-dessous se trouvent des exemples des données envoyées lors d'un webhook sur un portail, un catalogue, un utilisateur, un groupe d'utilisateurs, une branche de l'organigramme, une formation, une session, une ressource, un programme, une cohorte, une transaction, une autodéclaration, un engagement et une période de règlement. |
"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 }, "catalog" : { "id" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d", "name" : { "texts" : [], "ErrorID" : 0 }, "creationDate" : "2008-12-09T00:00:00" }, "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", "inscriptionDate" : "0001-01-01T00:00:00", "expirationDate" : "0001-01-01T00:00:00", "enableNotifications" : true, "viaAccessMode" : 1, "status" : 0 }, "userGroup" : { "id" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d", "name" : { "texts" : [], "ErrorID" : 0 }, "createdByUserID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d" }, "branch" : { "id" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d", "name" : { "texts" : [], "ErrorID" : 0 }, "creationDate" : "2008-12-09T00:00:00", "createdByUserID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d" }, "workspace" : { "id" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d", "websiteId" : "R%2fxjC2SjJIA2ERnHRz5MhA%3d%3d", "type" : "O%2f9dsKKECyJSUWkOK37D8g%3d%3d", "name" : "Nom du workspace", "active" : true, "language" : 0, "providerId" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d", "visibilityType" : 0, "maxParticipants" : 0, "minParticipants" : 0, "description" : "Super workspace", "shortDescription" : "", "subscriptionType" : 0, "startDate" : "2008-12-09T00:00:00", "endDate" : "2018-12-09T00:00:00", "isOverBookingSubscription" : false, "authorizationType" : 0, "enrolmentType" : 0, "keywords" : "", "showAvailableSubscriptions" : false, "credits" : 10.0, "nbUsersSubbed" : -1, "nbUsersQueue" : -1, "isAutodeclaration" : false, "accreditationNumber" : "", "autodeclarationStartDate" : "0001-01-01T00:00:00", "autodeclarationEndDate" : "0001-01-01T00:00:00", "autodeclarationOrganization" : "", "autodeclarationApprovalRequired" : false, "autodeclarationProofUpload" : false, "autodeclarationProofRequired" : false, "autodeclarationSolemnDeclaration" : false, "instanceDaysAvailable" : 0, "instanceDaysToComplete" : 0, "creditsType" : 1, "taxEnabled" : true, "isCatalogLinkPublic" : false }, "workspaceInstance" : { "id" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d", "workspaceId" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d", "websiteId" : "R%2fxjC2SjJIA2ERnHRz5MhA%3d%3d", "name" : "Nom de la session", "startDate" : "2008-12-09T00:00:00", "endDate" : "2018-12-09T00:00:00", "maxParticipants" : 50, "minParticipants" : 250, "isOverBookingSubscription" : false, "nbUsersSubbed" : 15, "nbUsersQueue" : 1, "daysAvailable" : 0, "daysToComplete" : 0, "isHidden" : false, "taxEnabled" : false, "isFormula" : false }, "resource" : { "ID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "ResourceType" : { "Value" : 0 }, "CreationDate" : "2022-02-23T09:28:23.656-05:00", "DateCondition" : "2022-02-23T09:28:23.656-05:00", "DateEndCondition" : "2022-02-23T09:28:23.656-05:00", "Title" : "Activité de présentation", "Description" : " cette activité sert de présentation", "ContentInfo" : "ceci sont les consignes!", "WorkspaceInstanceID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "UserID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "OrderIndex" : 1, "ParentResourceID" : "BzEm1iKI2qP86aUK38RlVg%3d%3d", "PhotoName" : "", "SharingItemID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "CategoryID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "Credits" : 2.0, "LinkedResourceID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "CompletionPoints" : 10, "CompletionVisible" : true, "HasCompletion" : true, "CompletionManual" : false, "CompletionPointsManual" : false, "CompletionMinTime" : 2.5, "CompletionByResourceType" : true, "CompletionMinPoints" : 25, "CompletionResourceID" : "eWAFhEFBmzdeDcziVz93Ag%3d%3d", "CompletionAllResource" : false }, "program" : { "id" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "creationDate" : "0001-01-01T00:00:00", "name" : "Programme de formation", "minParticipants" : -1, "maxParticipants" : -1, "description" : "Description du programme de formation", "subscriptionType" : 0, "enrolmentType" : 0, "authorizationType" : 0, "visibilityType" : 0, "startDate" : "0001-01-01T00:00:00", "endDate" : "0001-01-01T00:00:00", "showAvailableSubscriptions" : false, "providerId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "certificateId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "categoryId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "credits" : 0.0, "keywords" : "", "shortDescription" : "", "status" : 0, "language" : 0, "externalLink" : "", "taxEnabled" : true, "isSinglePayment" : false, "expirationType" : 0, "daysToComplete" : 0, "dateToComplete" : "0001-01-01T00:00:00", "isCatalogLinkPublic" : false }, "cohort" : { "id" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "programId" : "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d", "name" : "Programme de formation", "startDate" : "0001-01-01T00:00:00", "endDate" : "0001-01-01T00:00:00", "minParticipants" : -1, "maxParticipants" : -1, "creationDate" : "0001-01-01T00:00:00", "isHidden" : false, "status" : 0, "daysAvailable" : 0, "expirationType" : 0, "daysToComplete" : 0, "dateToComplete" : "0001-01-01T00:00:00", "taxEnabled" : false, "isSinglePayment" : false, "nbUsersSubbed" : -1 }, "transaction" : { "id" : "6e1BtwUHCT", "billingID" : "0ZmJHkU8UY9k2si1sOPcGg%3d%3d", "billingReferenceNumber" : 0, "billingFamily" : 0, "transactionDate" : "0001-01-01T00:00:00", "priceName" : "Prix pour tout le monde", "currency" : "cdn", "basePrice" : 10.0, "subscribeDiscountPercent" : 0.0, "lotPurchaseDiscountPercent" : 0.0, "quantity" : 1, "totalPrice" : 10.0, "paymentMethodID" : 0, "paymentMethodType" : 4, "transactionType" : 2, "comment" : "", "onlineTransactionID" : "125111", "billingCountryID" : 0, "billingStateID" : 0, "balance" : 0.0, "authorizationStatus" : 0, "paymentStatus" : 0, "billingType" : 0, "userID" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "workspaceId" : "0ZmJHkU8UY9k2si1sOPcGg%3d%3d", "workspaceInstanceId" : "0ZmJHkU8UY9k2si1sOPcGg%3d%3d", "cohortId" : "0ZmJHkU8UY9k2si1sOPcGg%3d%3d", "programId" : "0ZmJHkU8UY9k2si1sOPcGg%3d%3d", "onlinePaymentType" : "", "isExternal" : false }, "autoDeclaration" : { "autodeclarationId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "workspaceId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "workspaceCategoryId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "workspaceTypeId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "title" : "", "lastModificationDate" : "2022-02-23T09:37:49.654-05:00", "lastSubmissionDate" : "2022-02-23T10:37:49.654-05:00", "approvalStatus" : 3, "isManual" : false, "organization" : "", "reviewComment" : "", "reviewAdminComment" : "", "reviewDate" : "2022-02-23T13:37:49.654-05:00", "ownerComment" : "", "referenceString" : "" }, "commitment" : { "id" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "userId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "refId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "type" : 0, "status" : 2, "creationDate" : "0001-01-01T00:00:00", "adminCode" : "icc86eubfte0", "endDate" : "2022-02-28T00:00:00-05:00", "billingId" : "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d", "lastSubscriptionDate" : "2022-02-23T10:37:47.471-05:00", "subscribableItemStartDate" : "2022-02-23T10:37:47.471-05:00", "lastModificationDate" : "2022-02-23T10:37:47.471-05:00" }, "cycleUserProgress" : { "requiredCredits" : 1.3, "completedCredits" : 10.0, "exemptedCredits" : 2.0, "requiredProviderCredits" : 1.2, "completedProviderCredits" : 2.0, "defaultProviderCredits" : 2.5, "otherProvidersCredits" : 1.2, "completedTypes" : 3, "completedCategories" : 2 },
Exemple de données personnalisées
Lors de la création d'un webhook, vous pouvez envoyer vos propres données plutôt que d'utiliser les données par défaut. Les mots-clés ("[keywords]") acceptés pour les données personnalisées sont définis ci-bas. Note : le respect de la casse est exiger pour ces champs. | |
Les champs disponibles sont les mêmes que ceux présentés dans le présent article et dans l'API, par exemple, "[user.id]", "[user.firstName]", "[transaction.billingFamily]", etc. Un mot-clé existe aussi pour obtenir une valeur en fonction de cas spécifiques ("switch case"), nommé "matchcase". En voici la syntaxe : |
"[matchcase(object.fieldName, defaultValue, matchValue1:returnValue1, matchValue2:returnValue2, ...)]"
Veuillez noter qu'il n'est pas nécessaire d'ajouter les guillemets autour des mots-clés utilisés, il seront ajoutés automatiquement s'ils sont nécessaires, selon le type de donnée. Voici un exemple d'utilisation dans le JSON : |
{"id": [user.id], "branchId": [matchcase(workspace.providerID, "", "jkg4hg435":"fgh98234", "j5498t5":"irewt4op")], ...}
Mots-clés ("[keywords]") | Description |
autoDeclaration | Autodéclaration de formation (règlement) |
branch | Branche de l'organigramme |
catalog | Catalogue |
certificate | Attestation de formation ou de programme |
commitment | Engagement (règlement) |
cycleExemption | Dispenses (règlement) |
cycleUserProgress | Taux de complétion des exigences d'une période règlementaire pour un utilisateur (règlement) |
portal | Portail |
resource | Ressource de formation |
transaction | Transaction |
user | Utilisateur |
userGroup | Groupe d'utilisateurs |
workspace | Formation |
workspaceInstance | Session |
workspaceInstanceCompletion | Complétion d'une session |
Liste des catégories et des événements
Ci-dessous se trouve une liste des « Événements » du système, ou des « déclencheurs » des webhooks. |
Description des événements de session
Événement | Définition |
Achat en lot - Annulation | Lors de l'annulation d'une session où ont été inscrits des utilisateurs par achat en lot. |
Achat en lot - Assignation à une formation | Lors de l'achat en lot de places pour une session de formation. |
Achat en lot - Confirmation d'achat | Lors de l'achat en lot de places pour une session de formation. |
Achat en lot - Libération de place | Lors du refus par un utilisateur de la place d'achat en lot qui lui a été assignée par courriel avec confirmation. |
Achat en lot - Révocation d'une formation assignée | Lors de la révoquation d'une place assignée à un utilisateur. |
Achat en lot - Sièges restants | à venir |
Annulation d'une session | Lorsqu'une session est annulée par un administrateur. |
Changement de statut sur une inscription | Lorsque le statut d'inscription d'un utilisateur est modifié. |
Désinscription et transfert par l'organisation | Lors de l'annulation d'une session ET du transfert des participants inscrits vers une autre session. |
Désinscription par le participant | Lors de la désinscription autonome par le participant. |
Date de début d'une session | Lors de la date de début de la session. |
Date de fin d'une session | Lors de la date de fin de la session. |
Date limite d'accès au contenu d'une session | Lors de la limite d'accès au contenu d'une session. |
Date limite de complétion d'une session | Lors de la limite de temps alloué pour compléter une session. |
Engagement - Engagement complété avec succès | à venir |
Engagement - Engagement complété en échec | à venir |
Engagement - Expiration de l'engagement | à venir |
Inscription - Paiement avec facturation | Lors d'une inscription unique à une session avec méthode de paiement « Paiement par facturation ». |
Inscription à la carte - Modification du choix d'activités | Lors de la modification administrative d'un forfait d'une session « À la carte » d'un participant. |
Inscription à la carte - Paiement avec facturation | Lors d'une inscription unique à un forfait d'une session « À la carte » avec méthode de paiement « Paiement par facturation ». |
Inscription à la carte avec approbation | Lors d'une inscription à un forfait d'une session « À la carte » avec méthode d'autorisation « Approuvée par un administrateur ». |
Inscription à la carte avec paiement en attente | Lors d'une inscription unique à un forfait d'une session « À la carte » avec méthode de paiement « Chèque » ou « Argent comptant ». |
Inscription à la carte sans paiement | Lors d'une inscription unique à un forfait d'une session « À la carte » sans tarification ou avec une tarification de 0$. |
Inscription approuvée | Lors de l'approbation de la demande d'inscription d'un participant dans le contexte d'une formation avec méthode d'autorisation « Approuvée par un administrateur » où la session n'a pas de tarification. |
Inscription approuvée - paiement requis | Lors de l'approbation de la demande d'inscription d'un participant dans le contexte d'une formation avec méthode d'autorisation « Approuvée par un administrateur » où il y a paiement. |
Inscription avec approbation | Lors d'une demande d'inscription à une session de formation avec méthode d'autorisation « Approuvée par un administrateur ». |
Inscription avec file d'attente | Lors de l'inscription à une session de formation ayant atteint sa pleine capacité et où la file d'attente est activée. |
Inscription avec paiement en attente | Lors de l'inscription à une session de formation avec méthode de paiement par « Chèque » ou par « Argent comptant ». |
Inscription depuis la file d'attente | Lors de l'inscription depuis la file d'attente menée par un administrateur. |
Inscription manuelle | Lors de l'inscription administrative/manuelle à une session de formation. |
Inscription manuelle à une session à la carte | Lors de l'inscription administrative/manuelle à un forfait de session « À la carte ». |
Inscription refusée | Lors du refus de la demande d'inscription d'un participant dans le contexte d'une formation avec méthode d'autorisation « Approuvée par un administrateur » où la session n'a pas de tarification. |
Inscription sans paiement | Lors de l'inscription à une session de formation sans paiement ou à 0$. |
Maximum d'inscription atteint | à venir |
Minimum d'inscription atteint | à venir |
Minimum d'inscription non atteint | à venir |
Nouveau message | Lorsqu'un nouveau message a été publié sous une discussion de forum. |
Nouvelle demande d'inscription à approuver | Lorsqu'une demande d'inscription est à approuver sur une session de formation avec méthode d'autorisation « Approuvée par un administrateur ». |
Nouvelle discussion | Lorsqu'une nouvelle discussion a été publiée dans un forum. |
Paiement reçu pour inscription à une session | Lorsqu'une inscription unique avec paiement a lieu pour une session de formation. |
Paiement reçu pour une inscription à la carte | Lors d'une inscription unique à un forfait d'une session « À la carte » avec paiement. |
Remboursement reçu d'une inscription | Lors d'un remboursement effectué sur une inscription à une session de formation. |
Session complétée | Lors de la complétion d'une session de formation. |
Session complétée avec échec | à venir |
Session complétée avec succès | à venir |
Description des événements de portail
Événement | Définition du déclencheur |
Création d'un catalogue | Un catalogue a été créé par un administrateur. |
Création d'un groupe d'utilisateurs | Un groupe d'utilisateurs a été créé par un administrateur. |
Création d'un organigramme | Une nouvelle branche de l'organigramme a été créée par un administrateur. |
Création d'utilisateur | Un nouvel utilisateur a été créé par un administrateur. |
Création de portail | Un nouveau portail a été créé par un administrateur. |
Désactivation d'utilisateur | Un utilisateur a été désactivé par un administrateur. |
Désactivation de portail | à venir |
Modification d'un catalogue | Les paramètres d'un catalogue ont été modifiés par un administrateur. |
Modification d'un groupe d'utilisateurs | Les paramètres d'un groupe d'utilisateurs ont été modifiés par un administrateur. |
Modification d'un organigramme | Les paramètres d'une branche de l'organigramme ont été modifiés par un administrateur. |
Modification d'utilisateur | Les informations du sous-onglet « Profil » de l'onglet « Profil » du dossier utilisateur ont été modifiées par un administrateur ou par l'utilisateur lui-même (informations personnelles). |
Modification de portail | Les paramètres d'un portail ont été modifiés par un administrateur. |
Modification des droits d'un organigramme | Le profil de droits d'un utilisateur sur une branche a été modifié par un administrateur. |
Octroi d'attestation | Une attestation a été émise dans le dossier d'un utilisateur, qui a atteint les exigences de complétion avec succès d'une session (formation) ou d'une cohorte (programme de formation). |
Panier d'achat - Paiement reçu | Un paiement a été reçu pour une transaction par panier d'achat contenant plus qu'une inscription (inscription multiple en une transaction). |
Suppression d'un catalogue | Un catalogue a été supprimé par un administrateur. |
Suppression d'un groupe d'utilisateurs | Un groupe d'utilisateurs a été supprimé par un administrateur. |
Suppression d'un organigramme | Une branche de l'organigramme a été supprimée par un administrateur. |
Supression d'utilisateur | Un utilisateur a été supprimé par un administrateur. |
Description des événements de règlement
Événement | Définition |
Autodéclaration à approuver | Lors d'une autodéclaration par un utilisateur soumis aux exigences d'une période réglementaire. |
Autodéclatation a été approuvée | Lors de l'approbation par un administrateur de l'autodéclaration soumise par un utilisateur soumis aux exigences d'une période réglementaire. |
Autodéclaration a été refusée | Lors du refus par un administrateur de l'autodéclaration soumise par un utilisateur soumis aux exigences d'une période réglementaire. |
Autodéclaration: demande de renseignements supplémentaires | Lors d'une demande de renseignements supplémentaires d'un administrateur pour l'autodéclaration soumise par un utilisateur soumis aux exigences d'une période réglementaire. |
Autodéclaration: nouvelle | Lors d'une autodéclaration soumise par un utilisateur soumis aux exigences d'une période réglementaire. |
Demande de dispense - En attente d'approbation | Lors d'une demande de dispense soumise par un utilisateur soumis aux exigences d'une période réglementaire. |
Demande de dispense - En attente de renseignements supplémentaires | Lors d'une demande de renseignements supplémentaires d'un administrateur pour une demande de dispense soumise par un utilisateur soumis aux exigences d'une période réglementaire. |
Demande de dispense à approuver | Lors d'une demande de dispense faite par un utilisateur soumis aux exigences d'une période réglementaire. |
Demande de dispense analysée - Décision rendue | Lors de l'approbation ou du refus d'une demande de dispense faite par un utilisateur soumis aux exigences d'une période réglementaire par un administrateur. |
Demande de révision à évaluer | Lors d'une demande de révision de la décision rendue au regard d'une demande de dispense faite par un utilisateur soumis aux exigences d'une période réglementaire. |
Demande de révision analysée - Décision rendue | Lors d'une demande de révision approuvée ou refusée par un administrateur au regard de la décision déjà rendue sur une demande de dispense faite par un utilisateur soumis aux exigences d'une période réglementaire. |
Demande de révision de la décision rendue - En attente d'approbation | Lors d'une demande de révision sur une demande de dispense faite par un utilisateur soumis aux exigences d'une période réglementaire. |
Modification d'une dispense | Lors de la modification par un administrateur de la demande de dispense faite par un utilisateur soumis aux exigences d'une période réglementaire ou par ce dernier. |
Période de dispense modifiée | à venir |
Renseignements supplémentaires ajoutés à la demande | Lors de l'ajout de renseignements supplémentaires pour une demande de dispense soumise par un utilisateur soumis aux exigences d'une période réglementaire. |
Description des événements de ressource
Événement | Définition |
Activité en présence: Modification de l'emplacement | Lors de la modification de l'emplacement ou de la salle d'un emplacement associé à un élément « Activité en présence » dans une session de formation. |
Activité en présence: Modification de la date | Lors de la modification de la date d'un élément « Activité en présence » dans une session de formation. |
Activité en présence: Rappel d'activité | Lors de la tenue d'un élément « Activité en présence » dans une session de formation. |
Complétion: Points reçus lors de la complétion | à venir |
Complétion: Ressource complétée avec échec | Lors de la complétion en échec d'un élément ayant ces capacités dans une session de formation. |
Complétion: Ressource complétée avec succès | Lors de la complétion avec succès d'un élément ayant ces capacités dans une session de formation. |
Dépôt de travail: Correction par un formateur | Lors de l'évaluation par un administrateur d'un travail déposé par un participant dans un élément « Dépôt de travail » dans une session de formation. |
Dépôt de travail: Dépôt par l'apprenant | Lors du dépôt d'un travail par un participant dans un élément « Dépôt de travail » dans une session de formation. |
Dépôt de travail: Date d'expiration | Lors de l'atteinte de la date limite pour déposer un travail dans un élément « Dépôt de travail » dans une session de formation. |
Dépôt de travail: Date de début | à venir |
Dépôt de travail: Extension de la date limite | Lors de l'extention de la date limite de dépôt pour un participant dans un élément « Dépôt de travail » dans une session de formation. |
Dépôt de travail: Nouvelle tentative octroyée | Lors de l'ajout d'un tentative de dépôt pour un participant dans un élément « Dépôt de travail » dans une session de formation. |
Disponibilité: Date de début de disponibilité | à venir |
Disponibilité: Date de fin de disponibilité | à venir |
Disponibilité: Modification des conditions | Lors d'une modification sur les conditions de disponibilité d'un élément dans une session de formation, comme les dates de disponibilité ou les prérequis. |
Document / Vidéo : Mise à jour du fichier | Lors du remplacement du fichier déposé dans un élément « Document / Vidéo » d'une session de formation. |
Questionnaire: Correction reçue | Lors de la correction par un administrateur d'une réponse à une question ouverte d'un élément « Questionnaire » d'une session de formation. |
Questionnaire : Nouvelle réponse d'un participant | à venir |
Questionnaire : Nouvelle tentative reçue | à venir |
Questionnaire : Tentatives du questionnaire supprimées | à venir |
Webinaire/Classe virtuelle : Changement du rôle d'un utilisateur | Lors du changement de rôle dans un élément « Webinaire/Classe virtuelle ». |
Webinaire/Classe virtuelle : Enregistrement disponible | à venir |
Webinaire/Classe virtuelle : Exportation d'un enregistrement terminé | à venir |
Webinaire/Classe virtuelle : Modification de la date | Lors de la modification de la date d'un élément « Webinaire/Classe virtuelle ». |
Webinaire/Classe virtuelle : Rappel d'activité | à venir |
Webinaire/Classe virtuelle : Utilisateur désassocié de l'activité | Lors du retrait d'un participant d'un élément « Webinaire/Classe virtuelle ». |
Description des événements de programme de formation
Événement | Définition |
Achat en lot - Annulation | Lors de l'annulation d'une cohorte de programme de formation où ont été inscrits des utilisateurs par achat en lot. |
Achat en lot - Assignation à un programme | Lors de l'achat en lot de places pour une cohorte de programme de formation. |
Achat en lot - Confirmation d'achat | Lors de l'achat en lot de places pour une cohorte de programme de formation. |
Achat en lot - Libération de place | à venir |
Achat en lot - Révocation d'un programme assigné | Lors de la révoquation d'une place assignée à un utilisateur. |
Achat en lot - Sièges restants | à venir |
Annulation d'un programme de formation | Lorsqu'une cohorte de programme de formation est annulée par un administrateur. |
Changement de statut sur une inscription | Lorsque le statut d'inscription d'un utilisateur à une cohorte de programme de formation est modifié. |
Désinscription et transfert par l'organisation | Lors de l'annulation d'une cohorte de programme de formation ET du transfert des participants inscrits vers une autre cohorte. |
Désinscription par l'organisation | Lors de la désinscription d'un participant d'une cohorte de programme de formation par un administrateur. |
Désinscription par le participant | Lors de la désinscription autonome d'une cohorte de programme de formation par le participant. |
Date de début d'un programme de formation | Lors du début d'une cohorte de programme de formation. |
Date de fin d'un programme de formation | Lors de la fin d'une cohorte de programme de formation. |
Date limite de complétion d'un programme de formation | Lors de la limite de complétion d'une cohorte de programme de formation. |
Engagement - Engagement complété avec succès | à venir |
Engagement - Engagement complété en échec | à venir |
Engagement - Expiration de l'engagement | à venir |
Inscription - Paiement avec facturation | Lors d'une inscription unique à une cohorte de programme de formation avec méthode de paiement « Paiement par facturation ». |
Inscription approuvée | Lors de l'approbation de la demande d'inscription d'un participant dans le contexte d'une cohorte de programme de formation avec méthode d'autorisation « Approuvée par un administrateur » où la cohorte n'a pas de tarification. |
Inscription approuvée - Paiement requis | Lors de l'approbation de la demande d'inscription d'un participant dans le contexte d'une cohorte de programme de formation avec méthode d'autorisation « Approuvée par un administrateur » où il y a paiement. |
Inscription avec approbation | Lors d'une demande d'inscription à une cohorte de programme de formation avec méthode d'autorisation « Approuvée par un administrateur ». |
Inscription avec paiement en attente | Lors de l'inscription à une cohorte de programme de formation avec méthode de paiement par « Chèque » ou par « Argent comptant ». |
Inscription manuelle | Lors de l'inscription administrative/manuelle à une cohorte de programme de formation. |
Inscription refusée | Lors du refus de la demande d'inscription d'un participant dans le contexte d'une cohorte de programme de formation avec méthode d'autorisation « Approuvée par un administrateur » où la cohorte n'a pas de tarification. |
Inscription sans paiement | Lors de l'inscription à une cohorte de programme de formation sans paiement ou à 0$. |
Maximum d'inscriptions atteint | à venir |
Minimum d'inscriptions atteint | à venir |
Minimum d'inscriptions non atteint | à venir |
Nouvelle demande d'inscription à approuver | Lorsqu'une demande d'inscription est à approuver sur une cohorte de programme de formation avec méthode d'autorisation « Approuvée par un administrateur ». |
Octroi d'attestation | Lorsqu'une attestation a été émise dans le dossier d'un utilisateur, qui a atteint les exigences de complétion avec succès d'une cohorte de programme de formation. |
Paiement reçu pour inscription à un programme de formation | Lorsqu'une inscription unique avec paiement a lieu pour une cohorte de programme de formation. |
Programme de formation complété | Lors de la complétion d'une cohorte de programme de formation. |
Remboursement reçu d'une inscription | Lors d'un remboursement effectué sur une inscription à une cohorte de programme de formation. |
Suppression de l'inscription | à venir |