Saltar al contenido principal

Webhooks

Un webhook envía un POST HTTP firmado a tu sistema cuando ocurre un evento: una ejecución terminó, falló, creó un pendiente.

Webhooks que reciben los eventos de las ejecuciones

Crear​

En Configuración → Webhooks, haz clic en Nuevo webhook:

CampoRegla
Nombreidentifica el webhook.
URLdirección pública con https. Las direcciones privadas, de loopback o en http se rechazan.
Workspacerestringe a los eventos de un workspace. En blanco: toda la organización.
Autenticacióncómo se autentica la entrega en tu sistema: Bearer token, Basic (usuario y contraseña) o Header personalizado.
Eventos suscritoslos eventos que disparan la entrega.

Al guardar, la consola muestra el signing secret del webhook una única vez. Cópialo y guárdalo: es con él que tu sistema verifica la firma.

Eventos​

EventoCuándo
execution.createdse creó una ejecución
execution.queuedla ejecución entró en la cola de la tarea
execution.startedel agente empezó
execution.completedterminó con éxito
execution.failedterminó con falla
execution.cancelledfue cancelada
todo.created, todo.resolvedse creó o se resolvió un pendiente
organization.cost_limit_reachedse alcanzó el tope mensual de costo
organization.entitlement_requireduna programación no corrió por falta de plan
task.db.*, activity.db.*, workspace.db.*, execution.db.*, memory.db.*el registro fue creado, modificado o eliminado (created, updated, deleted)

Desactivación por fallas​

Después de 5 fallas seguidas de entrega, el webhook se desactiva y las personas registradas para recibir avisos reciben un correo electrónico. Corrige el receptor y reactiva el webhook.

Recibir y verificar​

El formato del cuerpo, los headers y la verificación de la firma están en Webhooks de la API. El historial de entregas y el reenvío están en la API (/v1/webhook_deliveries).

Webhooks declarados en el repositorio​

El kadu.yaml puede declarar webhooks. Un webhook creado por el repositorio nace sin credencial y con un signing secret que nadie vio: registra aquí la credencial y genera un nuevo signing secret por la API (POST /v1/webhooks/{id}/rotate-secret). Ver El kadu.yaml.