O que é
A área de API e webhooks permite integrar o painel com sistemas externos: clientes de API
(com tokens) para automação a partir de outros sistemas, e webhooks para notificar ou disparar
ações (como deploy) a partir de eventos externos.
Clientes de API
Você cria um cliente de API, que recebe um token. Esse token autentica chamadas externas ao
painel dentro do escopo permitido.
- Em Configurações → API e webhooks, crie um cliente de API.
- Guarde o token gerado (ele autentica as chamadas).
- Para revogar, rotacione o token — o antigo deixa de valer.
Trate o token como uma senha. Se ele vazar, rotacione imediatamente. Cada cliente de API tem
escopo próprio, então conceda só o necessário.
Webhooks
Os webhooks conectam o painel a eventos externos:
- Webhooks de saída — o painel notifica um endpoint externo quando algo acontece.
- Deploy hook — um endpoint que dispara o deploy de uma aplicação (ex.: um
Node App) quando você faz push no Git.
A configuração inclui um segredo (para validar a origem) e a opção de testar o webhook.
O painel valida as requisições de webhook (proteção contra SSRF e verificação de assinatura) para
que só chamadas legítimas disparem ações.
API vs. CLI
Para automação por SSH ou por um agente dentro do próprio servidor, o caminho é a CLI gws com
tokens escopados (ver Automação e CLI). A API e os webhooks são
para integração HTTP externa.