Cosa fa questo endpoint API

Con l'API Webhooks puoi creare o eliminare webhook dagli eventi webhook disponibili. Chiunque abbia accesso all'app a cui il webhook invia le informazioni vede il completamento del corso, l'invio del corso per la pubblicazione, l'iscrizione di utenti e gruppi ai corsi e ai percorsi di apprendimento o quando un utente viene aggiunto al proprio account Reach 360.

È inoltre possibile utilizzare questo endpoint per ottenere un elenco di webhook o i dettagli di un webhook specifico.

Nota: l'API Webhooks supporta la firma dei messaggi. Quando si crea un webhook, è possibile specificare asharedSecret, che viene utilizzato per generare una firma per ogni richiesta, garantendo l'autenticità dei messaggi ricevuti.

• Endpoint
• Oggetti
• Crea Webhook
• Elenca i webhook
• Recupera Webhook per ID
• Elimina Webhook per ID

Endpoint

• POST /webhooks- crea un nuovo webhook
• GET /webhooks- elenca i webhook
• GET /webhooks/{webhookId}- ottieni i dettagli di un webhook tramite webhook id
• DELETE /webhooks/{webhookId}- elimina un webhook tramite webhook id

Oggetti

• id(stringa) - l'identificatore univoco del webhook
• targetUrl(string) - l'URL dell'endpoint webhook sul tuo server
• sharedSecret(stringa): un segreto utilizzato per generare una firma per ogni richiesta. Restituito solo durante la creazione di un webhook
• events(elenco di eventi webhook): l'elenco degli eventi webhook abilitati per questo webhook
• apiVersion(stringa) - Versione API utilizzata per l'invio dell'evento webhook

Crea Webhook

POST /webhooks

Parametri di richiesta (JSON)

• targetUrl(stringa, obbligatoria)
• events(elenco degli eventi webhook, obbligatorio)
• sharedSecret(stringa, opzionale)
• apiVersion(stringa, opzionale) - Versione dell'API da utilizzare per l'evento webhook. Se non viene fornita, verrà utilizzata per impostazione predefinita l'API-Versionintestazione inviata nella richiesta o, se non è specificata, la versione iniziale dell'API, 2023-04-04

Esempio di risposta

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

Codici di errore specifici dell'endpoint:

• duplicate_target_url- impossibile creare un webhook perché targetUrl è già utilizzato da un altro webhook. In questo caso verrà restituita una risposta 409

Elenca i webhook

GET /webhooks

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 2000 (il valore predefinito è 50)

Esempio di risposta

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

Recupera Webhook per ID

OTTIENI /webhooks/ {webhookID}

Esempio di risposta

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

Codici di errore specifici dell'endpoint:

• webhook_not_found- impossibile recuperare il webhook perché il webhook non esiste

Elimina Webhook per ID

ELIMINA /webhooks/ {webhookID}

Risposta di successo

204 «Nessun contenuto»

Codici di errore specifici dell'endpoint:

• webhook_not_found- impossibile eliminare il webhook perché il webhook non esiste