Skip to main content
Este documento descreve os payloads de webhook relacionados a clientes.

​
Eventos de Clientes

Enviado quando um novo cliente é criado no sistema.
{
  "Customer": {
    "Id": "12345",
    "OriginalId": "cliente_original_123",
    "Email": "cliente@exemplo.com",
    "Name": "João Silva",
    "Phone": "+5511999998888",
    "Document": "12345678900",
    "BirthDate": "1990-05-20",
    "Level": "Ouro",
    "Active": "true"
  },
  "PointsBalance": {
    "PointsBalance": 0,
    "CashbackBalance": 0.00
  }
}
​
Customer
object
required
Objeto com informações do cliente criado. Veja abaixo.
​
PointsBalance
object
required
Objeto Saldo de Pontos
Enviado quando um cliente existente é atualizado.
{
  "Customer": {
    "Id": "12345",
    "OriginalId": "cliente_original_123",
    "Email": "cliente@exemplo.com",
    "Name": "João Silva Santos",
    "Phone": "+5511999998888",
    "Document": "12345678900",
    "BirthDate": "1990-05-20",
    "Level": "Platina",
    "Active": "true"
  },
  "PointsBalance": {
    "PointsBalance": 1500,
    "CashbackBalance": 15.00
  }
}
​
Customer
object
required
Objeto com informações atualizadas do cliente. Veja abaixo.
​
PointsBalance
object
required
Objeto Saldo de Pontos

​
Objeto CustomerInfo

Estrutura específica do objeto Customer para eventos de clientes: 
{
  "Id": "12345",
  "OriginalId": "cliente_original_123",
  "Email": "cliente@exemplo.com",
  "Name": "João Silva",
  "Phone": "+5511999998888",
  "Document": "12345678900",
  "BirthDate": "1990-05-20",
  "Level": "Ouro",
  "Active": "true"
}
​
Id
string
required
ID interno do cliente no sistema BonifiQ
​
OriginalId
string
required
ID do cliente no sistema de origem (ex: plataforma e-commerce)
​
Email
string
required
Endereço de e-mail do cliente
​
Name
string
required
Nome completo do cliente
​
Phone
string
Número de telefone. Pode ser null.
​
Document
string
Documento de identificação (ex: CPF). Pode ser null.
​
BirthDate
string
Data de nascimento. Pode ser null.
​
Level
string
Nome do nível/tier do cliente. Pode ser null.
​
Active
string
Status de ativo do cliente (“true” ou “false”). Pode ser null.

​
Tópicos Disponíveis

TópicoDescrição
Customer_CreatedCliente criado
Customer_UpdatedCliente atualizado
Documentação atualizada em Janeiro de 2026.