Webhooks
Permite que el comercio sea notificado cuando se ha producido un evento de la plataforma en tiempo real, lo que le permite crear procesos personalizados.
Para configurar los webhooks, ingresa al portal en el menú configuración/webhooks.
En la sección de Webhooks en la pestaña endpoints, se listan todos los endpoints configurados. Para configurar un endpoint, selecciona la opción Add Endpoint
Debes seguir los pasos que se muestran a continuación:
- Agrega la url de tu endpoint, opcionalmente, puedes anexar una descripción de tu endpoint.
❗ Debes tomar en cuenta que únicamente se permite configurar la URL con protocolo HTTPS.
- Selecciona el evento que se notificará al endpoint en la opción Message Filtering, debes de elegir al menos un evento a notificar.
- Opcionalmente, puedes configurar la limitación de velocidad, en la sección Advanced Configuration.
🔒 Autenticación: Una vez configurado tu webhook, puedes agregar autenticación con el estándar de autenticación básica HTTP o a través del uso de token de autenticación.
✅ Pruebas: Puedes probar el webhook en la sección Advanced/Testing, una vez registrado el endpoint puedes realizar pruebas de los eventos disponibles, en las cuales se enviará una notificación con datos de prueba, aunado a ello puedes realizar pruebas de conectividad con la opción ping.
Cada notificación que se envia se firma como medida de seguridad.
La firma del Webhook permite al comercio validar el origen de las notificaciones y procesar la notificaciones con un origen valido , para relizar la validación es necesario la firma secreta de tu endpoint.
Una vez configurado tu endpoint puedes obtener la firma secreta, en la sección de endpoints y selecciona tu endpoint configurado.
En caso de requerir actualizar ó cambiar la firma secreta puedes realizarlo en la misma sección, seleccionando la opción "Rotate secret".
Lista de notificaciones:
| Evento | Descripción | Esquema |
|---|---|---|
| order.paid | Notificación de pago de la orden | Revisa la documentación tecnica de referencia para configurar y usar un Webhook |
En la sección de Logs, se listan las notificaciones que se envían al webhook configurado, en cada notificación se muestra los detalles del mensaje, los intentos de la notificación y los detalles de las respuestas de cada notificación.
En este apartado se muestra de forma gráfica el envío de mensajes, para poder ver de forma resumida la actividad de notificaciones a tu webhook.
