Este artigo aborda alguns aspectos mais técnicos sobre Webhooks. Caso queira uma introdução sobre Webhooks, dá uma conferida neste artigo.

Funcionamento geral

Após o evento ser disparado dentro do Conexa, o envio da requisição (notificação) será realizado de forma assíncrona em até 5 minutos com no máximo 3 tentativas e um tempo máximo de espera de 15 segundos por requisição.

Uma Conexão será bloqueada após a falha consecutiva de 5 requisições.

Um aviso informando que existem Conexões bloqueadas será exibido na página inicial. Ao clicar no link do aviso, serão exibidas as Conexões bloqueadas e também a opção de desbloqueá-las.

Índice de eventos

Eventos de Cobrança

Geração

Ao gerar uma cobrança (avulsa ou contratual), o evento será disparado (com o status "Pendente") em dois momentos distintos:

Caso o meio de faturamento seja "Outros", será disparado após o faturamento
Caso o meio de faturamento seja boleto, será disparado após a geração do boleto (via API ou arquivo de remessa)

CAMPO	TIPO	DESCRIÇÃO
chargeId	int	ID da Cobrança
receivingMethod	string	Meio de recebimento/faturamento
type	string	Tipo da Cobrança. Pode receber os seguintes valores: loose (Avulsa) contractual (Contratual) returnableDeposit (Depósito Retornável)
status	string	Status da Cobrança. Pode receber os seguintes valores: unpaid (Aberta) generatedByNegotiation (Gerada por Negociação)
amount	float	É o valor bruto subtraído dos descontos
currentAmount	float	É o valor atualizado com juros e multas
rawAmount	float	Valor bruto. Soma de todas as vendas vinculadas à cobrança
rawReceiptAmount	float	Valor do recibo de locação bruto
hasISSRetention	boolean	Atributo booleano indicando se retém ISS
ISSAmount	float	Valor do ISS (Imposto sobre serviço) retido nessa cobrança
discountAmount	float	Valor do desconto concedido no faturamento
installmentNumber	int	Número da parcela dessa cobrança. Se não for cobrança parcelada seu valor será 1.
totalInstallmentsAmount	float	Total de parcelas em que a cobrança foi dividida no momento do faturamento. Só é preenchido quando a cobrança original é parcelada.
dueDate	string	Data de vencimento no formato Y-m-d (ano-mês-dia)
competenceDate	string	Data de vencimento no formato Y-m-d (ano-mês-dia)
notes	string	Observações
taxInvoiceNumber	string	Número da nota fiscal
createdAt	string	Data emissão no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
receiptCode	string	Código do recibo de locação
billetDigitableLine	string	Linha digitável do boleto
chargeUrl	string	URL da Fatura
billetUrl	string	URL do boleto
company	object	Objeto com informações da Unidade
customer	object	Objeto com informações do Cliente
account	object	Objeto com informações da Conta
sales	array-object	Um array de objetos com informações das Vendas vinculadas a Cobrança

Quitação

O evento será disparado quando uma cobrança for quitada de forma automática (boleto, API, Cielo, Pix e etc) ou via quitação por arquivo de retorno. A quitação manual da cobrança (ação do usuário através do Conexa) não irá disparar o evento.

