Docs
Acessar painel

Webhooks

Desabilitar endpoint de webhook

DELETEhttps://api.kokupay.com/v1/webhooks/endpoints/{id}

Desabilita um endpoint: ele deixa de receber eventos. Os eventos continuam disponíveis em Listar eventos.

DELETE/v1/webhooks/endpoints/{id}
curl -X DELETE 'https://api.kokupay.com/v1/webhooks/endpoints/71c3e9a5-4f2d-4b8e-a06c-9d5e2f1b7a38' \
  -H "Authorization: Bearer $KOKU_API_KEY"
200Resposta
{
  "ok": true
}

Autenticação

Authorization: Bearer <sua chave de API>

Escopo exigido: webhooks:write. Veja Chaves de API.

Parâmetros de caminho

idstring (uuid)obrigatório

Identificador do endpoint.

Resposta 200

okbooleano

Sempre true quando a operação foi aplicada.

Valores: true

Erros

StatusCódigoQuando
401unauthorizedChave ausente, inválida, revogada ou expirada.
403forbiddenA chave não tem o escopo exigido (details.reason = "missing_scope").
404not_foundEndpoint inexistente ou de outra conta.
429rate_limitedLimite de requisições excedido. Aguarde o tempo de Retry-After.
500internal_errorFalha inesperada. Repita com a mesma Idempotency-Key; persistindo, envie o correlation_id à Koku (veja Suporte).

Formato do corpo de erro em Erros.