Testar um endpoint

POST

/v1/endpoints/{id}/test

Faz uma entrega de teste agora e espera por ela: a resposta traz o que aconteceu: status HTTP, tipo de erro e duração. É o caminho mais curto para validar a verificação de assinatura antes de ligar o fluxo de verdade.

O corpo é um evento endpoint.test, assinado com o secret ativo, e o Webhook-Id começa com evt_test_. O teste não entra no histórico de entregas e não conta como falha do endpoint.

Autorização

• Bearer

Parâmetros

Parâmetros de caminho

id

obrigatório

string

Respostas

200

O resultado da entrega de teste. success é true quando o endpoint respondeu 2xx.

Tipo de mídiaapplication/json

object

success

obrigatório

boolean

statusCode

obrigatório

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

errorType

obrigatório

string

errorMessage

obrigatório

null | string

durationMs

obrigatório

integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

Exemplo^gerado

{
  "success": true,
  "statusCode": 1,
  "errorType": "example",
  "errorMessage": "example",
  "durationMs": 1
}

401

Chave de API ausente, inválida ou revogada.

404

O endpoint não existe, ou não é deste ambiente.

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.