CAMPO	TIPO	DESCRIÇÃO
chargeId	oint	ID da Cobrança
receivingMethod	string	Meio de recebimento/faturamento
type	string	Tipo da Cobrança. Pode receber os seguintes valores: loose (Avulsa) contractual (Contratual) returnableDeposit (Depósito Retornável)
amount	float	É o valor bruto subtraído dos descontos
currentAmount	float	É o valor atualizado com juros e multas
rawAmount	float	Valor bruto. Soma de todas vendas que fazem parte cobrança
paidAmount	float	Valor pago na quitação
receiptAmount	float	Valor do recibo menos os descontos
rawReceiptAmount	float	Valor do recibo bruto
hasISSRetention	boolean	Atributo booleano indicando se retém ISS
ISSAmount	float	Valor do ISS (Imposto sobre serviço) retido nessa cobrança
discountAmount	float	Valor do desconto concedido no faturamento
totalDiscountAmount	float	Valor do desconto concedido no faturamento somado ao valor do desconto concedido na quitação
installmentNumber	int	Número da parcela dessa cobrança. Se a cobrança não for parcelada seu valor será 1.
totalInstallmentsAmount	float	Total de parcelas em que a cobrança foi dividida no momento do faturamento. Só é preenchido quando a cobrança é original parcelada.
dueDate	string	Data vencimento no formato Y-m-d (ano-mês-dia)
competenceDate	string	Data competência no formato Y-m-d (ano-mês-dia)
paymentDate	string	Data da quitação no formato Y-m-d (ano-mês-dia)
paymentOperationDate	string	Data de operação da quitação Y-m-d (ano-mês-dia)
hasAutomaticSettlement	boolean	Atributo booleano que indica se a quitação foi automática
paymentDiscountAmount	float	Valor do desconto da quitação
notes	string	Observações
taxInvoiceNumber	string	Número da nota fiscal
createdAt	string	Data de emissão no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
receiptCode	string	Código do recibo
billetDigitableLine	string	Linha digitável do boleto
chargeUrl	string	URL da Fatura
billetUrl	string	URL do boleto
company	object	Objeto com informações da Unidade
customer	object	Objeto com informações do Cliente
account	object	Objeto com informações da Conta
sales	array-object	Um array de objetos com informações das Vendas vinculadas a Cobrança

Aviso de cobrança

Dispara eventos quando a data atual atingir X dias de diferença em relação ao vencimento de uma cobrança. Por exemplo, enviar um evento quando atingir 5 dias de atraso.

Para tal, ao criar uma Conexão deste evento, o usuário deve selecionar uma "Regra de Aviso" para vincular à Conexão.

Os avisos de cobrança podem ser qualquer regra pré-cadastrada em Configurações -> E-mails automáticos de cobrança. É ela quem determina com quantos dias de atraso aquele evento deve ser disparado, etc.

CAMPO	TIPO	DESCRIÇÃO
amount	float	Valor da Cobrança
currentAmount	float	Valor atual da Cobrança
dueDate	string	Data de vencimento no formato Y-m-d (ano-mês-dia)
chargeUrl	string	URL da Fatura
billetDigitableLine	string	Linha digitável do boleto
billetUrl	string	URL do boleto
customer	object	Objeto com informações do Cliente
company	object	Objeto com informações da Unidade

Alteração de status

Dispara eventos em qualquer ocasião que mude o status de uma cobrança, exceto a quitação (pois já existe um evento específico para isso).

Ou seja, dispara um evento ao editar o status da cobrança, ao negociá-la, cancelá-la, ou excluí-la.

CAMPO	TIPO	DESCRIÇÃO
chargeId	int	ID da Cobrança
amount	float	Valor da Cobrança
currentAmount	float	Valor atual da Cobrança
discountAmount	float	Valor do desconto concedido no faturamento
dueDate	string	Data de vencimento no formato Y-m-d (ano-mês-dia)
chargeUrl	string	URL da Fatura
billetDigitableLine	string	Linha digitável do boleto
billetUrl	string	URL do boleto
customer	object	Objeto com informações do Cliente
company	object	Objeto com informações da Unidade

Tabela extra - Cliente (customer)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Cliente
name	string	Nome
tradeName	string	Nome fantasia
firstName	string	Apenas o primeiro nome
cellNumber	string	Número do celular
phones	array	Uma lista com todos os telefones
emails	array	Uma lista com todos os e-mails de recado do Cliente
emailsFinancialMessages	array	Uma lista com todos os e-mails de financeiro do Cliente

Tabela extra - Conta (account)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID da Conta
name	string	Nome da Conta

Tabela extra - Venda (sale)

CAMPO	TIPO	DESCRIÇÃO
price	float	Valor da Venda
product	string	Nome do Produto da Venda
quantity	int	Quantidade de produtos da Venda
saleDateTime	string	Data da venda no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Eventos de Despesa

Confirmação de Recebimento

