Skip to main content
Este documento descreve os payloads de webhook relacionados a comunicações com clientes. Campo comum adicional: todos os payloads de comunicação abaixo também expõem PointsBalance no nível raiz, usando o Objeto Saldo de Pontos para o saldo consolidado de pontos e cashback do cliente após o processamento do evento. O campo legado Customer.PointsBalance permanece disponível por compatibilidade.

​
Cupons

Enviado quando uma comunicação é disparada referente a cupons disponíveis para o cliente usar.
{
  "CouponType": 1,
  "ValidDateEnd": "2025-12-31T23:59:59Z",
  "CouponValue": 10.00,
  "CouponCode": "BEMVINDO10",
  "Customer": { ... },
  "PointsBalance": { ... }
}
​
CouponType
number
required
Tipo do cupom. Veja CouponType
​
ValidDateEnd
string
Data de expiração (ISO 8601), se houver. Pode ser null.
​
CouponValue
number
required
Valor do cupom (ex: 10.0 para 10% ou R$10,00)
​
CouponCode
string
required
Código para resgate
​
Customer
object
required
Objeto Cliente
​
PointsBalance
object
required
Objeto Saldo de Pontos

​
Resgate de Recompensas

Enviado após um cliente resgatar pontos por uma recompensa personalizada.
{
  "Points": 500,
  "RewardDescription": "Caneca Grátis com Logo",
  "Coupon": "RESGATECAN123",
  "Customer": { ... },
  "PointsBalance": { ... }
}
​
Points
number
required
Pontos gastos no resgate
​
RewardDescription
string
required
Descrição da recompensa
​
Coupon
string
Código de cupom gerado, se aplicável. Pode ser null.
​
Customer
object
required
Objeto Cliente
​
PointsBalance
object
required
Objeto Saldo de Pontos

​
Ganho de Pontos

Estes tópicos são enviados quando um cliente ganha pontos. A estrutura varia conforme o tipo de objetivo. Campos Base Comuns:
​
EarnedPoints
number
required
Pontos ganhos neste evento
​
ObjectiveType
number
required
Tipo de objetivo. Veja ObjectiveType
​
Customer
object
required
Objeto Cliente
​
PointsBalance
object
required
Objeto Saldo de Pontos
Ganho de pontos por uma compra.
{
  "EarnedPoints": 150,
  "ObjectiveType": 0,
  "Customer": { ... },
  "PointsBalance": { ... },
  "CashbackEarned": 1.50,
  "CashbackEarnedFormatted": "R$ 1,50",
  "ValidDate": "2026-04-15T00:00:00Z",
  "ValidDateFormatted": "15/04/2026",
  "OrderDate": "2025-04-15T10:05:00Z",
  "OrderDateFormatted": "15/04/2025",
  "OrderValue": 150.00,
  "OrderValueFormatted": "R$ 150,00",
  "PercentCashbackEarned": 0.01,
  "PercentCashbackEarnedFormatted": "1,00%",
  "Date": "2025-04-15T10:05:10Z",
  "OrderId": "pedido_123",
  "PointId": 98765
}
Campos Adicionais:
​
CashbackEarned
number
Cashback ganho
​
CashbackEarnedFormatted
string
Cashback ganho formatado em moeda (pt-BR)
​
ValidDate
string
Expiração dos pontos/cashback
​
ValidDateFormatted
string
Data de expiração formatada (dd/MM/yyyy)
​
OrderDate
string
required
Data do pedido
​
OrderDateFormatted
string
required
Data do pedido formatada (dd/MM/yyyy)
​
OrderValue
number
required
Valor total do pedido
​
OrderValueFormatted
string
required
Valor total do pedido formatado em moeda (pt-BR)
​
PercentCashbackEarned
number
Taxa de cashback (ex: 0.01 = 1%)
​
PercentCashbackEarnedFormatted
string
Taxa de cashback formatada em percentual (pt-BR)
​
Date
string
required
Data do registro do evento
​
OrderId
string
required
ID do pedido no sistema de origem
​
PointId
number
required
ID interno do registro de ponto
Ganho de pontos como bônus de aniversário.
{
  "EarnedPoints": 100,
  "ObjectiveType": 2,
  "Customer": { ... },
  "PointsBalance": { ... },
  "BirthdayPoints": 100,
  "BirthdayBonification": "Bônus Feliz Aniversário!",
  "CouponType": 1,
  "CouponCode": "NIVERPRESENTE",
  "RedeemUrl": "https://exemplo.com/resgatar-niver"
}
Campos Adicionais:
​
BirthdayPoints
number
required
Pontos do aniversário
​
BirthdayBonification
string
Descrição do bônus
​
CouponType
number
Tipo do cupom concedido
​
CouponCode
string
Código do cupom
​
RedeemUrl
string
URL para resgate
Ganho de pontos por cadastro. Usa apenas os campos base comuns.
Ganho de pontos por review. Usa apenas os campos base comuns.
Ganho de pontos por indicação.
{
  "EarnedPoints": 200,
  "ObjectiveType": 4,
  "Customer": { ... },
  "PointsBalance": { ... },
  "FriendName": "Maria Souza"
}
Campo Adicional:
​
FriendName
string
Nome do amigo indicado
Ganho de pontos por quiz. Usa apenas os campos base comuns.
Ganho de pontos por objetivo personalizado. Usa apenas os campos base comuns.
Os tópicos abaixo usam a estrutura base comum:
  • Communication_EarnSocialMediaFollowInstagram (ObjectiveType: 5)
  • Communication_EarnSocialMediaFollowFacebook (ObjectiveType: 6)
  • Communication_EarnSocialMediaFollowLinkedin (ObjectiveType: 9)
  • Communication_EarnSocialMediaFollowTikTok (ObjectiveType: 10)

