Eventos Disponiveis

Tabela de Eventos

Evento	Descricao	Trigger
person.created	Nova pessoa cadastrada	Criacao via API ou painel
person.updated	Dados de pessoa atualizados	Atualizacao via API ou painel
person.inactivated	Pessoa inativada	Inativacao via painel
deal.created	Novo negocio criado	Criacao via API ou painel
deal.updated	Negocio atualizado (dados ou estagio)	Atualizacao via API ou painel
deal.stage_changed	Negocio movido para outro estagio no pipeline	Mudanca de estagio
deal.won	Negocio ganho (fechamento com sucesso)	Marcacao como ganho
deal.lost	Negocio perdido	Marcacao como perdido
financial.created	Lancamento financeiro criado	Criacao via API ou painel
financial.settled	Lancamento liquidado (pagamento confirmado)	Baixa manual ou automatica
financial.overdue	Lancamento vencido	Processamento diario de vencimentos
financial.cancelled	Lancamento cancelado	Cancelamento via painel
product.created	Novo produto cadastrado	Criacao via API ou painel
product.updated	Produto atualizado	Atualizacao via API ou painel
project.created	Novo projeto criado	Criacao via API ou painel
project.status_changed	Status do projeto alterado	Mudanca de status

Estrutura do Payload

Todos os eventos seguem a mesma estrutura base:

{
  "id": "evt_clx123abc456",
  "event": "nome.do.evento",
  "timestamp": "2026-03-25T10:30:00.000Z",
  "data": { }
}

Campo	Tipo	Descricao
id	string	Identificador unico do evento (para idempotencia)
event	string	Nome do evento
timestamp	string	Data/hora do evento (ISO 8601)
data	object	Dados do recurso afetado

Exemplos de Payload por Evento

person.created

{
  "id": "evt_clx001",
  "event": "person.created",
  "timestamp": "2026-03-25T10:30:00.000Z",
  "data": {
    "id": "clx2b3c4d5e6f7g8h9i0j1k2",
    "name": "Maria Oliveira",
    "socialName": null,
    "documentNumber": "12345678901",
    "personType": "INDIVIDUAL",
    "email": "maria@email.com",
    "phone": "+5521988887777",
    "classifications": ["CUSTOMER"],
    "isActive": true
  }
}

deal.created

{
  "id": "evt_clx002",
  "event": "deal.created",
  "timestamp": "2026-03-25T11:00:00.000Z",
  "data": {
    "id": "clx3c4d5e6f7g8h9i0j1k2l3",
    "code": "NEG-1042",
    "title": "Implantacao Tesselys - Tech Solutions",
    "customerId": "clx1a2b3c4d5e6f7g8h9i0j1",
    "customerName": "Tech Solutions Ltda",
    "dealType": "COMMERCIAL",
    "dealPipelineId": "clxpipe001",
    "dealStageId": "clxstage001",
    "amount": 85000.00,
    "isActive": true
  }
}

deal.stage_changed

{
  "id": "evt_clx003",
  "event": "deal.stage_changed",
  "timestamp": "2026-03-25T14:00:00.000Z",
  "data": {
    "id": "clx3c4d5e6f7g8h9i0j1k2l3",
    "code": "NEG-1042",
    "title": "Implantacao Tesselys - Tech Solutions",
    "previousStageId": "clxstage001",
    "previousStageName": "Qualificacao",
    "currentStageId": "clxstage003",
    "currentStageName": "Proposta Enviada"
  }
}

deal.won

{
  "id": "evt_clx004",
  "event": "deal.won",
  "timestamp": "2026-03-25T16:00:00.000Z",
  "data": {
    "id": "clx3c4d5e6f7g8h9i0j1k2l3",
    "code": "NEG-1042",
    "title": "Implantacao Tesselys - Tech Solutions",
    "customerId": "clx1a2b3c4d5e6f7g8h9i0j1",
    "customerName": "Tech Solutions Ltda",
    "amount": 85000.00,
    "wonAt": "2026-03-25T16:00:00.000Z"
  }
}

financial.created

{
  "id": "evt_clx005",
  "event": "financial.created",
  "timestamp": "2026-03-25T09:00:00.000Z",
  "data": {
    "id": "clx5e6f7g8h9i0j1k2l3m4n5",
    "code": "REC-2030",
    "title": "Fatura Mensal - Tech Solutions",
    "personId": "clx1a2b3c4d5e6f7g8h9i0j1",
    "personName": "Tech Solutions Ltda",
    "typeCategory": "REVENUE",
    "status": "PENDING",
    "originalAmount": 8500.00,
    "originalDueDate": "2026-03-31T00:00:00.000Z",
    "paymentMethod": "BANK_SLIP"
  }
}

financial.settled

{
  "id": "evt_clx006",
  "event": "financial.settled",
  "timestamp": "2026-03-28T10:00:00.000Z",
  "data": {
    "id": "clx5e6f7g8h9i0j1k2l3m4n5",
    "code": "REC-2030",
    "title": "Fatura Mensal - Tech Solutions",
    "personId": "clx1a2b3c4d5e6f7g8h9i0j1",
    "typeCategory": "REVENUE",
    "status": "SETTLED",
    "originalAmount": 8500.00,
    "paidAmount": 8500.00,
    "paymentDate": "2026-03-28T10:00:00.000Z"
  }
}

project.status_changed

{
  "id": "evt_clx007",
  "event": "project.status_changed",
  "timestamp": "2026-03-25T15:00:00.000Z",
  "data": {
    "id": "clxa0j1k2l3m4n5o6p7q8r9s0",
    "code": "PRP-1015",
    "title": "Implantacao Tesselys - Fase 2",
    "previousStatus": "PLANNING",
    "currentStatus": "IN_PROGRESS",
    "responsibleId": "clxuser001",
    "responsibleName": "Carlos Silva"
  }
}

Observacoes

• Eventos sao enviados em tempo real (geralmente em menos de 1 segundo apos a acao)
• O campo data contem um subconjunto dos campos do recurso, otimizado para o evento
• Para obter o recurso completo apos receber o evento, faca um GET no endpoint correspondente usando o id do data
• Eventos de inactivated e cancelled indicam soft delete — o recurso continua existindo, mas com isActive: false ou status terminal