Skip to main content
Ao criar ou atualizar uma integração, você define a lista de events que a ativam. Cada evento corresponde a uma mudança de estado de um pedido ou a uma ação do comprador.

Eventos disponíveis

ValorLabelDescrição
order.paidPedido PagoDisparado quando o pagamento é confirmado.
order.createdPedido CriadoDisparado assim que o pedido é gerado (antes do pagamento).
order.refundedPedido EstornadoDisparado quando um reembolso é processado.
order.expiredPedido ExpiradoDisparado quando o prazo de pagamento vence.
order.failedPedido FalhouDisparado quando a tentativa de pagamento é recusada.
order.abandonedCarrinho AbandonadoDisparado quando um pedido permanece sem pagamento após o checkout (carrinho abandonado).
lead.createdLead CriadoDisparado quando um novo lead é registrado via checkout.
Para a maioria das integrações de vendas, assine ao menos order.paid e order.refunded. Use order.created para rastrear intenções de compra em ferramentas de analytics.

Suporte por tipo de integração

Nem todos os tipos processam todos os eventos. A tabela abaixo indica os eventos reconhecidos por cada tipo:
Tipoorder.paidorder.createdorder.refundedorder.expiredorder.failedorder.abandonedlead.created
webhook
roigenius
active_campaign
make
zapier
google_analytics
utmify
hotzapp
meta_pixel
cademi
themembers
curseduca
circle
memberkit
leadlovers
rdstation
mailchimp
voxuy
spedy
bling
notazz / enotas / plugnotas
Ao configurar uma integração, só é possível assinar os eventos que aquele tipo realmente despacha (a lista acima). Eventos não suportados são rejeitados na criação/edição.
Os tipos webhook e roigenius encaminham o payload completo para qualquer evento (incluindo lead.created). Os tipos make e zapier encaminham apenas eventos de pedido (order.*).

Payload do evento

Quando um evento é disparado, a integração recebe um objeto com a seguinte estrutura geral:
{
  "event": "order.paid",
  "order_id": 123,
  "data": {
    "purchase": {
      "transaction": "ABC123DEF456",
      "approved_date": 1736524800000,
      "refund_date": null,
      "payment": {
        "type": "credit_card"
      },
      "price": {
        "value": 197.00,
        "currency_value": "BRL"
      },
      "full_price": {
        "value": 297.00
      },
      "tracking": {
        "source": "google",
        "utm_source": "google",
        "utm_medium": "cpc",
        "utm_campaign": "black-friday",
        "utm_content": null,
        "utm_term": null,
        "src": null,
        "sck": null,
        "fbclid": "IwAR..."
      }
    },
    "product": {
      "id": 1,
      "name": "Curso de Marketing Digital"
    },
    "buyer": {
      "name": "João Silva",
      "email": "joao@exemplo.com",
      "document": "123.456.789-00",
      "checkout_phone": "+5511999990000",
      "ip": "177.0.0.1"
    }
  }
}
O campo purchase.transaction é o identificador único do pedido e pode ser usado como chave de idempotência na sua integração.

Rastreamento (tracking)

Todos os eventos order.* incluem data.purchase.tracking (e os eventos lead.created incluem data.lead.tracking). O objeto contém todos os parâmetros de URL capturados no checkout, exatamente como vieram, acrescidos das chaves de UTM padronizadas — que estarão sempre presentes (com valor null quando ausentes):
CampoDescrição
sourceOrigem resolvida: utm_source ou, na falta dele, src.
utm_source, utm_medium, utm_campaign, utm_content, utm_termParâmetros UTM padrão.
src, sckCódigos de rastreamento de afiliado/origem.
(outros)Qualquer parâmetro extra presente na URL do checkout (ex.: fbclid, gclid, xcod) é repassado no mesmo nível.
As chaves de UTM acima são garantidas no objeto (mesmo que null). Parâmetros adicionais aparecem apenas quando presentes na URL — não assuma um conjunto fixo de chaves.