WebHooks - Évènements entrants
Vous trouverez ci-dessous la liste des évènements entrants supportés par VTS Perform. Cette fonctionnalité étant en BETA, la liste des évènements est limitée. Si vous avez besoin de nouveaux évènements, faites-nous en la demande via notre support technique
user.created
Créé un nouvel utilisateur dans votre instance. Si l'utilisateur existe déjà (email ou login connu), alors l'utilisateur est mis à jour.
Paramètres:
Paramètre | Type | Description |
firstname* | string | Le prénom de l'utilisateur |
lastname* | string | Le nom de l'utilisateur |
string | L'email de l'utilisateur | |
login | string | Le login de l'utilisateur s'il n'a pas d'adresse email |
password* | string | (optionnel si l'utilisateur a un email - obligatoire sinon) Le mot de passe de l'utilisateur. Le mot de passe doit respecter les contraintes de complexité. Si aucun mot de passe n'est fourni, l'utilisateur en créera un lors de sa première connexion. |
locale | string | La langue de l'utilisateur. Peut être 'fr' ou 'en'. Prend la langue par défaut de l'instance si le champ n'est pas défini. |
country | string | Le code pays (ISO 3166-1 alpha-2) de l'utilisateur |
region | string | La région de l'utilisateur |
city | string | La ville de l'utilisateur |
address | string | L'adresse de l'utilisateur |
zip | string | Le code postal de l'utilisateur |
company | string | L'entreprise de l'utilisateur |
service | string | Le service de l'utilisateur |
function | string | Le métier de l'utilisateur |
registration_number | string | Le matricule de l'utilisateur |
phone | string | Le téléphone de l'utilisateur |
birthdate | datetime | La date de naissance de l'utilisateur (format YYYY-MM-JJ) |
external_id | integer | Identifiant de l'utilisateur dans une plateforme tierce |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
user.updated
Modifie les informations d'un utilisateur existant.
Paramètres:
Paramètre | Type | Description |
user_id* | integer | L'identifiant de l'utilisateur |
firstname | string | Le prénom de l'utilisateur |
lastname | string | Le nom de l'utilisateur |
locale | string | La langue de l'utilisateur. Peut être 'fr' ou 'en'. Prend la langue par défaut de l'instance si le champ n'est pas défini. |
country | string | Le code pays (ISO 3166-1 alpha-2) de l'utilisateur |
region | string | La région de l'utilisateur |
city | string | La ville de l'utilisateur |
address | string | L'adresse de l'utilisateur |
zip | string | Le code postal de l'utilisateur |
company | string | L'entreprise de l'utilisateur |
service | string | Le service de l'utilisateur |
function | string | Le métier de l'utilisateur |
registration_number | string | Le matricule de l'utilisateur |
phone | string | Le téléphone de l'utilisateur |
birthdate | datetime | La date de naissance de l'utilisateur (format YYYY-MM-JJ) |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
user.deleted
Supprime une utilisateur de votre instance.
Paramètres:
Paramètre | Type | Description |
user_id* | integer | Le prénom de l'utilisateur |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
session.created
Créé une nouvelle session dans votre instance.
Paramètres:
Paramètre | Type | Description |
activity_ids* | array | Tableau contenant la liste des activités à ajouter dans la session |
name* | string | Le nom de la session |
description | string | La description de la session |
start_date | datetime | Date de début de la session (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-01 09:00) |
end_date | datetime | (optionnel) La date de fin de la session. Si elle n'est pas fournie, la session est toujours disponible. (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-31 23:59) |
duration | integer | (optionnel) Le nombre de jours pendant lesquels la session sera disponible pour les participants une fois qu'ils auront été invités. Si défini, le champ end_date sera ignoré. |
external_id | integer | Identifiant de la session dans une plateforme tierce |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
session.updated
Modifie une session existante.
Paramètres:
Paramètre | Type | Description |
session_id* | integer | Identifiant de la session |
activity_ids* | array | Tableau contenant la liste des activités à ajouter dans la session |
name* | string | Le nom de la session |
description | string | La description de la session |
start_date | datetime | Date de début de la session (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-01 09:00) |
end_date | datetime | (optionnel) La date de fin de la session. Si elle n'est pas fournie, la session est toujours disponible. (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-31 23:59) |
duration | integer | (optionnel) Le nombre de jours pendant lesquels la session sera disponible pour les participants une fois qu'ils auront été invités. Si défini, le champ end_date sera ignoré. |
external_id | integer | Identifiant de la session dans une plateforme tierce |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
session.deleted
Paramètres:
Paramètre | Type | Description |
session_id* | integer | L'identifiant de la session |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
enrolment.created
Ajoute un utilisateur à une session.
Paramètres:
Paramètre | Type | Description |
user_id* | integer | Identifiant de l'utilisateur à ajouter dans la session |
session_id* | integer | Identifiant de la session |
end_date | datetime | (optionnel) Date limite d'accès pour ce participant. Ce champ est ignoré si la session n'est pas configurée avec une durée de disponibilité (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-31 23:59) |
send_notification | boolean | Envoi immédiatement le mail d'invitation défini dans les paramètres de la session. |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
enrolment.updated
Modifie une inscription.
Paramètres:
Paramètre | Type | Description |
enrolment_id* | integer | L'identifiant de l'inscription |
end_date | datetime | (optionnel) Date limite d'accès pour ce participant. Ce champ est ignoré si la session n'est pas configurée avec une durée de disponibilité (format YYYY-MM-JJ HH:MM. Exemple: 2024-01-31 23:59) |
send_notification | boolean | Envoi immédiatement le mail d'invitation défini dans les paramètres de la session. |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
enrolment.deleted
Paramètres:
Paramètre | Type | Description |
enrolment_id* | integer | L'identifiant de l'inscription |
Réponses:
Code | Exemple |
200 (OK) |
{ |
400 (Bad request) |
{ |
401 (Unauthorized) |
{ |
403 (Forbidden) |
{ |
404 (Not Found) |
{ |
- ${ child.title }