POST /v1/webhooks/endpoints/{id}/sample
POST
/v1/webhooks/endpoints/{id}/sample
const url = 'https://seu-endereco-da-api/v1/webhooks/endpoints/example/sample';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"type":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
type
required
string
Example generated
{ "type": "example"}Responses
Seção intitulada “Responses”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
durationMs
required
number
errorCode
required
string
errorMessage
required
string
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