Integração de Leads via Webhook

O CRM Inforce permite receber leads automaticamente de sites, landing pages, formulários, portais imobiliários e sistemas externos por meio de Webhook (API HTTP).

A integração utiliza o método POST, com dados em formato JSON, permitindo enviar informações de contato, imóvel de interesse, origem, campanhas de marketing e campos personalizados.

Endpoint de exemplo:

1https://hook.inforce.api.br/api/{cliente}/leads-webhook/{token}

[!IMPORTANT]A URL de integração é exclusiva para cada cliente e deve ser fornecida pela equipe Inforce. Utilize sempre o endpoint recebido para sua integração e mantenha o token protegido.

1{
2  "nome": "João da Silva",
3  "email": "joao@exemplo.com.br",
4  "telefoneCelular": "+5511999999999",
5  "mensagem": "Gostaria de agendar uma visita ao imóvel.",
6  "origem": "site",
7  "origemUrl": "https://www.exemplo.com.br/imovel/AP1100",
8  "transacaoTipo": "venda",
9  "produto": "AP1100",
10  "filial": "matriz",
11  "utm": "utm_source=google&utm_medium=cpc&utm_campaign=imoveis",
12  "gclid": "EXEMPLO_GCLID",
13  "fbclid": "EXEMPLO_FBCLID",
14  "customFields": {
15    "Possibilidade de Financiamento": "Sim",
16    "Turno de Preferência": "Manhã",
17    "FGTS": "Sim"
18  }
19}

Os campos opcionais podem ser omitidos quando não houver informações disponíveis.

• Os nomes dos campos diferenciam maiúsculas e minúsculas (case-sensitive).
• É necessário informar pelo menos email ou telefoneCelular.
• O telefone deve ser enviado preferencialmente no padrão internacional, incluindo +55 para o Brasil.
• Caso origem não seja informada ou não seja reconhecida, será utilizada a origem padrão configurada na integração.
• O campo produto pode identificar um imóvel específico ou lançamento imobiliário.
• Utilize os identificadores de filial e origem reconhecidos pela configuração do cliente.
• Envie somente os campos opcionais que possuírem valores válidos.

O CRM Inforce permite identificar a procedência dos leads e preservar informações de campanhas de marketing.

O campo origem aceita preferencialmente o slug cadastrado no CRM.

Exemplos:

Origens específicas de parceiros e integrações também podem ser utilizadas, desde que estejam cadastradas no CRM.

O campo utm recebe os parâmetros de campanha em uma única string:

1utm_source=google&utm_medium=cpc&utm_campaign=campanha_inforce&utm_term=apartamento_3_quartos&utm_content=anuncio_a&utm_id=cmp_01

Identificadores adicionais podem ser enviados separadamente:

• gclid: identificador do clique no Google Ads.
• fbclid: identificador do clique no Facebook/Meta.

[!TIP]Recomendamos capturar os parâmetros de campanha da URL de entrada e preservá-los até o envio do formulário, permitindo identificar melhor a origem das oportunidades.

O campo customFields permite incluir informações adicionais relevantes para o atendimento comercial, sem alterar a estrutura principal da integração.

Exemplo:

1{
2  "customFields": {
3    "Possibilidade de Financiamento": "Sim",
4    "Turno de Preferência": "Manhã",
5    "FGTS": "Sim",
6    "Valor de Entrada": "50000",
7    "Prazo de Compra": "Até 90 dias"
8  }
9}

Cada propriedade representa o nome da informação, acompanhado de seu respectivo valor.

Pode ser utilizado para simulações de financiamento, preferências do cliente, respostas de formulários e outras informações comerciais.

Substitua {cliente} e {token} pelos dados da integração fornecidos pela Inforce.

1curl --request POST \
2  --url 'https://hook.inforce.api.br/api/{cliente}/leads-webhook/{token}' \
3  --header 'Content-Type: application/json' \
4  --data '{
5    "nome": "João da Silva",
6    "email": "joao@exemplo.com.br",
7    "telefoneCelular": "+5511999999999",
8    "mensagem": "Gostaria de receber informações sobre o imóvel.",
9    "origem": "site",
10    "origemUrl": "https://www.exemplo.com.br/imovel/AP1100",
11    "transacaoTipo": "venda",
12    "produto": "AP1100",
13    "utm": "utm_source=google&utm_medium=cpc&utm_campaign=imoveis",
14    "customFields": {
15      "Possibilidade de Financiamento": "Sim",
16      "Turno de Preferência": "Manhã"
17    }
18  }'

1. Validação: verifique os dados obrigatórios antes do envio.
2. Segurança: mantenha a URL exclusiva protegida e evite expor o token em código público.
3. Rastreamento: envie a origem, URL da página e parâmetros de campanhas sempre que disponíveis.
4. Privacidade: envie apenas informações necessárias e respeite as regras aplicáveis de proteção de dados (LGPD).
5. Tratamento de erros: verifique o código HTTP e a resposta da API para identificar falhas de integração.
6. Testes: realize envios de teste antes de disponibilizar a integração em produção.