WebHooks
Usage des Webhooks
Les webhooks de VTS Perform vous permettent de créer un connecteur bi-directionnel en réagissant aux évènements des 2 plateformes.
VTS Perform possède donc des Webhooks "entrants" (réponse aux évènements survenus dans la plateforme tierce) et "sortants" (envoi des évènements survenus dans VTS Perform).
Activation des Webhooks
Pour activer les Webhook, cliquez sur le bouton "Activer les Webhooks".
Structure des Webhooks
Les webhooks reçus doivent respecter le format suivant :
{
"event" : "xxx",
"timestamp" : "xxxx",
"tenant_id": "identifiant généré par VTS Perform",
"data" :{"payload"}
}
Les webhooks envoyés ont le format suivant :
{
"event" : "xxx",
"timestamp" : "xxxx",
"lms_name": "VTS Perform",
"tenant_id": "identifiant généré par VTS Perform",
"data" :{"payload"}
}
Signature des Webhooks
Afin que les webhooks soient authentifiés et vérifiés, VTS Perform utilise un mécanisme de signature via un header "signature".
Le contenu de ce header doit correspondre au contenu de la requête qui sera encodé avec le protocole HMAC/SHA256 et une clé privée qui doit être partagée entre les 2 plateformes.
Exemple de signature avec PHP:
$signature = hash_hmac('sha256', $contenu_de_la_requete_brut, $secret);
URL des Webhooks entrants
L'adresse à laquelle les webhooks entrants doivent être envoyés est :
https://my.vtsperform.com/api/webhooks/
Évènements entrants autorisés
Avant de pouvoir recevoir des évènements Webhooks, il est nécéssaire de les autoriser pour votre connecteur.
Pour activer un évènement, il vous suffit de cliquer dessus.
Évènements sortants autorisés
VTS Perform peut également envoyer des webhooks vers une plateforme tierce en réponse à un évènement interne.
Pour activer un webhook, il vous suffit de cliquer dessus.
Une fois un webhook activé, il vous sera possible de définir l'url cible pour cet évènement.
- ${ child.title }