Browse Articles

Browse Articles

Reach 360: API de Webhooks

Artículo actualizado el

Este artículo se aplica a:

Reach 360

Qué hace este terminal de API

Con la API de Webhooks, puedes crear o eliminar webhooks de los eventos de webhook disponibles. Quien tenga acceso a la aplicación a la que el webhook envía la información podrá ver la finalización del curso, el envío del curso para su publicación, la inscripción de usuarios y grupos en los cursos y 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 detalles de un webhook específico.


Puntos finales

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

Objetos

  • id(cadena): el identificador único del webhook
  • targetUrl(cadena): la URL del extremo del webhook de tu 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 webhook

Crear Webhook

POST /webhooks

Parámetros de solicitud (JSON)

  • targetUrl(cadena, obligatoria)
  • 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 elAPI-Version encabezado enviado en la solicitud o, si no se especifica, la versión de la 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 de endpoints:

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

Listar Webhooks

GET /webhooks

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se pueden devolver 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>"
}

Recuperar 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 de endpoints:

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

Eliminar Webhook por ID

ELIMINAR /webhooks/ {webHookID}

Respuesta de éxito

204 «Sin contenido»

Códigos de error específicos de endpoints:

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