Eventos suportados (Event Keys)

O campo key de cada evento enviado ao POST /track ou POST /customer-events deve usar exatamente um dos valores abaixo. Eventos com key desconhecido são rejeitados com 404 Not Found.

Os nomes seguem a Segment V2 Ecommerce Spec.

E-commerce — Browsing

Event key	Quando disparar
`Products Searched`	Cliente faz uma busca
`Product List Viewed`	Lista de produtos é exibida (categoria, busca)
`Product List Filtered`	Filtro aplicado em uma lista de produtos
`Promotion Viewed`	Promoção/banner exibido
`Promotion Clicked`	Promoção/banner clicado
`Product Clicked`	Produto clicado em uma lista
`Product Viewed`	Página de detalhe do produto vista

Products Searched

{
  "key": "Products Searched",
  "data": {
    "query": "camiseta preta"
  }
}

Product List Viewed

{
  "key": "Product List Viewed",
  "data": {
    "list_id": "home_featured",
    "category": "Camisetas",
    "products": [
      {
        "product_id": "507f1f77bcf86cd799439011",
        "sku": "45790-32",
        "name": "Monopoly: 3rd Edition",
        "price": 19,
        "position": 1
      }
    ]
  }
}

Cada item do array products segue a Interface do Produto.

Product List Filtered

{
  "key": "Product List Filtered",
  "data": {
    "list_id": "search_results",
    "category": "Camisetas",
    "filters": [{ "type": "color", "value": "preto" }],
    "sorts": [{ "type": "price", "value": "asc" }],
    "products": [
      {
        "product_id": "507f1f77bcf86cd799439011",
        "sku": "45790-32",
        "name": "Monopoly: 3rd Edition",
        "price": 19,
        "position": 1
      }
    ]
  }
}

Cada item do array products segue a Interface do Produto.

Promotion Viewed e Promotion Clicked

Ambos os eventos compartilham a mesma estrutura. Ver Interface da Promoção.

Product Clicked e Product Viewed

Ambos recebem diretamente um objeto Produto em data.

E-commerce — Carrinho

Event key	Quando disparar
`Product Added`	Produto adicionado ao carrinho
`Product Removed`	Produto removido do carrinho
`Cart Viewed`	Página do carrinho vista

Product Added e Product Removed

Ambos os eventos compartilham a mesma estrutura: um objeto Produto estendido com os campos do carrinho.

{
  "key": "Product Added",
  "data": {
    "cart_id": "cart-abc123",
    "product_id": "507f1f77bcf86cd799439011",
    "sku": "45790-32",
    "name": "Monopoly: 3rd Edition",
    "price": 19,
    "quantity": 1,
    "category": "Games",
    "url": "https://www.example.com/product/path",
    "image_url": "https://www.example.com/product/path.jpg"
  }
}

Cart Viewed

{
  "key": "Cart Viewed",
  "data": {
    "cart_id": "cart-abc123",
    "products": [
      {
        "product_id": "507f1f77bcf86cd799439011",
        "sku": "45790-32",
        "name": "Monopoly: 3rd Edition",
        "price": 19,
        "quantity": 1
      }
    ]
  }
}

Cada item do array products segue a Interface do Produto.

E-commerce — Checkout

Event key	Quando disparar
`Checkout Started`	Cliente entra no fluxo de checkout
`Checkout Step Viewed`	Uma etapa do checkout é exibida
`Checkout Step Completed`	Uma etapa do checkout é concluída
`Payment Info Entered`	Cliente informa dados de pagamento

Checkout Started

{
  "key": "Checkout Started",
  "data": {
    "order_id": "ORD-9182",
    "affiliation": "456231",
    "value": 199.9,
    "revenue": 199.9,
    "shipping": 10.0,
    "tax": 0,
    "discount": 0,
    "coupon": "",
    "currency": "BRL",
    "products": [
      {
        "product_id": "507f1f77bcf86cd799439011",
        "sku": "45790-32",
        "name": "Monopoly: 3rd Edition",
        "price": 19,
        "quantity": 1
      }
    ]
  }
}

Cada item do array products segue a Interface do Produto.

Checkout Step Viewed e Checkout Step Completed

Ambos os eventos compartilham a mesma estrutura:

{
  "key": "Checkout Step Viewed",
  "data": {
    "checkout_id": "checkout-abc123",
    "step": 2,
    "shipping_method": "Fedex",
    "payment_method": "Visa"
  }
}

Payment Info Entered

