> For the complete documentation index, see [llms.txt](https://ereemby.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ereemby.gitbook.io/docs/desenvolvedores/webhooks/avaliacao.md).

# Avaliação

Receba eventos de **avaliação/feedback** em tempo real via webhook.\
Você usa isso pra notificar, registrar e automatizar ações com base na nota.

{% hint style="info" %}
Você configura a URL e valida a assinatura na página de [Webhooks](/docs/desenvolvedores/webhooks.md).\
Aqui ficam os detalhes do **payload** da avaliação.
{% endhint %}

{% hint style="warning" %}
Esse evento pode conter dados sensíveis (email do pedido).\
Trate logs e destinos (Discord/Telegram) como ambiente privado.
{% endhint %}

### Evento `feedback_create`

Dispara quando uma nova avaliação é criada.

O body chega como JSON no seu endpoint, neste formato:

* `payload.event_name`: sempre `feedback_create`
* `payload.feedback`: dados da avaliação
* `payload.carrinho`: item do carrinho relacionado
* `payload.pedido`: dados do pedido
* `payload.produto`: snapshot do produto
* `payload.variante`: variante completa (quando existir). Pode ser `null`.

{% openapi-webhook spec="webhook-Feedback" name="feedback\_create" method="post" %}
[webhook-Feedback](https://4401d86825a13bf607936cc3a9f3897a.r2.cloudflarestorage.com/gitbook-x-prod-openapi/raw/37396b76aae020fa0abc9a0f23c153187987df29ba4444675629836146fc72e5.json?X-Amz-Algorithm=AWS4-HMAC-SHA256\&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD\&X-Amz-Credential=0cc7c3f440ca5fd44ab53362d4a69dfe%2F20261115%2Fauto%2Fs3%2Faws4_request\&X-Amz-Date=20261115T172532Z\&X-Amz-Expires=172800\&X-Amz-Signature=68b4ff6e78e636fe94f162e6e69d1c29b62623186f17bfcf4d773d6f0cc5ef3d\&X-Amz-SignedHeaders=host\&x-amz-checksum-mode=ENABLED\&x-id=GetObject)
{% endopenapi-webhook %}

### Campos que mais importam (na prática)

* `payload.feedback.star`\
  Nota de 1 a 5. Ótimo gatilho pra alertas.
* `payload.feedback.is_approved`\
  Ajuda a filtrar só avaliações já moderadas.
* `payload.feedback.is_anonymous`\
  Se `true`, evite tentar correlacionar com o comprador publicamente.
* `payload.feedback.comment` e `payload.feedback.tags`\
  Texto + “opções rápidas” escolhidas. Bom pra classificar feedback.
* `payload.pedido.email`\
  Útil pra CRM/suporte. Evite mandar em canais públicos.
* `payload.feedback.images[]`\
  URLs de anexos. Use pra gerar post com preview ou auditoria.

{% hint style="warning" %}
`payload.produto.desc` é HTML e pode vir grande.\
Evite renderizar sem sanitização e evite logar inteiro.
{% endhint %}

### Ideias do que dá pra fazer com esse webhook

#### Notificação imediata (operação)

* Postar num canal `#avaliacoes` do Discord (via webhook do Discord).\
  Veja como criar a URL em: [Criar Webhook Discord](/docs/informacoes-gerais/notificacoes/notificacoes-via-discord/criar-webhook-discord.md)
* Enviar alerta em um grupo/canal do Telegram.\
  Útil pra time de atendimento responder rápido.
* Mandar mensagem pra um Slack/Teams, separando por nota (1–2 / 3 / 4–5).

#### Suporte e qualidade

* Se `star <= 2`: abrir ticket automaticamente (HelpDesk/CRM).\
  Inclua `comment`, `tags`, `pedido.id` e `produto.id`.
* Se tiver imagem: enviar também pra um canal interno de “auditoria”.

#### BI e relatórios

* Salvar em planilha (Sheets) ou banco.\
  Depois, criar ranking de produtos por nota.
* Criar série temporal de nota média por semana.

#### Marketing e prova social

* Se `star == 5` e `is_approved == true`: republicar no seu “mural” interno.\
  Evite expor `email` e dados do pedido.

### Boas práticas

* Valide `x-webhook-signature` antes de processar.\
  Referência: [Webhooks](/docs/desenvolvedores/webhooks.md)
* Trate como “pelo menos uma vez”. Pode haver reenvio.
* Responda com `2xx` rápido e processe em background quando possível.
