Ce que fait ce point de terminaison d'API

Avec l'API Webhooks, vous pouvez créer ou supprimer des webhooks à partir des événements Webhooks disponibles. Toute personne ayant accès à l'application à laquelle le webhook envoie les informations voit la fin du cours, sa soumission pour publication, l'inscription des utilisateurs et des groupes aux cours et aux parcours d'apprentissage, ou lorsqu'un utilisateur est ajouté à votre compte Reach 360.

Vous pouvez également utiliser ce point de terminaison pour obtenir une liste de webhooks ou les détails d'un webhook spécifique.

Remarque : L'API Webhooks prend en charge la signature des messages. Lors de la création d'un webhook, vous pouvez spécifier unsharedSecret, qui est utilisé pour générer une signature pour chaque demande, garantissant ainsi l'authenticité des messages reçus.

• Points de terminaison
• Objets
• Créer un webhook
• Liste des webhooks
• Récupérez le webhook par identifiant
• Supprimer le webhook par identifiant

Points de terminaison

• POST /webhooks- créer un nouveau webhook
• GET /webhooks- liste les webhooks
• GET /webhooks/{webhookId}- obtenir les détails d'un webhook par identifiant de webhook
• DELETE /webhooks/{webhookId}- supprimer un webhook par identifiant de webhook

Objets

• id(string) - l'identifiant unique du webhook
• targetUrl(string) : URL du point de terminaison du webhook sur votre serveur
• sharedSecret(chaîne) : secret utilisé pour générer une signature pour chaque demande. Renvoyé uniquement lors de la création d'un webhook
• events(liste des événements webhook) : liste des événements webhook activés pour ce webhook
• apiVersion(string) - Version de l'API utilisée lors de l'envoi de l'événement webhook

Créer un webhook

POST /webhooks

Paramètres de demande (JSON)

• targetUrl(chaîne, obligatoire)
• events(liste des événements liés au webhook, obligatoire)
• sharedSecret(chaîne, facultatif)
• apiVersion(chaîne, facultatif) - Version de l'API à utiliser pour l'événement webhook. S'il n'est pas fourni, il utilisera par défaut l'API-Versionen-tête envoyé dans la demande ou, si cela n'est pas spécifié, la version initiale de l'API, 2023-04-04

Exemple de réponse

{
  "id": "example-webhook-id",
  "targetUrl": "<https://example.com>",
  "events": ["course.completed", "user.created"],
  "sharedSecret": "the shared secret",
  "apiVersion": "2023-05-04",
  "url": "<https://api.reach360.com/webhooks/example-webhook-id>",
}

Codes d'erreur spécifiques au point de terminaison :

• duplicate_target_url- Impossible de créer un webhook car il targetUrl est déjà utilisé par un autre webhook. Une réponse 409 sera renvoyée dans ce cas.

Liste des webhooks

GET /webhooks

Paramètres de demande (chaîne de requête)

• limit(entier, facultatif) - le nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 2 000 (50 par défaut)

Exemple de réponse

{
  "webhooks": [
    {
      "id": "example-webhook-id",
      "targetUrl**":** "<https://example.com>",
      "events": ["course.completed", "user.created"],
      "apiVersion": "2023-05-04",
      "url": "<https://api.reach360.com/webhooks/example-webhook-id>"
    ****}, ...
  ],
  "nextUrl": "<https://url-for-next-page-of-results>"
}

Récupérez le webhook par identifiant

OBTENEZ /webhooks/ {WebHookId}

Exemple de réponse

{
  "id": "example-webhook-id",
  "targetUrl": "<https://example.com>",
  "events": ["course.completed", "user.created"],
  "apiVersion": "2023-05-04",
  "url": "<https://api.reach360.com/webhooks/example-webhook-id>"
****}

Codes d'erreur spécifiques au point de terminaison :

• webhook_not_found- Impossible de récupérer le webhook car le webhook n'existe pas

Supprimer le webhook par identifiant

SUPPRIMER /webhooks/ {webhookId}

Réponse positive

204 « Aucun contenu »

Codes d'erreur spécifiques au point de terminaison :

• webhook_not_found- Impossible de supprimer le webhook car le webhook n'existe pas