Webhooks

Criação do lead

O Webhook de criação do lead dispara um evento quando um novo lead é recebido em nosso sistema.

Neste evento ela envia uma requisição do tipo POST, contendo um JSON com as informações do lead.

Exemplo

{
    "id": 1415171,
    "status": "pending",
    "perception": null,
    "conversion_goal": "Ponto de conversão",
    "finished": false,
    "message": "Mensagem do lead.",
    "created_at": "2018-06-05T14:51:28-03:00",
    "last_interaction_at": "2018-06-05T14:52:30-03:00",
    "team": {
        "name": "Comercial"
    },
    "attendant": {
        "name": "Atendente 3",
        "id_number": "12345678901"
    },
    "salesman": null
    "contact": {
        "id": 1331918,
        "name": "José da Silva",
        "email": "jose.silva@email.com",
        "phone": "(11) 1234-1234",
        "cellphone": "(11) 91234-1234",
        "whatsapp": "(11) 91234-1234",
        "id_number": "123.456.789-10",
        "address": {
            "address_line1": "Rua Teste, 52",
            "address_line2": "Apartamento 2",
            "neighborhood": "Jardim Teste",
            "city": "Itu",
            "state": "SP",
            "country": "Brasil",
            "zipcode": "13300-013"
        },
        "company": {
            "name": "Empresa Teste",
            "phone": "(11) 1234-1234",
            "email": "empresa@teste.com",
            "website": "www.teste.com",
            "job_title": "Gerente de Marketing",
            "id_number": "03.719.411/0001-20",
        }
    },
    "interests": {
        "category": "Seminovos",
        "brand": "Toyota",
        "product": "Corolla",
        "location": "Londrina"
    },
    "tracking": {
        "source": "Nome da origem",
        "medium": "Nome da mídia",
        "campaign": "Nome da campanha",
        "format": "Nome do formato"
    }
}

Parâmetros

Campo	Tipo	Descrição
id	number	Id do lead.
status	enum	Status do lead. Valores possíveis: pending, treatment, scheduled, proposal_sent, sale_performed, sale_not_performed, waiting_billing.
perception	enum	Percepção do lead. Valores possíveis: cold, warm, hot
conversion_goal	string	Ponto de conversão.
finished	boolean	Se o lead foi finalizado ou não.
message	string	Mensagem do lead.
created_at	string	Data de criação do lead.
last_interaction_at	string	Data da última atualização do lead.
team	Object	Informações da equipe do lead.
attendant	Object	Informações do atendente do lead.
salesman	Object	Informações do vendedor.
contact	Object	Informações de contato do lead.
interest	Object	Dados de interesse do lead.
tracking	Object	Informações de rastreio do lead.

Team

Campo	Tipo	Descrição
name	string	Nome da equipe.

Attendant

Campo	Tipo	Descrição
name	string	Nome do atendente.
id_number	string	CPF do atendente.

Salesman

Campo	Tipo	Descrição
name	string	Nome do vendedor.

<

Contact

Campo	Tipo	Descrição
id	number	Id do contato.
name	string	Nome do contato.
email	string	E-mail do contato.
phone	string	Telefone do contato.
cellphone	string	Celular do contato.
whatsapp	string	Número de WhatsApp do contato.
id_number	string	Número do CPF cadastrado
address	Object	Endereço do contato.
company	Object	Informações sobrea a empresa do contato.

Address

Campo	Tipo	Descrição
address_line1	string	Endereço linha 1.
address_line2	string	Endereço linha 2.
neighborhood	string	Bairro.
city	string	Cidade
state	string	Estado
country	string	País
zipcode	string	CEP

Company

Campo	Tipo	Descrição
name	string	Nome da empresa.
phone	string	Telefone da empresa.
email	string	Email da empresa.
website	string	Site da empresa.
job_title	string	Descrição do cargo do contato na empresa.
id_number	string	CNPJ da empresa

Interests

Campo	Tipo	Descrição
category	string	Categoria do lead.
brand	string	Marca do produto
product	string	Nome do produto
location	string	Unidade que gerou o lead.

Tracking

Campo	Tipo	Descrição
source	string	Nome da origem.
medium	string	nome da mídia.
campaign	string	Nome da campanha.
format	string	Nome do formato.