Skip to main content
Testar webhook

Authorizations

Authorization
string
header
required

Chave de API do parceiro, entregue pelo time de integrações da Wincred. Header: Authorization: Bearer <chave do parceiro> (o esquema Bearer não diferencia maiúsculas). Por segurança, chave ausente, malformada, inválida ou revogada recebem a mesma resposta: 401 UNAUTHENTICATED. Guarde a chave apenas no servidor e solicite a rotação ao time de integrações quando precisar trocá-la.

Headers

X-Request-Id
string

Identificador da requisição, até 64 caracteres [A-Za-z0-9_-]. Se faltar ou for inválido, a Wincred gera um. Volta no header X-Request-Id da resposta e no request_id de todo erro.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Response

Resultado da tentativa de entrega.

event_id
string
required

Identificador do ping enviado (o mesmo que o seu endpoint recebeu em X-Wincred-Event-Id).

delivered
boolean
required

true quando o seu endpoint respondeu 2xx.

http_status
integer | null
required

Status HTTP da sua resposta. null quando não houve resposta (timeout, conexão ou TLS).

error
enum<string> | null
required

null quando entregou. timeout: o seu endpoint não respondeu dentro do prazo; connection_error: não foi possível conectar (inclui nome de host que não resolve); tls_error: falha de certificado ou handshake; http_status: respondeu fora de 2xx (veja http_status).

Available options:
timeout,
connection_error,
tls_error,
http_status,
null
duration_ms
integer<int64>
required

Duração da tentativa, em milissegundos.