Webhooks
Endpoints que recebem os eventos do workspace, assinados. test envia um evento test.webhook na hora, rotate-secret troca o segredo de assinatura, e deliveries get / deliveries retry listam e reenviam as entregas de um endpoint.
| Comando | HTTP | Descrição |
|---|---|---|
webhooks list | GET /v1/webhooks | Listar endpoints de webhook |
webhooks create | POST /v1/webhooks | Criar endpoint de webhook |
webhooks get | GET /v1/webhooks/{id} | Consultar endpoint de webhook |
webhooks update | PATCH /v1/webhooks/{id} | Atualizar endpoint de webhook |
webhooks delete | DELETE /v1/webhooks/{id} | Excluir endpoint de webhook |
webhooks rotate-secret | POST /v1/webhooks/{id}/rotate_secret | Rotacionar segredo do webhook |
webhooks test | POST /v1/webhooks/{id}/test | Enviar webhook de teste |
webhooks deliveries retry | POST /v1/webhooks/{id}/deliveries/{delivery_id}/retry | Reenviar entrega de webhook |
webhooks deliveries list | GET /v1/webhooks/{id}/deliveries | Listar entregas de um webhook |
Exemplos
--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.
# Listar endpoints de webhook
kobana dashboards webhooks list --fields "id,url,active,events"
# Criar endpoint de webhook
kobana dashboards webhooks create \
--json '{"url": "https://example.com/webhooks", "events": ["portal_user.invited", "portal_user.updated"]}'
# Enviar webhook de teste
kobana dashboards webhooks test --params '{"id": "WEBHOOK_ID"}'
# Listar entregas de um webhook
kobana dashboards webhooks deliveries list \
--params '{"id": "WEBHOOK_ID", "status": "failed"}'
# Reenviar entrega de webhook
kobana dashboards webhooks deliveries retry \
--params '{"id": "WEBHOOK_ID", "delivery_id": "DELIVERY_ID"}'
Próximos passos
- Entregas de webhook
- Eventos
- Introspecção de schema — todos os parâmetros que este recurso aceita.