Endpoints de webhook
As URLs que recebem os eventos da Régua de Cobrança (charge.paid, agreement.accepted…). rotate-secret gera um novo secret HMAC, test entrega um evento webhook.test real, e deliveries lista as entregas e reenfileira uma que falhou.
| Comando | HTTP | Descrição |
|---|---|---|
webhook-endpoints list | GET /v1/webhook-endpoints | Listar endpoints de webhook |
webhook-endpoints create | POST /v1/webhook-endpoints | Criar endpoint de webhook |
webhook-endpoints get | GET /v1/webhook-endpoints/{id} | Consultar endpoint de webhook |
webhook-endpoints update | PATCH /v1/webhook-endpoints/{id} | Atualizar endpoint de webhook |
webhook-endpoints delete | DELETE /v1/webhook-endpoints/{id} | Excluir endpoint de webhook |
webhook-endpoints rotate-secret | POST /v1/webhook-endpoints/{id}/rotate-secret | Rotacionar secret |
webhook-endpoints test | POST /v1/webhook-endpoints/{id}/test | Disparar evento de teste |
webhook-endpoints deliveries retry | POST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry | Reenviar entrega |
webhook-endpoints deliveries list | GET /v1/webhook-endpoints/{id}/deliveries | Listar entregas do endpoint |
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.
# Criar endpoint para cobranças pagas e vencidas
kobana dunning webhook-endpoints create \
--json '{"url": "https://example.com/webhooks/kobana", "events": ["charge.paid", "charge.overdue"]}'
# Disparar um evento de teste
kobana dunning webhook-endpoints test --params '{"id": "ENDPOINT_ID"}'
# Entregas que falharam
kobana dunning webhook-endpoints deliveries list --params '{"id": "ENDPOINT_ID", "status": "failed"}'
# Reenviar uma entrega
kobana dunning webhook-endpoints deliveries retry --params '{"id": "ENDPOINT_ID", "deliveryId": "DELIVERY_ID"}'
# Rotacionar o secret
kobana dunning webhook-endpoints rotate-secret --params '{"id": "ENDPOINT_ID"}' --dry-run
Próximos passos
- Identidade do token
- Introspecção de schema — todos os parâmetros que este recurso aceita.