CAMPO	TIPO	DESCRIÇÃO
billId	int	ID da Despesa
amount	float	Valor da Despesa
dueDate	string	Data de vencimento no formato Y-m-d (ano-mês-dia)
status	string	Status da despesa. Pode receber os seguintes valores: unpaid (Aberta) cancelled (Cancelada) paid (Quitada) received (Recebida) excluded (Excluída)
description	string	Descrição
digitableLine	string	Linha digitável
documentNumber	string	Número do documento
documentDate	string	Data do documento no formato Y-m-d (ano-mês-dia)
documentCreatedAt	string	Data de cadastro documento no formato Y-m-d (ano-mês-dia)
company	object	Objeto com informações da Unidade
account	object	Objeto com informações da Conta
supplier	object	Objeto com informações do Fornecedor
subcategory	object	Objeto com informações da subcategoria do pagamento
recurrentBill	object	Objeto com informações do pagamento fixo
createdAt	string	Data de criação da despesa no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Tabela extra - Fornecedor (supplier)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Fornecedor
name	string	Nome do Fornecedor

Tabela extra - Subcategoria de Pagamento (subcategory)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID da Subcategoria
name	string	Nome da Subcategoria

Tabela extra - Pagamento Fixo

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Pagamento Fixo
name	string	Nome do Pagamento Fixo

Eventos de Cliente

Cadastro

Evento disparado ao cadastrar um novo cliente. É disparado também nos cadastros realizados pelo cadastro público e através da contratação online de planos.

CAMPO	TIPO	DESCRIÇÃO
customerId	int	ID do Cliente
name	string	Nome/Razão social
tradeName	string	Nome fantasia
firstName	string	Primeiro nome
isJuridicalPerson	boolean	Atributo booleano que indica se o cliente é Pessoa Jurídica. Caso seja falso, o cliente é considerado Pessoa Física.
isForeign	boolean	Atributo booleano que indica se o cliente é estrangeiro
cpf	string	CPF (Só é preenchido caso o cliente seja Pessoa Física)
cnpj	string	CNPJ (Só é preenchido caso o cliente seja Pessoa Jurídica)
rg	string	RG (Só é preenchido caso o cliente seja Pessoa Física)
profession	string	Profissão
birthDate	string	Data de nascimento no formato Y-m-d (ano-mês-dia). Só é preenchido caso o cliente seja Pessoa Física
fundationDate	string	Data de fundação no formato Y-m-d (ano-mês-dia). Só é preenchido caso o cliente seja Pessoa Jurídica
emails	array	Lista de e-mails para envio de recado
emailsFinancialMessages	array	Lista de e-mails para envio de avisos financeiros
cellNumber	string	Número do telefone celular
phones	array	Lista de números telefônicos
company	object	Objeto com informações da Unidade
website	string	Site
notes	string	Observações
fieldOfActivity	string	Ramo de atividade
cratedAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Edição

CAMPO	TIPO	DESCRIÇÃO
customerId	int	ID do Cliente
name	string	Nome/Razão social
tradeName	string	Nome fantasia
firstName	string	Primeiro nome
isJuridicalPerson	boolean	Atributo booleano que indica se o cliente é Pessoa Jurídica. Caso seja falso, o cliente é considerado Pessoa Física.
isForeign	boolean	Atributo booleano que indica se o cliente é estrangeiro
cpf	string	CPF (Só é preenchido caso o cliente seja Pessoa Física)
cnpj	string	CNPJ (Só é preenchido caso o cliente seja Pessoa Jurídica)
rg	string	RG (Só é preenchido caso o cliente seja Pessoa Física)
profession	string	Profissão
birthDate	string	Data de nascimento no formato Y-m-d (ano-mês-dia). Só é preenchido caso o cliente seja Pessoa Física
fundationDate	string	Data de fundação no formato Y-m-d (ano-mês-dia). Só é preenchido caso o cliente seja Pessoa Jurídica
emails	array	Lista de e-mails para envio de recado
emailsFinancialMessages	array	Lista de e-mails para envio de avisos financeiros
cellNumber	string	Número do telefone celular
phones	array	Lista de números telefônicos
company	object	Objeto com informações da Unidade
website	string	Site do cliente
isActive	boolean	Atributo booleano que indica se o cliente está desativado
notes	string	Observações
fieldOfActivity	string	Ramo de atividade
cratedAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Exclusão

Ao excluir um cliente, o evento será disparado.

CAMPO	TIPO	DESCRIÇÃO
customerId	int	ID do Cliente
name	string	Nome/Razão social
tradeName	string	Nome fantasia
firstName	string	Primeiro nome
company	object	Objeto com informações da Unidade

Bloqueio

Quando um cliente for bloqueado, o evento será disparado.

