Pesquisar K
Appearance
Appearance
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"
}
}| Campo | Tipo | Descrição |
|---|---|---|
community | string | Comunidade onde o webhook foi emitido |
hook | object | Contém informações sobre o webhook |
hook.id | string | Identificador único do webhook |
hook.url | string | URL de destino que recebe as requisições POST |
hook.secret | string | Chave secreta usada para validar a autenticidade da requisição |
event | object | Contém os dados do evento que disparou o webhook |
event.sale | object | Dados da venda. Para saber mais, veja as referências sobre as vendas |
event.createdAt | string | Data e hora em que o evento foi gerado (formato ISO 8601) |
event.name | string | Nome do evento. Para mais informações veja a referência sobre eventos possíveis em um webhook |
event.kind | string | Categoria do evento. Pode ser sale, payable ou transaction |
event.entity | string | Identificador da entidade principal relacionada ao evento |
event.author | object | Dados do autor da ação que originou o evento. Pode ser um objeto vazio |
event.reason | string | Código interno que identifica o motivo do disparo do evento |
event.message | string | Mensagem descritiva sobre o evento |