{
  "key": "Payment Info Entered",
  "data": {
    "checkout_id": "checkout-abc123",
    "payment_method": "credit_card"
  }
}

E-commerce — Pedidos

Event key	Quando disparar
`Order Updated`	Pedido atualizado (antes da confirmação)
`Order Completed`	Pedido finalizado — dispara o fluxo de atribuição
`Order Refunded`	Pedido reembolsado
`Order Cancelled`	Pedido cancelado

O evento Order Completed é especial: ele aciona a resolução de atribuição (qual campanha/touchpoint recebe crédito pela conversão).

Todos os eventos de pedido compartilham a Interface do Pedido.

E-commerce — Cupons

Event key	Quando disparar
`Coupon Entered`	Cliente digitou um código de cupom
`Coupon Applied`	Cupom aplicado com sucesso
`Coupon Denied`	Cupom inválido / não aplicável
`Coupon Removed`	Cupom removido pelo cliente

Coupon Entered e Coupon Removed

Ambos os eventos compartilham a mesma estrutura:

{
  "key": "Coupon Entered",
  "data": {
    "order_id": "ORD-9182",
    "cart_id": "cart-abc123",
    "coupon_id": "PROMO10"
  }
}

Coupon Applied

{
  "key": "Coupon Applied",
  "data": {
    "order_id": "ORD-9182",
    "cart_id": "cart-abc123",
    "coupon_id": "PROMO10",
    "coupon_name": "10% OFF",
    "discount": 19.99
  }
}

Coupon Denied

{
  "key": "Coupon Denied",
  "data": {
    "order_id": "ORD-9182",
    "cart_id": "cart-abc123",
    "coupon_id": "PROMO10",
    "reason": "Cupom expirado"
  }
}

Coupon Denied

{
  "key": "Coupon Removed",
  "data": {
    "order_id": "ORD-9182",
    "cart_id": "cart-abc123",
    "coupon_id": "PROMO10",
    "coupon_name": "10% OFF",
    "discount": 19.99
  }
}

E-commerce — Wishlist e compartilhamento

Event key	Quando disparar
`Product Added to Wishlist`	Produto adicionado à lista de desejos
`Product Removed from Wishlist`	Produto removido da lista de desejos
`Wishlist Product Added to Cart`	Item da wishlist movido para o carrinho
`Product Shared`	Cliente compartilhou um produto
`Cart Shared`	Cliente compartilhou o carrinho
`Product Reviewed`	Cliente deixou uma avaliação

Product Added to Wishlist, Product Removed from Wishlist e Wishlist Product Added to Cart

Os três eventos compartilham a mesma estrutura: um objeto Produto estendido com wishlist_id e wishlist_name.

{
  "key": "Product Added to Wishlist",
  "data": {
    "wishlist_id": "wishlist-abc123",
    "wishlist_name": "Minha Lista",
    "product_id": "507f1f77bcf86cd799439011",
    "sku": "45790-32",
    "name": "Monopoly: 3rd Edition",
    "price": 19,
    "category": "Games"
  }
}

Product Shared

Objeto share_via, share_message e recipient + Produto estendido com campos de compartilhamento:

{
  "key": "Product Shared",
  "data": {
    "share_via": "whatsapp",
    "share_message": "Olha esse produto!",
    "recipient": "55999999999",
    "product_id": "507f1f77bcf86cd799439011",
    "sku": "45790-32",
    "name": "Monopoly: 3rd Edition",
    "price": 19
  }
}

Cart Shared

{
  "key": "Cart Shared",
  "data": {
    "share_via": "email",
    "share_message": "Olha meu carrinho!",
    "recipient": "friend@example.com",
    "cart_id": "cart-abc123",
    "products": [
      {
        "product_id": "507f1f77bcf86cd799439011",
        "sku": "45790-32",
        "name": "Monopoly: 3rd Edition",
        "price": 19
      }
    ]
  }
}

Product Reviewed

Objeto com campos de avaliação:

{
  "key": "Product Reviewed",
  "data": {
    "review_id": "rev-001",
    "review_body": "Ótimo produto!",
    "rating": 5,
    "product_id": "507f1f77bcf86cd799439011",
    "sku": "45790-32"
  }
}

Eventos não e-commerce

Event key	Quando disparar
`Page View`	Visualização de página genérica
`Signed In`	Usuário fez login
`Signed Out`	Usuário fez logout
`Account Created`	Usuário criou conta
`Account Deleted`	Usuário deletou conta

Interfaces de referência

Interface do Produto

