Pular para o conteúdo principal
A API aceita qualquer nome de evento que siga o formato (letras minúsculas, números e sublinhados). Este catálogo é uma convenção, não uma regra: nada aqui é validado, e você pode enviar eventos e propriedades que não estão na lista. Vale a pena seguir o catálogo por dois motivos:
  • Os mesmos nomes e propriedades em todos os eventos deixam flows e mensagens previsíveis: {{event.order_number}} funciona igual em order_shipped e em order_delivered.
  • Um evento com nome do catálogo já nasce com a natureza indicada na tabela (utility ou marketing), devolvida em GET /v1/event-types.
  • Alguns eventos têm um flow pronto nas receitas da Bevits: Pedido enviado para order_shipped (lê tracking_code, tracking_url e carrier) e Pix gerado para pix_generated (lê pix_code e order_url, lembra o cliente 15 minutos depois e para quando chega payment_confirmed com o mesmo order_number) e Pontos expirando para points_expiring (lê points).
Veja como enviar em Eventos personalizados.

Propriedades comuns

Use estas propriedades, com o mesmo nome, em todos os eventos em que fizerem sentido: Nos eventos sobre um produto, product é um objeto com sku, name, price_in_cents, image_url, url e category.
Na API, a natureza aparece como utility (utilidade) ou marketing. Os eventos sem natureza (review_submitted, nps_answered) normalmente não geram mensagem: servem para registrar a resposta do cliente. Datas e horários vão como texto em ISO 8601 (2026-11-22 ou 2026-11-22T14:00:00-03:00). Valores monetários vão em centavos.

Três regras

1. Natureza do evento

Utilidade é um evento sobre algo que o cliente já fez: um pedido, um pagamento, uma entrega. Marketing é um evento usado para vender, como back_in_stock ou coupon_issued, e a mensagem que ele gera exige o consentimento do cliente. A natureza é uma propriedade do tipo de evento. Os nomes do catálogo nascem com a natureza da tabela; um nome fora do catálogo nasce sem natureza e segue a regra de marketing. A natureza pode ser alterada em Configurações → Eventos. Um evento de utilidade alcança quem nunca aceitou marketing, mas não quem pediu para sair; no WhatsApp oficial, o template também precisa ser de utilidade. Detalhes em Quem recebe as mensagens do flow.

2. Eventos de produto são enviados por cliente

back_in_stock e price_dropped acontecem com um produto, mas a API liga cada evento a um cliente. Envie um evento por cliente interessado, usando o envio em lote.

3. Fora do catálogo de propósito

Redefinição de senha e códigos de verificação não estão no catálogo. São mensagens críticas em tempo e não pertencem a um flow de marketing.

Se a sua loja não tem integração nativa

As integrações nativas da Bevits já geram os eventos de pedido criado, pago, enviado e cancelado, de carrinho abandonado e de novo cliente. Se você envia esses fatos pela API porque não usa uma integração nativa, use os nomes do catálogo: order_placed, payment_confirmed, order_shipped, order_cancelled, checkout_started e account_created.