Pular para o conteúdo principal

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.

ComandoHTTPDescrição
webhook-endpoints listGET /v1/webhook-endpointsListar endpoints de webhook
webhook-endpoints createPOST /v1/webhook-endpointsCriar endpoint de webhook
webhook-endpoints getGET /v1/webhook-endpoints/{id}Consultar endpoint de webhook
webhook-endpoints updatePATCH /v1/webhook-endpoints/{id}Atualizar endpoint de webhook
webhook-endpoints deleteDELETE /v1/webhook-endpoints/{id}Excluir endpoint de webhook
webhook-endpoints rotate-secretPOST /v1/webhook-endpoints/{id}/rotate-secretRotacionar secret
webhook-endpoints testPOST /v1/webhook-endpoints/{id}/testDisparar evento de teste
webhook-endpoints deliveries retryPOST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retryReenviar entrega
webhook-endpoints deliveries listGET /v1/webhook-endpoints/{id}/deliveriesListar 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​