Was dieser API-Endpunkt macht

Mit der Webhooks-API erstellen oder löschen Sie Webhooks aus verfügbaren Webhook-Ereignissen. Jeder, der Zugriff auf die App hat, an die der Webhook die Informationen sendet, sieht den Abschluss des Kurses, die Einreichung des Kurses zur Veröffentlichung, die Registrierung von Benutzern und Gruppen für Kurse und Lernpfade oder wenn ein Benutzer zu Ihrem Reach 360-Konto hinzugefügt wird.

Sie können diesen Endpunkt auch verwenden, um eine Liste von Webhooks oder Details zu einem bestimmten Webhook abzurufen.

Hinweis: Die Webhooks-API unterstützt das Signieren von Nachrichten. Beim Erstellen eines Webhooks können Sie einen angeben, der verwendet wirdsharedSecret, um für jede Anfrage eine Signatur zu generieren und so die Authentizität der empfangenen Nachrichten sicherzustellen.

• Endpunkte
• Objekte
• Webhook erstellen
• Webhooks auflisten
• Webhook nach ID abrufen
• Webhook nach ID löschen

Endpunkte

• POST /webhooks- erstelle einen neuen Webhook
• GET /webhooks- listet Webhooks auf
• GET /webhooks/{webhookId}- Details zu einem Webhook anhand der Webhook-ID abrufen
• DELETE /webhooks/{webhookId}- löscht einen Webhook anhand der Webhook-ID

Objekte

• id(string) — der eindeutige Bezeichner des Webhooks
• targetUrl(string) — die URL des Webhook-Endpunkts auf Ihrem Server
• sharedSecret(string) — ein Geheimnis, das verwendet wird, um für jede Anfrage eine Signatur zu generieren. Wird nur beim Erstellen eines Webhooks zurückgegeben
• events(Liste der Webhook-Ereignisse) — Die Liste der Webhook-Ereignisse, die für diesen Webhook aktiviert sind
• apiVersion(string) — API-Version, die beim Senden des Webhook-Ereignisses verwendet wurde

Webhook erstellen

POST /webhooks

Anforderungsparameter (JSON)

• targetUrl(Zeichenfolge, erforderlich)
• events(Liste der Webhook-Ereignisse, erforderlich)
• sharedSecret(Zeichenfolge, optional)
• apiVersion(string, optional) — API-Version, die für das Webhook-Ereignis verwendet werden soll. Falls nicht angegeben, wird standardmäßig der in der Anfrage gesendete API-Version Header verwendet, oder, falls dieser nicht angegeben ist, die ursprüngliche API-Version, 2023-04-04

Beispiel für eine Antwort

{
  "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>",
}

Endpunktspezifische Fehlercodes:

• duplicate_target_url- Der Webhook kann nicht erstellt werden, da der targetUrl bereits von einem anderen Webhook verwendet wird. In diesem Fall wird eine 409-Antwort zurückgegeben

Webhooks auflisten

GET /webhooks

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 2000 liegen (standardmäßig 50)

Beispiel für eine Antwort

{
  "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>"
}

Webhook nach ID abrufen

ERHALTE /webhooks/ {webhookID}

Beispiel für eine Antwort

{
  "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>"
****}

Endpunktspezifische Fehlercodes:

• webhook_not_found- Der Webhook kann nicht abgerufen werden, da der Webhook nicht existiert

Löscht den Webhook nach ID

LÖSCHEN SIE /webhooks/ {WebHookID}

Erfolgreiche Antwort

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

• webhook_not_found- Der Webhook kann nicht gelöscht werden, da der Webhook nicht existiert