Pular para o conteúdo
Entrar Lista de espera

Testar webhook

POST /v1/webhooks/:id/test escopo admin

Envia agora um evento ping.test (mesmo com o webhook pausado) e devolve o resultado em delivery. Não conta para a desativação automática.

CabeçalhosAuthorization: Bearer praeko_… e X-Praeko-Contract: en. Sempre envie os dois.

Parâmetros

Nome Onde Descrição
id caminho Id do webhook (começa com wh_).
Idempotency-Key cabeçalho Chave de idempotência (1 a 255 caracteres visíveis, por exemplo um UUID). Repetir o MESMO pedido com a mesma chave, em até 24 h, devolve a resposta guardada (com Idempotent-Replayed: true) sem executar de novo; outro pedido com a mesma chave dá 422 idempotency_key_reuse; um pedido ainda em andamento dá 409 idempotency_in_progress. Erros 5xx não são guardados. A chave vale por workspace e por rota. Veja Repetir uma requisição.

Exemplo

curl -X POST "https://praeko.app/v1/webhooks/wh_01KA3X4D8P6TQ1VZ0C7MH2NB5R/test" \
  -H "Authorization: Bearer $PRAEKO_KEY" \
  -H "X-Praeko-Contract: en"

Resposta

Status de sucesso Quando
200 Sucesso.
Resposta 200
{
  "delivery": {
    "id": "whd_01KA3X9F2Z4WJ8G6D1RT5YQK3C",
    "event": "post.sent",
    "eventId": "evt_01KA3XB7W3N8QZ5RD2VH6TM9KF",
    "state": "delivered",
    "attempts": 1,
    "lastStatus": 200,
    "durationMs": 142,
    "createdAt": "2026-11-07T14:02:11.482Z",
    "deliveredAt": "2026-11-07T14:02:11.482Z"
  }
}

Mesmo que o endereço recuse, a resposta é 200 e delivery.state conta o resultado (delivered, pending com nextAttemptAt, failed).

Erros

Status code Quando
404 webhook_not_found O webhook não existe.
422 idempotency_key_reuse A Idempotency-Key já foi usada com outro pedido (método, caminho, query ou corpo diferentes).
409 idempotency_in_progress Um pedido com a mesma Idempotency-Key ainda está em andamento (repita em instantes).
409 idempotency_response_too_large A resposta original passou de 256 KB e não foi guardada; consulte o recurso por GET.

Erros de qualquer rota

Status code Quando
401 unauthorized Faltou o cabeçalho Authorization: Bearer ….
401 invalid_api_key A chave não existe.
401 revoked_api_key A chave foi revogada.
401 expired_api_key A chave expirou.
403 forbidden O escopo da chave não basta para esta rota (veja o selo de escopo).
429 rate_limited Passou do limite de requisições por minuto.

O corpo de todo erro é { "error": { "code", "message", "details"? } }. Veja todos os códigos.

Testar

Testar

O teste ao vivo usa a sua chave e a sua conta. Para quem não entrou, fica desligado.

Entre para testar
Dúvida ou erro nesta página? contato@praeko.appVer .md

Digite para buscar páginas, rotas e códigos de erro.