CAMPO	TIPO	DESCRIÇÃO
customerId	int	ID do Cliente
name	string	Nome/Razão social
tradeName	string	Nome fantasia
firstName	string	Primeiro nome
company	object	Objeto com informações da Unidade

Desbloqueio

Quando um cliente for desbloqueado, o evento será disparado.

CAMPO	TIPO	DESCRIÇÃO
customerId	int	ID do Cliente
name	string	Nome/Razão social
tradeName	string	Nome fantasia
firstName	string	Primeiro nome
company	object	Objeto com informações da Unidade

Eventos de Reserva

Cadastro

Evento disparado sempre que uma reserva avulsa for criada.

CAMPO	TIPO	DESCRIÇÃO
bookingId	int	ID da Reserva
sale	object	Objeto com informações da venda da Reserva
type	string	Tipo da Reserva. Pode ser: coworking ou room (sala)
place	object	Objeto com informações do local da Reserva
customer	object	Objeto com informações do cliente da Reserva
person	object	Objeto com informações da pessoa da Reserva
notes	string	Observações
isOnlinePayment	boolean	Atributo booleano que indica se houve pagamento online para a Reserva
isBilled	boolean	Atributo booleano que indica se a Reserva já foi faturada
startTime	string	Data e hora do início da reserva no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
finalTime	string	Data e hora do final da reserva no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Cancelamento

Esse evento é disparado quando uma reserva é cancelada

CAMPO	TIPO	DESCRIÇÃO
bookingId	int	ID da Reserva
sale	object	Objeto com informações da venda da Reserva
type	string	Tipo da Reserva. Pode ser: coworking ou room (sala)
place	object	Objeto com informações do local da Reserva
customer	object	Objeto com informações do cliente da Reserva
person	object	Objeto com informações da Pessoa da Reserva
notes	string	Observações
isOnlinePayment	boolean	Atributo booleano que indica se houve pagamento online para a Reserva
cancellationReason	string	Motivo do cancelamento
startTime	string	Data e hora do início da reserva no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
finalTime	string	Data e hora do final da reserva no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Eventos de Pessoa

Cadastro

Evento disparado sempre que uma pessoa é cadastrada.

CAMPO	TIPO	DESCRIÇÃO
personId	int	ID da Pessoa
name	string	Nome
customer	object	Objeto com informações do cliente da Pessoa
company	object	Objeto com informações da Unidade
isForeign	boolean	Atributo booleano que indica se a pessoa é estrangeira
foreignData	object	Objeto com os dados estrangeiros da Pessoa
cpf	string	CPF
rg	string	RG
maritalStatus	string	Estado civil da Pessoa. Possíveis valores: single (solteiro) married (casado) divorced (divorciado) widowed (viúvo) not informed (não informado)
profession	string	Profissão
birthDate	string	Data de nascimento no formato Y-m-d (ano-mês-dia)
emails	array	Lista de e-mails
cellPhone	string	Número do telefone celular
phones	array	Lista de números telefônicos
notes	string	Observações
briefResume	string	Breve currículo

Edição

Evento disparado sempre que uma pessoa é editada.

CAMPO	TIPO	DESCRIÇÃO
personId	int	ID da Pessoa
name	string	Nome
customer	object	Objeto com informações do cliente da Pessoa
company	object	Objeto com informações da Unidade
isForeign	boolean	Atributo booleano que indica se a pessoa é estrangeira
foreignData	object	Objeto com os dados estrangeiros da Pessoa
cpf	string	CPF
rg	string	RG
maritalStatus	string	Estado civil da Pessoa. Possíveis valores: single (solteiro) married (casado) divorced (divorciado) widowed (viúvo) not informed (não informado)
profession	string	Profissão
birthDate	string	Data de nascimento no formato Y-m-d (ano-mês-dia)
emails	array	Lista de e-mails
cellPhone	string	Número do telefone celular
phones	array	Lista de números telefônicos
notes	string	Observações
briefResume	string	Breve currículo
isActive	boolean	Atributo booleano que indica se a Pessoa está ativa

Exclusão

Evento disparado sempre que uma pessoa é excluída.

CAMPO	TIPO	DESCRIÇÃO
personId	int	ID da Pessoa
name	string	Nome
customer	object	Objeto com informações do cliente da Pessoa
company	object	Objeto com informações da unidade vinculada ao Cliente

Bloqueio

