En un artículo anterior exploramos cómo integrar la API de gigstack para crear recursos desde las herramientas que usas en el día a día. Sin embargo, en muchos casos, también es necesario mantener estas herramientas actualizadas en tiempo real sobre los eventos que ocurren en gigstack, como la creación o cancelación de una factura.
Aquí es donde entran en juego los webhooks.
¿Qué son los Webhooks?
Los webhooks son eventos que se envían automáticamente a un servidor cuando ocurren ciertas acciones en tu cuenta de gigstack. Gracias a ellos, puedes mantener sincronizadas tus herramientas internas sin necesidad de realizar consultas constantes a nuestra API.
En gigstack contamos con webhooks para diferentes tipos de eventos, organizados de la siguiente manera:
Pagos
-
payment.created -
payment.updated -
payment.succeeded -
payment.canceled -
payment.deleted -
payment.upcoming_due_date
Facturas
-
invoice.created -
invoice.canceled -
invoice.failed(se detona cuando falla la creación automática de la factura)
Recibos de autofactura
-
receipt.created -
receipt.updated -
receipt.canceled -
receipt.deleted
Clientes
-
client.created -
client.updated -
client.deleted
Estructura de un Webhook
Cada evento que se envía a tu servidor sigue una estructura estándar, como la siguiente:
{
"data": ClientObject | PaymentObject | ReceiptObject | InvoiceObject,
"team": "SXztwsWPvX7Fcv", // ID de la cuenta donde se creó el recurso
"webhook": "wh_6ZCY9e4", // ID del webhook
"event": "receipt.created", // Tipo de evento
"livemode": true // Indica si el evento ocurrió en producción (true) o en sandbox (false)
}
Configuración de Webhooks en gigstack
Configurar webhooks en gigstack es muy sencillo. Sigue estos pasos:
-
Ve a Configuración > API > Nuevo Webhook (Acceder).
-
Ingresa la URL del servidor donde deseas recibir los eventos.
-
Agrega una descripción para identificarlo fácilmente.
-
Selecciona los eventos que deseas escuchar.
-
(Opcional) Agrega Headers de autenticación si es necesario.
-
Haz clic en Crear Webhook.
A partir de ese momento, gigstack enviará los eventos seleccionados a tu servidor en tiempo real.
Actualiza tus webhooks
Puedes visualizar y actualizar los webhooks que has creado en Configuración > API > Webhooks creados. Desde esta sección, podrás:
-
Desactivarlos temporalmente.
-
Editar su configuración.
-
Eliminarlos si ya no los necesitas.
Con los webhooks de Gigstack, puedes mantener todas tus herramientas sincronizadas sin esfuerzo, asegurando que siempre cuenten con la información más actualizada en tiempo real.