Aller au contenu

Guides

Webhook d’inscription historique

POST /v1/webhooks/users reste servi pour les intégrations existantes. Il crée ou met à jour un apprenant, l’inscrit à une diffusion et lui envoie l’invitation.

{ "email": "ada@example.org", "firstname": "Ada", "lastname": "Lovelace", "sessionId": "12" }

Changements pour les intégrateurs existants

Le chemin, la méthode, le corps de la requête et la réponse de succès (201, corps vide) sont inchangés. Les règles suivantes s’appliquent désormais :

SituationAvantDésormais
Compte désactivé ou suppriméRéactivé409 account_suspended, compte inchangé
Compte géré par une source d’identité (SCIM)Mis à jour409 account_managed
Adresse e-mail invalideSouvent acceptée400 validation_failed, 255 caractères au plus
Prénom ou nom omisEffacé sur un compte existantConservé
Diffusion inconnue400400 session_not_found
Corps d’erreurMessage texteapplication/problem+json, avec un code stable
Jeton absent ou inconnu401401 invalid_token
Organisation désactivée ou fonctionnalité ferméeAccepté403 module_unavailable
Plus de 600 requêtes par minuteAccepté429 rate_limited avec Retry-After
Service momentanément indisponible400503 temporarily_unavailable avec Retry-After
Échec d’envoi de l’invitationCréation annuléeCompte et inscription conservés ; l’invitation se renvoie depuis l’administration

Également :

  • chaque réponse obtenue avec le jeton historique porte l’en-tête Deprecation ;
  • un jeton OAuth avec les scopes users:write et enrollments:write est accepté sur ce chemin ;
  • l’en-tête facultatif Idempotency-Key évite un second envoi d’invitation lors d’un rejeu. Sans lui, un rejeu inscrit sans doublon et renvoie l’invitation, comme avant.

À vérifier de votre côté : traitez 409 comme un refus définitif à signaler à un administrateur, 429 et 503 comme des erreurs temporaires à réessayer après Retry-After, et lisez le champ code plutôt que le texte du message.

Migrer

  1. Faites créer un client d’intégration avec users:write et enrollments:write.
  2. Obtenez un jeton par client_credentials.
  3. Remplacez l’appel par POST /api/v1/enrollments :
{ "sessionId": 12, "user": { "email": "ada@example.org", "firstname": "Ada", "lastname": "Lovelace" }, "invite": true }
  1. Demandez la suppression du jeton historique une fois la bascule faite.

Une date de fin de service sera annoncée par l’en-tête Sunset lorsque les organisations concernées auront migré.