Webhook

Esta documentação descreve como enviar Leads para o Robust via Webhook.

Para um lead ter permissão de acesso ao Robust é preciso seguir os passos descritos abaixo. Caso tenha alguma dúvida só nos chamar no whatsapp: (32) 99106-1840 - Jean.

1. Endpoint da API

URL: https://robustcrm.io/autolead/nickname_client

O parâmetro nickname_client é único por cliente e é obtido acessando o Robust no menu: Painel de controle / Configurações / Dados administrativos

2. Método HTTP

O método de envio: POST

3. Cabeçalhos da Requisição (Headers)

Header	Valor	Observação
`Content-Type`	`application/json`
`Rb3-Api-Key`	`api_key`	Chave única de identificação do cliente no Robust.

A api_key é única por cliente e é obtida acessando o Robust no menu: Painel de controle / Configurações / Dados administrativos

4. Campos Operacionais

Campo	Descrição	Exemplo / Observação
`leadOrigin`	Nome do formulário exibido como origem no CRM.
`timestamp`	Data e hora no formato ISO 8601	`2024-05-15T15:31:00.619Z`
`originLeadId`	Identificador único da requisição
`originListingId`	Código do anúncio no portal ou formulário de origem.
`clientListingId`	Código do imóvel ou condomínio cadastrado no CRM.
`clientListingIdType`	Pode ser `imovel` (padrão) ou `condominio`

5. Campos Especiais

Campo	Descrição	Exemplo / Observação
`jornada`	Tipo de jornada no CRM	`negociacao` (padrão) ou `captacao`
`business`	Tipo de negócio	`venda` (padrão) ou `locacao`
`key`	Chave de identificação única para rastrear campanhas ou canais.
`conversion_data`	Dados de conversão no formato JSON	Campos das campanhas do Meta Ads
`agent`	Campo "Nickname" do cadastro de usuário do atendente no Robust.
`force_flow`	Código do fluxo de atendimento

O campo conversion_data deve ser um JSON válido. Outros formatos não serão processadosnos relatórios.

O campo jornada só terá validade se clientListingId estiver vazio ou for inválido.

6. Campos para progresso do atendimento para os estágios - Atendimento ou Agendamento (Visita Imóvel ou Encontro Presencial)

Campo	Descrição	Exemplo / Observação
`start`	Gera ou muda atendimento para estágio "Atendimento" se o atendimento estiver na etapa "Lead".	`true` ou `false`. O padrão é `null`.
`date_init`	Dia e hora do início. Deve ser maior que o momento atual.	Formato: `dd/mm/yyyy hh:mm`
`date_end`	Dia e hora do término. Deve ser maior que `date_init`, caso contrário será desconsiderado e adotado o período de 1 hora de intervalo.	Formato: `dd/mm/yyyy hh:mm`
`reminder`	Tempo em minutos para gerar notificação de lembrete do evento.	Padrão 30 minutos.
`description`	Informação relevante para o evento.
`date_cancel`	Dia e hora do evento para ser cancelado.	Formato: `dd/mm/yyyy hh:mm`

O campo clientListingId deve conter o código do imóvel e o campo clientListingIdType não pode informar o valor "condominio" para que seja possível identificar o imóvel para agendar uma Visita imovel. Se for informado um código incorreto ou de um condomínio, o campo será ignorado e o agendamento será considerado um Encontro presencial.

O campo date_cancel deve conter a data exata de um agendamento mais o código do imóvel pelo campo clientListingId para encerrar um agendamento. Será ignorado se o agendamento já estiver cancelado ou como visita realizada.

7. Campos de Identificação do Cliente

Campo	Descrição	Exemplo / Observação
`name`	Nome completo do cliente
`email`	Endereço de e-mail do cliente
`ddd`	Código de área	Opcional se `phone` já estiver com DDD.
`phone`	Número de telefone do cliente	Se o campo `ddd` não estiver preenchido, deve constar junto ao número.
`message`	Mensagem do cliente

8. Exemplo de Requisição

curl --location 'https://robustcrm.io/autolead/nickname_client' \
    --header 'Content-Type: application/json' \
    --header 'Rb3-Api-Key: substitua pela chave do cliente' \
    --data-raw '{
        "leadOrigin": "LP Formulario",
        "timestamp": "2024-05-15T15:31:00.619Z",
        "originLeadId": "59ee0fc6e4b043e1b2a6d863",
        "originListingId": "87027856",
        "clientListingId": "7561",
        "name": "Cliente teste",
        "email": "product@testeteste.com",
        "ddd": "11",
        "phone": "959943055",
        "message": "O resumo da conversa aparecerá aqui."
    }'

Imóveis por JSON

Para poder ter acesso aos imóveis via requição Http no formato JSON, entre em contato com o cliente e solicite permissão. Depois é só nos no whatsapp: (32) 99106-1840 - Jean.