Skip to content

Corpo de resposta de um webhook

Veja abaixo qual é a estrutura da resposta de um webhook:

{
  "community": "test",
  "hook": {
    "id": "69c2eaf1d436741d10f3e78d",
    "url": "https://url-do-webhook",
    "secret": "12345678"
  },
  "event": {
    "sale": {...},
    "createdAt": "2026-03-24T19:50:41.714Z",
    "name": "sale.created",
    "kind": "sale",
    "entity": "69c2eb0ad436741d10f3e851",
    "author": {},
    "reason": "event.message.sale.created",
    "message": "event.message.sale.created"
  }
}

Campos do corpo de resposta de um webhook

CampoTipoDescrição
communitystringComunidade onde o webhook foi emitido
hookobjectContém informações sobre o webhook
hook.idstringIdentificador único do webhook
hook.urlstringURL de destino que recebe as requisições POST
hook.secretstringChave secreta usada para validar a autenticidade da requisição
eventobjectContém os dados do evento que disparou o webhook
event.saleobjectDados da venda. Para saber mais, veja as referências sobre as vendas
event.createdAtstringData e hora em que o evento foi gerado (formato ISO 8601)
event.namestringNome do evento. Para mais informações veja a referência sobre eventos possíveis em um webhook
event.kindstringCategoria do evento. Pode ser sale, payable ou transaction
event.entitystringIdentificador da entidade principal relacionada ao evento
event.authorobjectDados do autor da ação que originou o evento. Pode ser um objeto vazio
event.reasonstringCódigo interno que identifica o motivo do disparo do evento
event.messagestringMensagem descritiva sobre o evento