Co robi ten punkt końcowy API

Za pomocą interfejsu API Webhooks tworzysz lub usuwasz webhooki z dostępnych zdarzeń webhook. Każdy, kto ma dostęp do aplikacji, w której webhook wysyła informacje, widzi ukończenie kursu, przesłanie kursu do publikacji, rejestrację użytkowników i grup na kursy i ścieżki edukacyjne lub gdy użytkownik zostanie dodany do Twojego konta Reach 360.

Możesz również użyć tego punktu końcowego, aby uzyskać listę webhooks lub szczegóły konkretnego webhook.

Uwaga: Interfejs API Webhooks obsługuje podpisywanie wiadomości. Podczas tworzenia webhook można określićsharedSecret, który służy do generowania podpisu dla każdego żądania, zapewniając autentyczność otrzymanych wiadomości.

• Punkty końcowe
• Obiekty
• Utwórz Webhook
• Lista webhooks
• Pobierz Webhook według identyfikatora
• Usuń Webhook według identyfikatora

Punkty końcowe

• POST /webhooks- utwórz nowy webhook
• GET /webhooks- lista webhooks
• GET /webhooks/{webhookId}- uzyskać szczegółowe informacje na temat webhook według identyfikatora webhook
• DELETE /webhooks/{webhookId}- usuń webhook za pomocą identyfikatora webhook

Obiekty

• id(string) - unikalny identyfikator webhook
• targetUrl(string) - adres URL punktu końcowego webhook na serwerze
• sharedSecret(string) - sekret używany do generowania podpisu dla każdego żądania. Zwracane tylko podczas tworzenia webhook
• events(lista zdarzeń webhook) - lista zdarzeń webhook włączonych dla tego webhook
• apiVersion(string) - Wersja API używana podczas wysyłania zdarzenia webhook

Utwórz Webhook

POST /webhooks

Parametry żądania (JSON)

• targetUrl(ciąg znaków, wymagane)
• events(lista zdarzeń webhook, wymagane)
• sharedSecret(ciąg, opcjonalnie)
• apiVersion(string, opcjonalne) - Wersja API do użycia dla zdarzenia webhook. Jeśli nie podano, domyślnie zostanie wyświetlony API-Version nagłówek wysłany w żądaniu lub, jeśli nie jest to określone, początkowa wersja API, 2023-04-04

Przykładowa odpowiedź

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

Kody błędów specyficzne dla punktu końcowego:

• duplicate_target_url- nie można utworzyć webhook, ponieważ targetUrl jest już używany przez inny webhook. W takim przypadku zostanie zwrócona odpowiedź 409

Lista webhooks

GET /webhooks

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 2000 (domyślnie 50)

Przykładowa odpowiedź

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

Pobierz Webhook według identyfikatora

GET /webhooks/ {WebHookId}

Przykładowa odpowiedź

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

Kody błędów specyficzne dla punktu końcowego:

• webhook_not_found- nie można pobrać webhook, ponieważ webhook nie istnieje

Usuń Webhook według identyfikatora

USUŃ /webhooks/ {WebHookId}

Odpowiedź na sukces

204 „Brak treści”

Kody błędów specyficzne dla punktu końcowego:

• webhook_not_found- nie można usunąć webhook, ponieważ webhook nie istnieje