Crear webhook

Registro de Webhook

Registra la URL de webhook para el tenant autenticado mediante API key.
Solo se permite 1 webhook por centro de costo. Antes de guardarlo, el sistema valida que la URL esté “online”; si está “offline” no se registra y se responde el motivo.

¿Para qué sirve?

Configurar a dónde se enviarán las notificaciones automáticas del sistema (eventos)
Evitar errores por URLs inválidas o caídas (solo se guarda si responde “online”)
Garantizar una única configuración de webhook por tenant (sin duplicados)
Funcionamiento
Se envían los datos del webhook:

url (obligatoria)
headers (opcional; headers adicionales)
isActive (opcional; por defecto true)

El sistema:
Resuelve el centro de costo a partir de la API key
Valida que la URL sea válida
Verifica que el tenant no tenga un webhook registrado previamente
Hace un “probe/health check” a la URL (HEAD/GET) para determinar si está online
Si está online, guarda el webhook (por defecto con nombre default) y registra el resultado del probe (status, statusCode, tiempo, error si aplica)
Retorna

Si se registra correctamente:
success: true
webhook con la configuración guardada y su estado inicial (online)

Si no se puede registrar:
success: false
message con el motivo
(cuando aplica) probe con detalles del check (status, lastStatusCode, lastError, lastResponseTimeMs)

Errores comunes

400 si falta url o es inválida
409 si ya existe un webhook para ese centro de costo
422 si la URL está offline (no se guarda nada)

Proporciona tu token bearer en el encabezado

Authorization

al realizar solicitudes a recursos protegidos.

Ejemplo:

Authorization: Bearer ********************

curl --location 'https://stp.paydaymx.com/api/developer/webhook' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name":"Prueba ggggggg", "url": "https://webhook.site/23e4527a-aeee-4f40-975d-4a433c4fab78", "headers": { "x-custom": "123" }, "isActive": true }'

{ "success": true, "webhook": { "tenantId": "24d67992-c7cf-4831-a164-d76379c6f091", "name": "default", "url": "https://webhook.site/23e4527a-aeee-4f40-975d-4a433c4fab78", "secret": "", "headers": { "x-custom": "123" }, "events": [], "isActive": true, "status": "online", "lastCheckedAt": "2026-01-28T17:37:20.744Z", "lastStatusCode": 200, "lastError": "", "lastResponseTimeMs": 610, "_id": "697a4951fc12c917301defe3", "createdAt": "2026-01-28T17:37:21.373Z", "updatedAt": "2026-01-28T17:37:21.373Z", "__v": 0 } }

Solicitud

Respuestas