Reach 360 : API Webhooks

Ce que fait ce point de terminaison d'API

L'API Webhooks vous permet de créer ou de supprimer des webhooks à partir d'événements webhooks disponibles. Toute personne ayant accès à l'application à laquelle le webhook envoie les informations voit l'achèvement du module, la soumission du module 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 la liste des webhooks ou les détails d'un webhook spécifique.

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

Points de terminaison

• POST /webhooks- créer un nouveau webhook
• GET /webhooks- liste des 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(chaîne) - l'identifiant unique du webhook
• targetUrl(string) : URL du point de terminaison du webhook sur votre serveur
• sharedSecret(chaîne) - un 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 du webhook) - la liste des événements du 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 s'agira par défaut de l'API-Versionen-tête envoyé dans la demande ou, si cela n'est pas spécifié, de 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 terminal :

• duplicate_target_url- Impossible de créer un webhook cartargetUrl il 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) : 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érer 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 terminal :

• 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 réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au terminal :

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