Passer au contenu
Français
  • Il n'y a aucune suggestion car le champ de recherche est vide.

Utiliser l’API publique et les webhooks de TeachUp

L’API publique de Teach Up vous permet de connecter vos systèmes externes à votre espace TeachUp pour automatiser certaines actions ou récupérer des données. Les webhooks, quant à eux, permettent d’être notifié en temps réel lorsque des événements se produisent sur la plateforme.

Sommaire

 

La fonctionnalité « API & Webhooks » est une option additionnelle dans Teach Up. Pour plus d'informations sur son activation, contactez notre équipe support.


Présentation de l'API

L’API publique de TeachUp (v1) permet d’automatiser des échanges de données entre votre système et TeachUp.

Gérer les clés d’API

Pour générer une clé d’API, suivez les étapes ci-dessous :

  • Connectez-vous à https://app.teachup.com avec un compte concepteur et administrateur.

  • Accédez à l’onglet « Abonnement & configuration ».

  • Descendez jusqu’à la section « Clés API personnelles ».

  • Créez une nouvelle clé et enregistrez le secret affiché (il ne s'affichera qu'une seule fois).

Utiliser une clé d’API

Pour authentifier vos requêtes :

  • Utilisez un bearer token dans l'en-tête Authorization :

     
    Authorization: Bearer <votre_clé_API>

TeachUp ne conserve aucune trace des clés créées. En cas de perte ou de doute sur la sécurité, supprimez la clé et générez-en une nouvelle.

Explorer la documentation interactive

L’ensemble des endpoints disponibles est consultable ici :
👉 https://api.teachup.com/swagger

Elle vous permet :

  • de consulter tous les endpoints disponibles avec leurs paramètres et réponses détaillées,

  • d’entrer directement votre clé API pour tester les requêtes en temps réel depuis l’interface,

  • d’explorer les formats de réponse renvoyés par TeachUp.

Cas d’usage concrets

    • Créez un participant dès son arrivée dans votre entreprise → POST /api/v2/learners

    • Listez tous les participants pour synchroniser vos outils internes → GET /api/v2/learners

    • Mettez à jour les informations d’un participant → PUT /api/v2/learners/{learnerId}

    • Suivez les formations attribuées à un participant → GET /api/v2/learners/{learnerId}/AssignedActivities

    • Récupérez la liste complète des formations disponibles → GET /api/v1/activities

    • Vérifiez quels participants sont inscrits à une activité → GET /api/v1/activities/{activityId}/AssignedLearners

    • Assignez une formation à plusieurs participants → POST /api/v1/assignments

    • Retirez une formation assignée → DELETE /api/v1/assignments

    • Créez un groupe de participants automatiquement → POST /api/v1/groups

    • Gérez l’appartenance d’un participant à un groupe → PUT ou DELETE /api/v1/groups/{groupId}/learners/{learnerId}

    • Ajoutez un participant à un département ou bannissez-le → PUT /api/v1/departments/{departmentId}/learners/{learnerId} et /ban@


Mettre en place des webhooks

Les webhooks permettent à TeachUp d’envoyer des requêtes HTTP vers votre système lorsqu’un événement spécifique a lieu.

Créer et gérer des webhooks

Pour configurer vos webhooks :

  • Connectez-vous à https://app.teachup.com avec un compte administrateur.

  • Ouvrez « Abonnement & configuration ».

  • Accédez à la section « Webhooks ».

  • Ajoutez une URL de réception et sélectionnez les événements à surveiller.

Connaître les événements disponibles

Deux événements sont disponibles :

  • learner.created : lorsqu’un participant est ajouté.

  • learner.modified : lorsqu’un participant est modifié.

Exemple de payload JSON :

{
"webhookVersion": "1.0",
"createdAt": "2024-07-23T14:37:05.367Z",
"type": "learner.created",
"data": {
"id": "abc123",
"firstname": "John",
"lastname": "Doe",
"groups": ["Equipe1"],
"language": "fr-FR"
}
}

 

Vérifier la provenance d’un événement

Chaque événement envoyé par webhook inclut une signature :

  • L'en-tête X-Teachup-Webhook-Signature contient un hash HMACSHA256.

  • Ce hash est calculé avec le secret unique de votre webhook.

  • Pour valider l’authenticité :

    1. Récupérez le contenu brut de la requête.

    2. Recalculez le hash.

    3. Comparez-le à la signature reçue.

Il est fortement recommandé d’ignorer tout webhook dont la signature est incorrecte.

Questions fréquentes

Puis-je générer plusieurs clés API pour une même organisation ?
Oui, vous pouvez créer plusieurs clés selon vos besoins (par environnement, application ou service).

Que faire si j’ai perdu ma clé API ?
Supprimez immédiatement la clé depuis l’interface et créez-en une nouvelle. Le secret est affiché une seule fois.

Puis-je filtrer les webhooks par groupe ou module ?
Non, les webhooks actuels sont déclenchés à chaque événement global. Il n’est pas encore possible de filtrer plus finement.