Evento disparado sempre que uma pessoa é desativada.

CAMPO	TIPO	DESCRIÇÃO
personId	int	ID da Pessoa
name	string	Nome
customer	object	Objeto com informações do cliente da Pessoa
company	object	Objeto com informações da unidade vinculada ao Cliente

Desbloqueio

Evento disparado sempre que uma pessoa é reativada.

CAMPO	TIPO	DESCRIÇÃO
personId	int	ID da Pessoa
name	string	Nome
customer	object	Objeto com informações do cliente da Pessoa
company	object	Objeto com informações da unidade vinculada ao Cliente

Eventos de Reserva Recorrente

Cadastro

Evento disparado sempre que uma reserva recorrente é criada. Aqui vale lembrar que o evento só será disparado para a reserva recorrente e não para as reservas criadas a partir de uma reserva recorrente.

CAMPO	TIPO	DESCRIÇÃO
recurringBookingId	int	ID da Reserva Recorrente
contract	object	Objeto com informações do Contrato
customer	object	Objeto com informações do Cliente da Reserva
place	object	Objeto com informações do local da Reserva
company	object	Objeto com informações da Unidade
person	object	Objeto com informações da Pessoa da Reserva
registeredBy	string	Nome do usuário que cadastrou a Reserva Recorrente
repeatType	string	Tipo de repetição da Reserva. Pode ser: Weekly (Semanal) Monthly (Mensal)
daysWeek	array	Lista com os dias (em inglês) da semana da Reserva
firstOccurrence	string	Data da primeira ocorrência da reserva no formato Y-m-d (ano-mês-dia)
lastOccurrence	string	Data da última ocorrência da reserva no formato Y-m-d (ano-mês-dia)
startTime	string	Hora do início da Reserva
finalTime	string	Hora do final da Reserva
timeZone	string	Time zone da Unidade da Reserva no formato GMT
occurrenceAmount	int	Quantidade de ocorrências da Reserva
generatedQuantity	int	Quantidade de reservas geradas
resume	string	Um breve resumo com informações da Reserva
isCharged	boolean	Atributo booleano que indica se a Reserva será cobrada
notes	string	Observações da Reserva
createdAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Eventos de Atendimento

Cadastro

Evento disparado sempre que um atendimento (para um cliente não bloqueado) é cadastrado.

CAMPO	TIPO	DESCRIÇÃO
customerServiceId	int	ID do Atendimento
type	string	Tipo do Atendimento. Pode ser: Phone Call (Telefonema) Face-to-face Visit (Visita Presencial)
customer	object	Objeto com informações do Cliente
requester	object	Objeto com informações do Solicitante
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do Usuário que cadastrou o Atendimento
messageText	string	Mensagem cadastrada no Atendimento
createdAt	string	Data de criação do atendimento no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Cadastro (Cliente Bloqueado)

A única diferença é que nesse caso o cliente está bloqueado, mas as informações enviadas são as mesmas.

CAMPO	TIPO	DESCRIÇÃO
customerServiceId	int	ID do Atendimento
type	string	Tipo do Atendimento. Pode ser: Phone Call (Telefonema) Face-to-face Visit (Visita Presencial)
customer	object	Objeto com informações do Cliente
requester	object	Objeto com informações do Solicitante
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do Usuário que cadastrou o Atendimento
messageText	string	Mensagem cadastrada no Atendimento
createdAt	string	Data de criação do atendimento no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Exclusão

Evento disparado sempre que um atendimento é excluído.

CAMPO	TIPO	DESCRIÇÃO
customerServiceId	int	ID do Atendimento
type	string	Tipo do Atendimento. Pode ser: Phone Call (Telefonema) Face-to-face Visit (Visita Presencial)
customer	object	Objeto com informações do Cliente
requester	object	Objeto com informações do Solicitante
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do Usuário que cadastrou o Atendimento

Eventos de Correspondência

Cadastro

Evento disparado sempre que uma correspondência (para um cliente não bloqueado) é criada.

CAMPO	TIPO	DESCRIÇÃO
correspondenceId	int	ID da Correspondência
sender	string	Nome do remetente
trackingCode	string	Código de rastreio
receiptDate	string	Data de recebimento no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
customer	object	Objeto com informações do Cliente
messageText	string	Mensagem cadastrada na Correspondência
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do Usuário que cadastrou a Correspondência
createdAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Cadastro (Cliente Bloqueado)

