Wat dit API-eindpunt doet

Met de Webhooks API maak of verwijder je webhooks van beschikbare webhook-evenementen. Degene die toegang heeft tot de app waar de webhook de informatie naartoe stuurt, ziet de voltooiing van de cursus, de inzending voor publicatie, de inschrijving van gebruikers en groepen voor cursussen en leertrajecten, of wanneer een gebruiker is toegevoegd aan je Reach 360-account.

Je kunt dit eindpunt ook gebruiken om een lijst met webhooks of details van een specifieke webhook op te vragen.

Opmerking: De Webhooks API ondersteunt het ondertekenen van berichten. Bij het aanmaken van een webhook kunt u eensharedSecret, die wordt gebruikt om voor elk verzoek een handtekening te genereren, zodat de authenticiteit van de ontvangen berichten wordt gegarandeerd.

• Eindpunten
• Objecten
• Webhook maken
• Webhooks weergeven
• Webhook ophalen met ID
• Webhook met ID verwijderen

Eindpunten

• POST /webhooks- maak een nieuwe webhook
• GET /webhooks- lijst met webhooks
• GET /webhooks/{webhookId}- verkrijg informatie over een webhook met behulp van een webhook-id
• DELETE /webhooks/{webhookId}- verwijder een webhook met webhook-id

Objecten

• id(string) - de unieke identificator van de webhook
• targetUrl(string) - de URL van het webhook-eindpunt op uw server
• sharedSecret(string) - een geheim dat wordt gebruikt om voor elk verzoek een handtekening te genereren. Wordt alleen geretourneerd bij het aanmaken van een webhook
• events(lijst met webhook-evenementen) - de lijst met webhook-evenementen die voor deze webhook zijn ingeschakeld
• apiVersion(string) - API-versie die wordt gebruikt bij het verzenden van de webhook-gebeurtenis

Webhook maken

POST /webhooks

Parameters aanvragen (JSON)

• targetUrl(tekenreeks, vereist)
• events(lijst met webhook-evenementen, vereist)
• sharedSecret(string, optioneel)
• apiVersion(string, optioneel) - API-versie om te gebruiken voor de webhook-gebeurtenis. Indien niet opgegeven, wordt standaard de API-Version koptekst gebruikt die in de aanvraag is verzonden, of, als dat niet is gespecificeerd, de oorspronkelijke API-versie, 2023-04-04

Voorbeeldreactie

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

Endpoint-specifieke foutcodes:

• duplicate_target_url- kan geen webhook aanmaken omdat deze al door een andere webhook wordt gebruikt. targetUrl In dit geval wordt een 409-antwoord geretourneerd

Webhooks weergeven

GET /webhooks

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 2000 liggen (standaard 50)

Voorbeeldreactie

{
  "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 ophalen met ID

ONTVANG /webhooks/ {WebHookID}

Voorbeeldreactie

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

Endpoint-specifieke foutcodes:

• webhook_not_found- kan webhook niet ophalen omdat de webhook niet bestaat

Webhook met ID verwijderen

/webhooks/ {WebHookID} VERWIJDEREN

Reactie op succes

204 „Geen inhoud”

Endpoint-specifieke foutcodes:

• webhook_not_found- kan webhook niet verwijderen omdat de webhook niet bestaat