Browse Articles

Browse Articles

Reach 360: Webhooks-API

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

Reach 360

Was dieser API-Endpunkt macht

Mit der Webhooks-API erstellen oder löschen Sie Webhooks aus verfügbaren Webhook-Ereignissen. Wer Zugriff auf die App hat, an die der Webhook die Informationen sendet, sieht den Abschluss des Kurses, die Einreichung von Kursen zur Veröffentlichung, die Benutzer- und Gruppenanmeldungen 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.


Endpunkte

  • POST /webhooks- erstelle einen neuen Webhook
  • GET /webhooks- Webhooks auflisten
  • GET /webhooks/{webhookId}- Details eines Webhooks anhand der Webhook-ID abrufen
  • DELETE /webhooks/{webhookId}- lösche einen Webhook anhand der Webhook-ID

Objekte

  • id(string) - die eindeutige Kennung 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 zurückgegeben, wenn ein Webhook erstellt wurde
  • events(Liste der Webhook-Ereignisse) - Die Liste der für diesen Webhook aktivierten Webhook-Ereignisse
  • apiVersion(string) — API-Version, die beim Senden des Webhook-Ereignisses verwendet wird

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. Wenn nicht angegeben, wird standardmäßig der in der Anfrage gesendeteAPI-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- kann keinen Webhook erstellen, da er bereits von einem anderen Webhook verwendet wird.targetUrl In diesem Fall wird eine 409-Antwort zurückgegeben.

Webhooks auflisten

GET /webhooks

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 2000 liegen (der Standardwert ist 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 anhand der ID abrufen

HOLEN SIE SICH /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- Webhook kann nicht abgerufen werden, da der Webhook nicht existiert

Webhook anhand der ID löschen

/webhooks/ {webhookID} LÖSCHEN

Antwort auf Erfolg

204 „Kein Inhalt“

Endpunktspezifische Fehlercodes:

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