Evento disparado sempre que uma correspondência (para um cliente bloqueado) é criada.

CAMPO	TIPO	DESCRIÇÃO
correspondenceId	int	ID da Correspondência
sender	string	Nome do remetente
trackingCode	string	Código de rastreio
receiptDate	string	Data de recebimento no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
customer	object	Objeto com informações do Cliente
messageText	string	Mensagem cadastrada na Correspondência
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do Usuário que cadastrou a Correspondência
createdAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Exclusão

Evento disparado sempre que uma correspondência é excluída.

CAMPO	TIPO	DESCRIÇÃO
correspondenceId	int	ID da Correspondência
sender	string	Nome do remetente
customer	object	Objeto com informações do Cliente
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do Usuário que cadastrou a Correspondência

Entrega Presencial

Evento disparado quando uma correspondência é entregue presencialmente.

CAMPO	TIPO	DESCRIÇÃO
correspondenceId	int	ID da Correspondência
sender	string	Nome do remetente
trackingCode	string	Código de rastreio
deliveryBy	object	Objeto com informações de quem entregou a Correspondência
deliveredToPerson	object	Objeto com informações de quem recebeu a Correspondência
receiptDate	string	Data de recebimento no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
notes	string	Observações da entrega
customer	object	Objeto com informações do Cliente
messageText	string	Mensagem cadastrada na Correspondência
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do Usuário que cadastrou a Correspondência
createdAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Enviada por E-mail

Evento disparado quando uma correspondência é enviada por e-mail.

CAMPO	TIPO	DESCRIÇÃO
correspondenceId	int	ID da Correspondência
sender	string	Nome do remetente
trackingCode	string	Código de rastreio
deliveryBy	object	Objeto com informações de quem entregou a Correspondência
deliveryInformationByEmail	object	Objeto com informações da entrega por e-mail, como destinatários etc
receiptDate	string	Data de recebimento no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
notes	string	Observações da entrega
customer	object	Objeto com informações do Cliente
messageText	string	Mensagem cadastrada na Correspondência
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do Usuário que cadastrou a Correspondência
createdAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Encaminhado para o Endereço

Evento disparado quando uma correspondência é encaminhada para o endereço do cliente.

CAMPO	TIPO	DESCRIÇÃO
correspondenceId	int	ID da Correspondência
sender	string	Nome do remetente
trackingCode	string	Código de rastreio
deliveryBy	object	Objeto com informações de quem entregou a Correspondência
deliveredToPerson	object	Objeto com informações de quem recebeu a Correspondência
shippingMetod	string	Forma de envio da entrega. Pode ser: Motorcycle Courier (Motoboy) Sedex PAC Mail (Carta) Other (Outras)
receiptDate	string	Data de recebimento no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
deliveryDate	string	Data da entrega no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)
customer	object	Objeto com informações do Cliente
messageText	string	Mensagem cadastrada na Correspondência
company	object	Objeto com informações da Unidade
user	object	Objeto com informações do usuário que cadastrou a Correspondência
createdAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Tabela extra - Entregue por (deliveryBy)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Usuário que realizou a entrega
name	string	Nome do Usuário que realizou a entrega

Tabela extra - Entregue para (delivertoPerson)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID da Pessoa que recebeu
name	string	Nome da pessoa que recebeu

Tabela extra - Informações da Entrega por E-mail (deliveryInformationByEmail)

CAMPO	TIPO	DESCRIÇÃO
recipients	array	Lista de destinatários
date	string	Data do envio no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Eventos de CRM (Cliente Potencial)

Cadastro

Evento disparado quando um cliente potencial é cadastrado.

CAMPO	TIPO	DESCRIÇÃO
potentialCustomerId	int	ID do Cliente Potencial
company	object	Objeto com informações da Unidade
status	string	Status da negociação. Pode ser: Under Negotiation (Em negociação) Quitter (Desistente) Agreed (Contratado) Interested (Interessado) Rules E-mail Sent (E-mail regras enviado) Won (Ganho)
partner	object	Objeto com informações do Parceiro
customerName	string	Nome do Cliente
phones	array	Lista de telefones do Cliente
interestServices	array-object	Lista de objetos com informações sobre os serviços de interesse
fieldOfActivity	array-object	Lista de objetos com informações sobre os Ramos de Atividade
emails	array	Lista de e-mails do Cliente
isReceiveInformativeEmail	boolean	Atributo booleano que indica se o Cliente aceita receber e-mails informativos
contactMethod	array-object	Lista de objetos com informações sobre as formas de contato
website	string	Site do Cliente
notes	string	Observações
createdAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Edição