​
Alteração de Pontos

Enviado quando há alteração manual ou diversa no saldo de pontos.
{
  "Points": -50,
  "PointsValidDate": "01/08/2025",
  "Customer": { ... },
  "PointsBalance": { ... }
}
​
Points
number
required
Pontos da alteração (positivo = adição, negativo = subtração)
​
PointsValidDate
string
required
Data de expiração formatada
​
Customer
object
required
Objeto Cliente
​
PointsBalance
object
required
Objeto Saldo de Pontos

​
Pontos Disponíveis

Enviado para informar o cliente sobre seu potencial de resgate.
{
  "PointsToUse": 1500,
  "maxValueDiscount": "R$ 15,00",
  "maxPercentDiscount": "10%",
  "CashbackToUse": 15.00,
  "CashbackToUseFormatted": "R$ 15,00",
  "Customer": { ... },
  "PointsBalance": { ... }
}
​
PointsToUse
number
required
Total de pontos disponíveis
​
maxValueDiscount
string
required
Desconto monetário máximo formatado
​
maxPercentDiscount
string
required
Desconto percentual máximo formatado
​
CashbackToUse
number
Cashback disponível para uso. Pode ser null.
​
CashbackToUseFormatted
string
Cashback disponível formatado em moeda (pt-BR)
​
Customer
object
required
Objeto Cliente
​
PointsBalance
object
required
Objeto Saldo de Pontos

​
Expiração de Pontos

Enviado para notificar sobre pontos próximos da expiração.
{
  "PointsToExpire": 250,
  "ExpirationAt": "2025-07-31T23:59:59Z",
  "ExpirationDate": "31/07/2025",
  "PointId": 12345,
  "ValidDate": "2025-07-31T23:59:59Z",
  "ValidDateFormatted": "31/07/2025",
  "CashbackToExpire": 2.50,
  "CashbackToExpireFormatted": "R$ 2,50",
  "Customer": { ... },
  "PointsBalance": { ... }
}
​
PointsToExpire
number
required
Quantidade de pontos que expirarão
​
ExpirationAt
string
required
Data/hora de expiração (ISO 8601)
​
ExpirationDate
string
required
Data formatada para exibição
​
PointId
number
required
ID interno do registro de ponto
​
ValidDate
string
Data de validade dos pontos (ISO 8601). Pode ser null.
​
ValidDateFormatted
string
Data de validade formatada (dd/MM/yyyy)
​
CashbackToExpire
number
Valor de cashback que expirará. Pode ser null.
​
CashbackToExpireFormatted
string
Valor de cashback formatado em moeda (pt-BR)
​
Customer
object
required
Objeto Cliente
​
PointsBalance
object
required
Objeto Saldo de Pontos

​
Resgate de Pontos

Enviado após resgate de pontos por recompensa padrão.
{
  "CouponCode": "RESGATE5OFF",
  "CouponDescription": "Cupom de Desconto R$ 5,00",
  "Points": 500,
  "Customer": { ... },
  "PointsBalance": { ... }
}
​
CouponCode
string
required
Código do cupom gerado
​
CouponDescription
string
required
Descrição da recompensa
​
Points
number
required
Pontos gastos
​
Customer
object
required
Objeto Cliente
​
PointsBalance
object
required
Objeto Saldo de Pontos

​
OTP (Código de Verificação)

Enviado quando um código OTP é enviado ao cliente.
Nota de Segurança: Seja cauteloso ao processar OTPs via webhooks. Garanta que seu endpoint e lógica sejam seguros.
{
  "OTP": "123456",
  "Customer": { ... }
}
​
OTP
string
required
Senha de uso único enviada
​
Customer
object
required
Objeto Cliente

​
Níveis/Tiers

Enviado quando o nível de fidelidade do cliente muda.
{
  "TierName": "Ouro",
  "Benefits": [
    "Frete Grátis em todos os pedidos",
    "Acesso antecipado a promoções"
  ],
  "NextTierTargets": [
    "Gastar R$ 5000 nos próximos 6 meses"
  ],
  "Customer": { ... },
  "PointsBalance": { ... }
}
​
TierName
string
required
Nome do novo nível
​
Benefits
array
required
Lista de benefícios do nível
​
NextTierTargets
array
required
Requisitos para próximo nível (vazio se for o mais alto)
​
Customer
object
required
Objeto Cliente
​
PointsBalance
object
required
Objeto Saldo de Pontos
Documentação atualizada em Dezembro de 2025.