Webhooks

Um webhook manda um POST HTTP assinado para o seu sistema quando um evento acontece: uma execução terminou, falhou, criou uma pendência.

Criar

Em Configurações → Webhooks, clique em Novo webhook:

Campo	Regra
Nome	identifica o webhook.
URL	endereço público com https. Endereços privados, de loopback ou em http são recusados.
Workspace	restringe aos eventos de um workspace. Em branco: a organização inteira.
Autenticação	como a entrega se autentica no seu sistema: Bearer token, Basic (usuário e senha) ou Header customizado.
Eventos assinados	os eventos que disparam a entrega.

Ao salvar, o console mostra o signing secret do webhook uma única vez. Copie e guarde: é com ele que o seu sistema confere a assinatura.

Eventos

Evento	Quando
execution.created	uma execução foi criada
execution.queued	a execução entrou na fila da tarefa
execution.started	o agente começou
execution.completed	terminou com sucesso
execution.failed	terminou com falha
execution.cancelled	foi cancelada
todo.created, todo.resolved	uma pendência foi criada ou resolvida
organization.cost_limit_reached	o teto mensal de custo foi atingido
organization.entitlement_required	um agendamento não rodou por falta de plano
task.db.*, activity.db.*, workspace.db.*, execution.db.*, memory.db.*	o registro foi criado, alterado ou removido (created, updated, deleted)

Desativação por falhas

Depois de 5 falhas seguidas de entrega, o webhook é desativado e as pessoas cadastradas para aviso recebem um e-mail. Corrija o receptor e reative o webhook.

Receber e conferir

O formato do corpo, os headers e a verificação da assinatura estão em Webhooks da API. O histórico de entregas e o reenvio ficam na API (/v1/webhook_deliveries).

Webhooks declarados no repositório

O kadu.yaml pode declarar webhooks. Um webhook criado pelo repositório nasce sem credencial e com um signing secret que ninguém viu: cadastre a credencial aqui e gere um novo signing secret pela API (POST /v1/webhooks/{id}/rotate-secret). Ver O kadu.yaml.