Administrar webhooks

Koibox permite utilizar webhooks para automatizar algunos procesos cuando suceden ciertas acciones. Para ello, primero debes registrar un webhook con Koibox, puedes hacerlo directamente desde el panel o desde la API.

Gestionar webhooks desde el panel

Puedes acceder al panel de webhooks desde Configuración > Webhooks.

Puedes crear nuevos webhooks y activar, desactivar o eliminar los existentes. Es posible que no puedas gestionar todos los webhooks directamente desde aquí debido a que una aplicación haya indicado que lo gestiona ella, en ese caso solo puede gestionarse mediante la API.

Crear un nuevo webhook

Puedes crear un webhook desde el botón Nuevo Webhook, esto abrirá un formulario para que rellenes la información acerca del mismo.

Tan solo hace falta que agruegues la URL del webhook, el evento que quieres escuchar y si quieres dejarlo activo al crearse.

Precaución

Koibox solo admite webhooks que realicen peticiones HTTP mediante protocolo seguro, es decir, solo se admite HTTPS.

Los webhooks creados desde Koibox no pueden marcarse como gestionados por una aplicación.

Gestionar webhooks existentes

Si tu webhook no está gestionado por una aplicación, puedes desactivarlo o eliminarlo pulsando en el menú de opciones a la derecha de cada entrada de la lista.

Gestionar los webhooks desde tu aplicación

Existen 4 endpoints para gestionar los webhooks de manera programática, se pueden encontrar en la referencia de la API, bajo la sección de Gestión de webhooks.

Crear un nuevo webhook

Referencia de la API

La petición para crear un webhook tiene la siguiente estructura:

{
  "url": "https://example.com/webhook",
  "event": "CITA_CREATED",
  "is_active": true,
  "is_application_managed": true,
  "managing_application": "Mi aplicación"
}

Puedes

A diferencia de crear un webhook en el panel puedes especificar que el webhook lo gestiona tu aplicación. Si se indica que el webhook lo gestiona la aplicación se desactivarán las opciones de gestionarlo desde el panel de Koibox, esto es útil cuando quieres evitar que los usuarios puedan desactivar los webhooks, haciendo que no se envíe la petición.

Precaución

Koibox solo admite webhooks que realicen peticiones HTTP mediante protocolo seguro, es decir, solo se admite HTTPS.

Modificar webhooks existentes

Referencia de la API

Solo se puede activar o desactivar un webhook creado, si quieres cambiar la URL, el evento o si la aplicación lo gestiona deberás recrearlo.

Con esto en mente, la petición PATCH queda de la siguiente manera:

{
  "is_active": true
}

Eliminar webhooks

Existen dos maneras de eliminar un webhook:

• Mediante su ID
• Mediante su URL

Siempre que sea posible, se recomienda encarecidamente eliminar los webhooks mediante sus IDs. Es importante aclarar que la ID se pasa como parte de la ruta, mientras que la URL como un parámetro query.

Peligro

Si optas por eliminar webhooks mediante su URL debes tener en cuenta que se eliminarán todos los webhooks que tengan esa URL. Si quieres evitar esto puedes utilizar los IDs de los webhooks.