# Manda agora um evento de teste ao webhook e diz o que ele respondeu

**POST** `/v1/webhook-endpoint/ping`

Sem `type`, um `ping`. Com `type`, um evento público (`shipment.dispatch`, `pix.paid`…) com o `data` de exemplo do contrato. O corpo leva `test: true` e a assinatura é a de sempre: é o jeito de provar o seu receptor sem esperar o galpão. Não grava fato nem entrega, e não muda nada na empresa.

> **Ação da chave: `integration.webhook.ping`** Quem cria a chave escolhe as ações que ela abre; sem esta, a rota recusa com `api_key_action_not_granted`.

## Corpo

- `type` (string): `ping` (padrão) ou um evento público, com o nome do contrato.

## Devolve

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

- `delivered` (boolean, obrigatório): O endpoint respondeu 2xx.
- `duration_ms` (integer, obrigatório)
- `error` (string, ou nulo, obrigatório)
- `event_id` (uuid, obrigatório)
- `status` (integer, ou nulo, obrigatório): O status HTTP da resposta; nulo quando nem respondeu.
- `type` (string, obrigatório): O que foi mandado: `ping` ou o evento pedido.

## Recusas

### HTTP 400 · Pedido mal formado

- [`version_unknown`](/erros/version_unknown.md) (HTTP 400): A `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`](/erros/api_key_expired.md) (HTTP 401): A chave venceu. Gire a chave no painel e use a nova.
- [`api_key_wrong_environment`](/erros/api_key_wrong_environment.md) (HTTP 401): A chave é do outro ambiente: `ksk_test_` vai em https://stag.kernos.com.br, `ksk_live_` em https://api.kernos.com.br.
- [`unauthenticated`](/erros/unauthenticated.md) (HTTP 401): Credencial ausente, inválida ou expirada.

### HTTP 403 · Sem permissão

- [`agent_token_out_of_scope`](/erros/agent_token_out_of_scope.md) (HTTP 403): O 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`](/erros/api_key_action_not_granted.md) (HTTP 403): A chave não tem esta ação. Edite as ações da chave no painel.
- [`api_key_out_of_scope`](/erros/api_key_out_of_scope.md) (HTTP 403): A chave só vale nas rotas do contrato público.
- [`depot_out_of_reach`](/erros/depot_out_of_reach.md) (HTTP 403): Quem chama não alcança o CD deste objeto. Peça alcance ao CD ou use outra credencial.
- [`forbidden_role`](/erros/forbidden_role.md) (HTTP 403): O papel de quem chama nesta empresa não permite esta ação.
- [`module_not_subscribed`](/erros/module_not_subscribed.md) (HTTP 403): A empresa não assina o módulo desta rota.
- [`tenant_mismatch`](/erros/tenant_mismatch.md) (HTTP 403): A credencial não pertence à empresa do endereço chamado.
- [`tenant_unavailable`](/erros/tenant_unavailable.md) (HTTP 403): A empresa está indisponível no momento.

### HTTP 404 · Não encontrado

- [`not_found`](/erros/not_found.md) (HTTP 404): Não existe objeto com esse identificador nesta empresa.

### HTTP 422 · Não processável

- [`invalid_event_type`](/erros/invalid_event_type.md) (HTTP 422): Um dos tipos não é um evento público. Use os nomes do contrato, separados por vírgula (`shipment.dispatch,pix.paid`).

### HTTP 429 · Muitos pedidos

- [`rate_limited`](/erros/rate_limited.md) (HTTP 429): Muitos pedidos por segundo com esta chave. Espere o `Retry-After`, em segundos, e tente de novo.

### HTTP 503 ·

- [`vault_unavailable`](/erros/vault_unavailable.md) (HTTP 503): O cofre do servidor está fechado agora e nada foi guardado. Tente de novo em alguns minutos.

#### curl

**Manda agora um evento de teste ao webhook e diz o que ele respondeu**

```sh
curl -X POST "https://stag.kernos.com.br/v1/webhook-endpoint/ping" \
  -H "Authorization: Bearer ksk_test_…" \
  -H "Kernos-Version: 2026-10-03" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "type": "ping" }'
```

#### Node

**Manda agora um evento de teste ao webhook e diz o que ele respondeu**

```js
import { Kernos } from '@kernosbr/kernos'

const kernos = new Kernos(process.env.KERNOS_API_KEY)
const result = await kernos.integrationWebhook.ping({ type: 'ping' })
```

#### Python

**Manda agora um evento de teste ao webhook e diz o que ele respondeu**

```python
import os
from kernos import Kernos

kernos = Kernos(os.environ["KERNOS_API_KEY"])
result = kernos.integration_webhook.ping({"type": "ping"})
```

#### PHP

**Manda agora um evento de teste ao webhook e diz o que ele respondeu**

```php
<?php
$kernos = new Kernos\Kernos(getenv('KERNOS_API_KEY'));
$result = $kernos->integrationWebhook->ping(['type' => 'ping']);
```

#### Java

**Manda agora um evento de teste ao webhook e diz o que ele respondeu**

```java
Kernos kernos = new Kernos(System.getenv("KERNOS_API_KEY"));
JsonNode result = kernos.integrationWebhook().ping(Map.of("type", "ping"));
```

#### C#

**Manda agora um evento de teste ao webhook e diz o que ele respondeu**

```csharp
var kernos = new KernosClient(Environment.GetEnvironmentVariable("KERNOS_API_KEY"));
var result = await kernos.IntegrationWebhook.PingAsync(new { type = "ping" });
```

#### Go

**Manda agora um evento de teste ao webhook e diz o que ele respondeu**

```go
client, err := kernos.New(os.Getenv("KERNOS_API_KEY"))
result, err := client.IntegrationWebhook.Ping(ctx, map[string]any{"type": "ping"})
```

#### Rust

**Manda agora um evento de teste ao webhook e diz o que ele respondeu**

```rust
let kernos = Kernos::new(&std::env::var("KERNOS_API_KEY")?)?;
let result = kernos.integration_webhook().ping(&json!({ "type": "ping" }), None)?;
```

**Resposta · 200 (a forma, sem dado real)**

```json
{
  "ok": true,
  "data": {
    "delivered": true,
    "duration_ms": 0,
    "error": "…",
    "event_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
    "status": 0,
    "type": "…"
  },
  "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.