KernosDevelopers
Sair
Referência Webhook › Ler
Webhook › Ler

Lê o webhook da empresa e as últimas 50 entregas

GET/v1/webhook-endpoint

O webhook mora na conexão custom_api. Sem ela, ou sem endereço cadastrado, endpoint é nulo. O segredo nunca volta aqui.

Ação da chave: integration.webhook.get

Quem cria a chave escolhe as ações que ela abre; sem esta, a rota recusa com api_key_action_not_granted.

Devolve

O data do envelope { ok, data, error, error_code, field, trace_id }:

deliveries lista de objeto OBRIGATÓRIO
10 campos
action string, ou nulo OBRIGATÓRIO
attempts integer OBRIGATÓRIO
created_at data e hora OBRIGATÓRIO
detail string, ou nulo OBRIGATÓRIO
event_id uuid OBRIGATÓRIO
http_status integer, ou nulo OBRIGATÓRIO
id uuid OBRIGATÓRIO
next_at data e hora, ou nulo OBRIGATÓRIO
outcome "pending" | "delivered" | "failed" OBRIGATÓRIO
updated_at data e hora OBRIGATÓRIO
endpoint objeto, ou nulo OBRIGATÓRIO
8 campos
created_at data e hora OBRIGATÓRIO
disabled_reason string, ou nulo OBRIGATÓRIO
events lista de string OBRIGATÓRIO
failing_since data e hora, ou nulo OBRIGATÓRIO
id uuid OBRIGATÓRIO
status "active" | "disabled" OBRIGATÓRIO
updated_at data e hora OBRIGATÓRIO
url string OBRIGATÓRIO

Recusas

HTTP 400 · Pedido mal formado

version_unknown HTTP 400A Kernos-Version pedida não existe. Use uma das versões declaradas no cabeçalho, ou não o mande.

HTTP 401 · Sem credencial válida

api_key_expired HTTP 401A chave venceu. Gire a chave no painel e use a nova.
api_key_wrong_environment HTTP 401A chave é do outro ambiente: ksk_test_ vai em https://stag.kernos.com.br, ksk_live_ em https://api.kernos.com.br.
unauthenticated HTTP 401Credencial ausente, inválida ou expirada.

HTTP 403 · Sem permissão

agent_token_out_of_scope HTTP 403O token de agente (kat_) só vale na porta MCP. Para a API, use o token de sessão ou uma chave de integração.
api_key_action_not_granted HTTP 403A chave não tem esta ação. Edite as ações da chave no painel.
api_key_out_of_scope HTTP 403A chave só vale nas rotas do contrato público.
depot_out_of_reach HTTP 403Quem chama não alcança o CD deste objeto. Peça alcance ao CD ou use outra credencial.
forbidden_role HTTP 403O papel de quem chama nesta empresa não permite esta ação.
module_not_subscribed HTTP 403A empresa não assina o módulo desta rota.
tenant_mismatch HTTP 403A credencial não pertence à empresa do endereço chamado.
tenant_unavailable HTTP 403A empresa está indisponível no momento.

HTTP 429 · Muitos pedidos

rate_limited HTTP 429Muitos pedidos por segundo com esta chave. Espere o Retry-After, em segundos, e tente de novo.
curlNodePythonPHPJavaC#GoRust
Lê o webhook da empresa e as últimas 50 entregas
curl -X GET "https://stag.kernos.com.br/v1/webhook-endpoint" \
  -H "Authorization: Bearer ksk_test_…" \
  -H "Kernos-Version: 2026-10-03"
Resposta · 200 (a forma, sem dado real)
{
  "ok": true,
  "data": {
    "deliveries": [
      {
        "action": "…",
        "attempts": 0,
        "created_at": "2026-10-03T12:00:00Z",
        "detail": "…",
        "event_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
        "http_status": 0,
        "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
        "next_at": "2026-10-03T12:00:00Z",
        "outcome": "pending",
        "updated_at": "2026-10-03T12:00:00Z"
      }
    ],
    "endpoint": {
      "created_at": "2026-10-03T12:00:00Z",
      "disabled_reason": "…",
      "events": [
        "…"
      ],
      "failing_since": "2026-10-03T12:00:00Z",
      "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "status": "active",
      "updated_at": "2026-10-03T12:00:00Z",
      "url": "…"
    }
  },
  "error": null,
  "error_code": null,
  "field": null,
  "trace_id": null
}
Ambiente

ksk_test_ fala com https://stag.kernos.com.br; ksk_live_, com https://api.kernos.com.br. O prefixo da chave escolhe o endereço.