Qué hace este punto final de API

Con la API de Webhooks, puede crear o eliminar webhooks de los eventos de webhooks disponibles. Quien tenga acceso a la aplicación a la que el webhook envía la información verá cómo ha finalizado el curso, si el curso se ha enviado para su publicación, si los usuarios y grupos se han inscrito en los cursos y las rutas de aprendizaje, o cuando se añade un usuario a su cuenta de Reach 360.

También puedes usar este punto final para obtener una lista de webhooks o los detalles de un webhook específico.

Nota: La API de Webhooks admite la firma de mensajes. Al crear un webhook, puedes especificar unsharedSecret, que se utiliza para generar una firma para cada solicitud, lo que garantiza la autenticidad de los mensajes recibidos.

• Puntos finales
• Objetos
• Crear Webhook
• Lista de webhooks
• Recupera Webhook por ID
• Eliminar Webhook por ID

Puntos finales

• POST /webhooks- crear un nuevo webhook
• GET /webhooks- lista de webhooks
• GET /webhooks/{webhookId}- obtener los detalles de un webhook mediante el identificador del webhook
• DELETE /webhooks/{webhookId}- eliminar un webhook por su identificador

Objetos

• id(cadena): el identificador único del webhook
• targetUrl(cadena): la URL del punto final del webhook en su servidor
• sharedSecret(cadena): un secreto que se utiliza para generar una firma para cada solicitud. Solo se devuelve al crear un webhook
• events(lista de eventos de webhook): la lista de eventos de webhook habilitados para este webhook
• apiVersion(string): versión de API utilizada al enviar el evento de webhook

Crear Webhook

POST /webhooks

Parámetros de solicitud (JSON)

• targetUrl(cadena, obligatorio)
• events(lista de eventos de webhook, obligatoria)
• sharedSecret(cadena, opcional)
• apiVersion(cadena, opcional): versión de API que se utilizará en el evento webhook. Si no se proporciona, se utilizará de forma predeterminada el API-Version encabezado enviado en la solicitud o, si no se especifica, la versión de API inicial, 2023-04-04

Ejemplo de respuesta

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

Códigos de error específicos del punto final:

• duplicate_target_url- no se puede crear un webhook porque otro webhook ya lo targetUrl está utilizando. En este caso, se devolverá una respuesta 409

Enumere los webhooks

GET /webhooks

Parámetros de solicitud (cadena de consulta)

• limit(entero, opcional): el número máximo de resultados que se devolverán en una sola respuesta (consulte Paginación); debe estar entre 1 y 2000 (el valor predeterminado es 50)

Ejemplo de respuesta

{
  "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 por ID

OBTENGA /webhooks/ {webHookID}

Ejemplo de respuesta

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

Códigos de error específicos del punto final:

• webhook_not_found- no se puede recuperar el webhook porque el webhook no existe

Eliminar Webhook por ID

ELIMINAR /webhooks/ {webHookID}

Respuesta exitosa

204 «Sin contenido»

Códigos de error específicos del punto final:

• webhook_not_found- no se puede eliminar el webhook porque el webhook no existe