Evento disparado quando um cliente potencial é editado.

CAMPO	TIPO	DESCRIÇÃO
potentialCustomerId	int	ID do Cliente Potencial
company	object	Objeto com informações da Unidade
status	string	Status da negociação. Pode ser: Under Negotiation (Em Negociação) Quitter (Desistente) Agreed (Contratado) Interested (Interessado) Rules E-mail Sent (E-mail regras enviado) Won (Ganho)
partner	object	Objeto com informações do Parceiro
customerName	string	Nome do Cliente
phones	array	Lista de telefones do Cliente
interestServices	array-object	Lista de objetos com informações sobre os serviços de interesse
fieldOfActivity	array-object	Lista de objetos com informações sobre os Ramos de Atividade
emails	array	Lista de e-mails do Cliente
isReceiveInformativeEmail	boolean	Atributo booleano que indica se o cliente aceita receber e-mails informativos
contactMethod	array-object	Lista de objetos com informações sobre as formas de contato
website	string	Site do Cliente
notes	string	Observações
createdAt	string	Data de criação no formato ISO 8601: Y-m-d\TH:i:sP (ano-mês-dia + Timezone + hora:minuto:segundo + GMT)

Exclusão

Evento disparado quando um cliente potencial é excluído.

CAMPO	TIPO	DESCRIÇÃO
potentialCustomerId	int	ID do Cliente Potencial
company	object	Objeto com informações da Unidade
customerName	string	Nome do Cliente

Tabela extra - Parceiro (partner)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Parceiro
name	string	Nome do Parceiro

Tabela extra - Ramo de Atividade (fieldOfActivity)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Ramo de Atividade
name	string	Nome do Ramo de Atividade

Tabela extra - Forma de Contato (contactMethod)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID da Forma de Contato
name	string	Nome da Forma de Contato

Tabela extra - Serviços de Interesse (interestServices)

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Serviço de Interesse
name	string	Nome do Serviço de Interesse

Anexo (tabelas extras)

Unidade

CAMPO	TIPO	DESCRIÇÃO
id	int	ID da Unidade
name	string	Nome da Unidade

Cliente

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Cliente
name	string	Razão social ou nome do Cliente
tradeName	string	Nome fantasia do Cliente
firstName	string	Apenas o primeiro nome
cellNumber	string	Número do celular
phones	array	Uma lista com todos os telefones
emails	array	Uma lista com todos os e-mails de recado do Cliente
emailsFinancialMessages	array	Uma lista com todos os e-mails de financeiro do Cliente

Local da Reserva

CAMPO	TIPO	DESCRIÇÃO
id	int	ID da Local
name	string	Nome do Local

Pessoa

CAMPO	TIPO	DESCRIÇÃO
id	int	ID da Pessoa
name	string	Nome da Pessoa

Venda

CAMPO	TIPO	DESCRIÇÃO
id	int	ID da Venda
value	float	Valor da Venda
saller	string	Nome do vendedor

Contrato

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Contrato
namePlan	string	Nome do Plano do Contrato

Dados Estrangeiros de Pessoa

CAMPO	TIPO	DESCRIÇÃO
id	int	ID dos Dados Estrangeiros
document	string	Número de algum documento. Ex: Passaporte
country	string	País da Pessoa
city	string	Cidade da Pessoa
state	string	Estado da Pessoa
street	string	Rua da Pessoa
number	string	Número de endereço da Pessoa
additionalDetails	string	Complemento do endereço da Pessoa
neighborhood	string	Bairro da Pessoa
zipcode	string	CEP ou código postal do endereço da Pessoa

Solicitante

CAMPO	TIPO	DESCRIÇÃO
name	string	Nome do Solicitante
phones	array	Lista de telefones do Solicitante
email	string	E-mail do Solicitante
company	string	Nome da empresa do Solicitante

Usuário

CAMPO	TIPO	DESCRIÇÃO
id	int	ID do Usuário
name	string	Nome do Usuário