Usada por: Product Viewed, Product Clicked, Product Added, Product Removed, e eventos de Wishlist e compartilhamento.

Campo	Tipo	Descrição
`product_id`	`string`	ID interno do produto no seu sistema
`sku`	`string`	SKU do produto
`ean`	`string`	EAN do produto
`name`	`string`	Nome do produto
`price`	`number`	Preço unitário
`position`	`number`	Posição na lista (ex.: resultado de busca, vitrine)
`category`	`string`	Categoria do produto
`url`	`string`	URL da página do produto
`image_url`	`string`	URL da imagem principal do produto

{
  "product_id": "507f1f77bcf86cd799439011",
  "sku": "45790-32",
  "ean": "4128734",
  "name": "Monopoly: 3rd Edition",
  "price": 19,
  "position": 1,
  "category": "Games",
  "url": "https://www.example.com/product/path",
  "image_url": "https://www.example.com/product/path.jpg"
}

Interface do Pedido

Usada por: Order Completed, Order Updated, Order Refunded e Order Cancelled.

Campo	Tipo	Descrição
`order_id`	`string`	ID do pedido
`total`	`number`	Valor total (produtos + frete + imposto)
`revenue`	`number`	Receita bruta (sem frete e imposto)
`shipping`	`number`	Valor do frete
`tax`	`number`	Impostos
`discount`	`number`	Desconto aplicado
`coupon`	`string`	Código do cupom utilizado
`currency`	`string`	Código ISO 4217 (ex.: `BRL`)
`products`	`Produto[]`	Lista de produtos. Ver Interface do Produto

{
  "key": "Order Completed",
  "data": {
    "order_id": "ORD-9182",
    "total": 199.9,
    "revenue": 189.9,
    "shipping": 10.0,
    "tax": 0,
    "discount": 0,
    "coupon": "",
    "currency": "BRL",
    "products": [
      {
        "product_id": "507f1f77bcf86cd799439011",
        "sku": "45790-32",
        "name": "Monopoly: 3rd Edition",
        "price": 19,
        "quantity": 1
      },
      {
        "product_id": "SKU-456",
        "sku": "78901-11",
        "name": "Xadrez Clássico",
        "price": 170.9,
        "quantity": 1
      }
    ]
  }
}

Interface da Promoção

Usada por: Promotion Viewed e Promotion Clicked.

Campo	Tipo	Descrição
`promotion_id`	`string`	ID da promoção
`name`	`string`	Nome da promoção
`creative`	`string`	Identificador do criativo (ex.: `banner_topo`)
`position`	`string`	Posição na página (ex.: `slot_1`)

{
  "key": "Promotion Viewed",
  "data": {
    "promotion_id": "promo-summer-2025",
    "name": "Liquidação de Verão",
    "creative": "banner_topo",
    "position": "slot_1"
  }
}

E-commerce — Browsing​

Products Searched​

Product List Viewed​

Product List Filtered​

Promotion Viewed e Promotion Clicked​

Product Clicked e Product Viewed​

E-commerce — Carrinho​

Product Added e Product Removed​

Cart Viewed​

E-commerce — Checkout​

Checkout Started​

Checkout Step Viewed e Checkout Step Completed​

Payment Info Entered​

E-commerce — Pedidos​

E-commerce — Cupons​

Coupon Entered e Coupon Removed​

Coupon Applied​

Coupon Denied​

Coupon Denied​

E-commerce — Wishlist e compartilhamento​

Product Added to Wishlist, Product Removed from Wishlist e Wishlist Product Added to Cart​

Product Shared​

Cart Shared​

Product Reviewed​

Eventos não e-commerce​

Interfaces de referência​

Interface do Produto​

Interface do Pedido​

Interface da Promoção​

E-commerce — Browsing

Products Searched

Product List Viewed

Product List Filtered

Promotion Viewed e Promotion Clicked

Product Clicked e Product Viewed

E-commerce — Carrinho

Product Added e Product Removed

Cart Viewed

E-commerce — Checkout

Checkout Started

Checkout Step Viewed e Checkout Step Completed

Payment Info Entered

E-commerce — Pedidos

E-commerce — Cupons

Coupon Entered e Coupon Removed

Coupon Applied

Coupon Denied

Coupon Denied

E-commerce — Wishlist e compartilhamento

Product Added to Wishlist, Product Removed from Wishlist e Wishlist Product Added to Cart

Product Shared

Cart Shared

Product Reviewed

Eventos não e-commerce

Interfaces de referência

Interface do Produto

Interface do Pedido

Interface da Promoção