Pular para o conteúdo

POST /v1/webhooks/endpoints/{id}/sample

POST
/v1/webhooks/endpoints/{id}/sample
curl --request POST \
--url https://seu-endereco-da-api/v1/webhooks/endpoints/example/sample \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "type": "example" }'

Permissão que a Chave de acesso precisa: Gerenciar canais (channels:manage).

id
required
string
Media typeapplication/json
object
type
required
string

Example generated

{
"type": "example"
}

Manda o exemplo do evento com a assinatura de verdade e o cabeçalho X-Webhook-Sample; não conta para pausar nem para o aviso de falha

Media typeapplication/json
object
ok
required

O sistema do cliente respondeu 2xx

boolean
httpStatus
required
number
nullable
durationMs
required
number
nullable
errorCode
required
string
nullable
errorMessage
required
string
nullable
logId
required

Linha do Registro, marcada como exemplo

string

Example generated

{
"ok": true,
"httpStatus": 1,
"durationMs": 1,
"errorCode": "example",
"errorMessage": "example",
"logId": "example"
}

Evento fora do catálogo

Mais de 10 exemplos no minuto para o mesmo cadastro