Webhooks
Desabilitar endpoint de webhook
DELETE
https://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"const response = await fetch('https://api.kokupay.com/v1/webhooks/endpoints/71c3e9a5-4f2d-4b8e-a06c-9d5e2f1b7a38', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.KOKU_API_KEY}`,
},
});
const data = await response.json();
console.log(response.status, data);import os
import requests
response = requests.request(
"DELETE",
"https://api.kokupay.com/v1/webhooks/endpoints/71c3e9a5-4f2d-4b8e-a06c-9d5e2f1b7a38",
headers={
"Authorization": f"Bearer {os.environ['KOKU_API_KEY']}",
},
timeout=30,
)
print(response.status_code, response.json())<?php
$ch = curl_init('https://api.kokupay.com/v1/webhooks/endpoints/71c3e9a5-4f2d-4b8e-a06c-9d5e2f1b7a38');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('KOKU_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
echo $status, PHP_EOL;
print_r($data);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órioIdentificador do endpoint.
Resposta 200
okbooleanoSempre true quando a operação foi aplicada.
Valores: true
Erros
| Status | Código | Quando |
|---|---|---|
| 401 | unauthorized | Chave ausente, inválida, revogada ou expirada. |
| 403 | forbidden | A chave não tem o escopo exigido (details.reason = "missing_scope"). |
| 404 | not_found | Endpoint inexistente ou de outra conta. |
| 429 | rate_limited | Limite de requisições excedido. Aguarde o tempo de Retry-After. |
| 500 | internal_error | Falha inesperada. Repita com a mesma Idempotency-Key; persistindo, envie o correlation_id à Koku (veja Suporte). |
Formato do corpo de erro em Erros.