Exemplos de Payload
Para ajudar na implementação dos Webhooks em seu sistema, fornecemos exemplos reais de payloads para cada tipo de evento suportado.
Importante
Eventos de atualização (*_updated), nem sempre todos os campos serão enviados no payload. Apenas os campos que foram alterados serão incluídos. Para consultar a lista completa de campos disponíveis para cada área, acesse a documentação específica:
Estrutura Base
json
{
"id_event": 0,
"event": "nome_do_evento",
"dateCreated": "2024-12-18 13:49:33",
"data": []
}Clientes
Cliente Cadastrado
json
{
"id_event": 83912,
"event": "customer_created",
"dateCreated": "2024-12-18 13:55:00",
"data": [
{
"id": "4094",
"nome": "João da Silva",
"email": "joao.silva@email.com",
"email2": "",
"rg": "MG-12.345.678",
"cpf": "123.456.789-00",
"cep": "30130-110",
"endereco": "Rua dos Tupis",
"numero": "187",
"complemento": "Sala 504",
"bairro": "Centro",
"cidade": "Belo Horizonte",
"estado": "MG",
"telefone": "3132225555",
"telefone2": "",
"celular": "31999885544",
"responsavel": "Maria Silva",
"datadenascimento": "15/05/1985",
"anotacoes": "Cliente VIP - Eventos corporativos",
"datadecadastro": "18/12/24",
"dditelefone": "55",
"dditelefone2": "",
"ddicelular": "55",
"pais": "Brasil",
"tipocadastro": "1",
"redesocial": "@joaosilva",
"profissao": "Empresário",
"estadocivil": "Casado",
"nacionalidade": "Brasileiro",
"orgaoexpeditor": "SSP",
"datadeexpedicao": "10/01/2015",
"pontoreferencia": "Próximo ao Mercado Central",
"razaosocial": "João da Silva Eventos LTDA",
"nomefantasia": "JS Eventos",
"cnpjpj": "12.345.678/0001-90",
"municipal": "123456",
"estadual": "987654321",
"ceppj": "30130-110",
"enderecopj": "Rua dos Tupis",
"numeropj": "187",
"complementopj": "Sala 504",
"bairropj": "Centro",
"cidadepj": "Belo Horizonte",
"estadopj": "MG",
"paispj": "Brasil",
"pontoreferenciapj": "Próximo ao Mercado Central"
}
]
}Cliente Atualizado
json
{
"id_event": 83913,
"event": "customer_updated",
"dateCreated": "2024-12-18 13:56:00",
"data": [
{
"id": "4094",
"nome": "João da Silva",
"email": "joao.silva@email.com",
"email2": "",
"rg": "MG-12.345.678",
"cpf": "123.456.789-00",
"cep": "30130-110",
"endereco": "Rua dos Tupis",
"numero": "187",
"complemento": "Sala 504",
"bairro": "Centro",
"cidade": "Belo Horizonte",
"estado": "MG",
"telefone": "3132225555",
"telefone2": "",
"celular": "31999885544",
"responsavel": "Maria Silva",
"datadenascimento": "15/05/1985",
"anotacoes": "Cliente VIP - Eventos corporativos",
"datadecadastro": "18/12/24",
"dditelefone": "55",
"dditelefone2": "",
"ddicelular": "55",
"pais": "Brasil",
"tipocadastro": "1",
"redesocial": "@joaosilva",
"profissao": "Empresário",
"estadocivil": "Casado",
"nacionalidade": "Brasileiro",
"orgaoexpeditor": "SSP",
"datadeexpedicao": "10/01/2015",
"pontoreferencia": "Próximo ao Mercado Central",
"razaosocial": "João da Silva Eventos LTDA",
"nomefantasia": "JS Eventos",
"cnpjpj": "12.345.678/0001-90",
"municipal": "123456",
"estadual": "987654321",
"ceppj": "30130-110",
"enderecopj": "Rua dos Tupis",
"numeropj": "187",
"complementopj": "Sala 504",
"bairropj": "Centro",
"cidadepj": "Belo Horizonte",
"estadopj": "MG",
"paispj": "Brasil",
"pontoreferenciapj": "Próximo ao Mercado Central"
}
]
}Cliente Deletado
json
{
"id_event": 83914,
"event": "customer_deleted",
"dateCreated": "2024-12-18 13:57:00",
"data": [
{
"id": "4094"
}
]
}Eventos
Evento Criado
json
{
"id_event": 83913,
"event": "event_created",
"dateCreated": "2024-12-18 13:58:08",
"data": [
{
"id": "1725",
"idcliente": "330",
"tipoevento": "35",
"nomeevento": "Workshop de Marketing Digital",
"idvendedor": "61",
"dataevento": "2024-12-19",
"horaevento": "09:00",
"horaeventofim": "18:00",
"observacao": "Coffee break incluído",
"idlocalevento": "12",
"cep": "30130-110",
"endereco": "Avenida Afonso Pena",
"numero": "1500",
"complemento": "Auditório Principal",
"bairro": "Centro",
"cidade": "Belo Horizonte",
"estado": "MG",
"pais": "Brasil",
"idlocalcerimonia": "12",
"cerimonia": "Palestra de Abertura",
"localcerimonia": "Auditório Principal",
"valor": "5000.00",
"comoconheceu": "6",
"datadecadastro": "2024-12-18",
"informacoes": "Workshop para 50 participantes com material incluso",
"nconvidados": "50"
}
]
}Evento Atualizado
json
{
"id_event": 83914,
"event": "event_updated",
"dateCreated": "2024-12-18 13:58:30",
"data": [
{
"id": "1725",
"nomeevento": "Workshop de Marketing Digital e Vendas",
"horaevento": "10:00",
"horaeventofim": "19:00",
"observacao": "Coffee break e almoço incluídos",
"valor": "5500.00",
"informacoes": "Workshop para 60 participantes com material incluso",
"nconvidados": "60"
}
]
}Evento Cancelado
json
{
"id_event": 83918,
"event": "event_canceled",
"dateCreated": "2024-12-18 13:57:00",
"data": [
{
"id": "34567"
}
]
}Orçamentos
Orçamento Criado
json
{
"id_event": 83919,
"event": "quote_created",
"dateCreated": "2024-12-18 14:03:05",
"data": [
{
"id": "2370",
"chave": "cbffe835972a0eef3888ecbf0deba030202412181402000000",
"email": "cliente@email.com",
"emailcopia": "vendedor@empresa.com",
"idcliente": "4094",
"idparceiro": 0,
"nome": "Workshop Empresarial",
"telefone": "3132225555",
"celular": "31999885544",
"comoconheceu": "6",
"tipoevento": "35",
"dataevento": "2024-12-19",
"assunto": "Orçamento Workshop",
"mensagem": "Solicitação de orçamento para workshop empresarial",
"idvendedor": "61",
"datacadastro": "2024-12-18",
"dataretorno": "2024-12-20",
"status": "Em aberto",
"valorinicial": "5000.00",
"statusvenda": "Tarefa",
"horaevento": "09:00",
"horafimevento": "18:00"
}
]
}Orçamento Atualizado
json
{
"id_event": 83920,
"event": "quote_updated",
"dateCreated": "2024-12-18 14:02:05",
"data": [
{
"id": "2370",
"nome": "Workshop Empresarial Atualizado",
"valorinicial": "5500.00",
"dataevento": "2024-12-20",
"status": "Em andamento",
"horaevento": "10:00",
"horafimevento": "19:00"
}
]
}Orçamento Aprovado
json
{
"id_event": 83953,
"event": "quote_approved",
"dateCreated": "2024-12-18 14:03:41",
"data": [
{
"id": "2370",
"status": "Finalizados",
"dataretorno": "2024-12-18"
}
]
}Orçamento Cancelado
json
{
"id_event": 83917,
"event": "quote_canceled",
"dateCreated": "2024-12-18 13:59:06",
"data": [
{
"id": "2368",
"status": "Finalizados",
"idmotivo": "10"
}
]
}Follow-up Criado
json
{
"id_event": 83916,
"event": "followup_created",
"dateCreated": "2024-12-18 13:59:05",
"data": [
{
"id": "6080",
"datacadastro": "2024-12-18 13:59:05",
"idorcamento": "2368",
"mensagem": "ORÇAMENTO FINALIZADO POR: (61) Thalles Brandão",
"idusuario": "61"
}
]
}Financeiro
Lançamento Criado
json
{
"id_event": 83956,
"event": "transaction_created",
"dateCreated": "2024-12-18 14:04:49",
"data": [
{
"id": "4751",
"datapagamento": "2024-12-18",
"datacompetencia": "2024-12-18",
"tipocobranca": 1,
"recebidode": "1",
"informede": 0,
"descricao": "Pagamento Workshop Empresarial",
"idevento": "1725",
"valor": "5000.00",
"juros": "0.00",
"multa": "0.00",
"desconto": "0.00",
"pago": "nao",
"idconta": "1",
"idcategoria": "8",
"marcadores": "",
"idcentrodecusto": "12",
"numerodocumento": "2024/001",
"mododepagamento": "85",
"numeroparcela": 1,
"vinculoparcela": "",
"iduser": "61",
"idpedido": "0",
"tags": "workshop,empresarial",
"datahoracadastro": "2024-12-18 14:04:49",
"data_faturamento": "//"
}
]
}Lançamento Atualizado
json
{
"id_event": 83957,
"event": "transaction_updated",
"dateCreated": "2024-12-18 14:05:49",
"data": [
{
"id": "4751",
"datapagamento": "2024-12-18",
"datacompetencia": "2024-12-18",
"valor": "5500.00",
"descricao": "Pagamento Workshop Empresarial - Alterado",
"pago": "sim",
"mododepagamento": "85",
"tags": "workshop,empresarial,alterado"
}
]
}Lançamento Deletado
json
{
"id_event": 83958,
"event": "transaction_deleted",
"dateCreated": "2024-12-18 14:06:49",
"data": [
{
"id": "4751"
}
]
}Notas Importantes
Estrutura do Payload:
id_event: Identificador único do eventoevent: Nome do eventodateCreated: Data e hora de criação do eventodata: Array contendo os dados do evento
Formatos de Dados:
- Datas são enviadas no formato "YYYY-MM-DD" ou "YYYY-MM-DD HH:mm:ss"
- Valores monetários são enviados como strings
- IDs são sempre enviados como strings
- Campos vazios podem vir como string vazia ("") ou zero (0)
Campos Específicos:
- Alguns eventos podem conter campos HTML codificados
- Campos de status e tipos geralmente usam códigos numéricos
- Campos booleanos geralmente são representados como "sim"/"nao"
- Em eventos de atualização, apenas os campos alterados são enviados
Recomendações de Implementação:
- Implemente tratamento para campos vazios ou nulos
- Considere a possibilidade de novos campos serem adicionados
- Mantenha log de todos os eventos recebidos
- Implemente validação dos dados recebidos
- Em eventos de atualização, atualize apenas os campos recebidos no payload