Visão geral da API
Onde está a API pública da Lexfy e o que já existe hoje para integrar: webhooks e habilidades HTTP.
A API pública da Lexfy ainda não foi liberada. Quando existir, esta aba vai ter a autenticação, a referência completa com um ambiente para testar chamadas e o servidor MCP. Enquanto isso, dois recursos já permitem integrar a Lexfy com outros sistemas, e esta página explica os dois.
Visão geral
- Com webhooks, a Lexfy avisa o seu sistema quando algo acontece: chegou mensagem, um campo foi preenchido, uma conversa mudou.
- Com habilidades HTTP, o agente chama a sua API no meio da conversa, por exemplo para consultar um cadastro ou abrir um ticket.
- Webhooks ficam em Configurações → Webhooks. Habilidades HTTP ficam em Agentes → Habilidades.
- Precisa de algo além disso? Conte o caso de uso para o suporte. É assim que a API pública está sendo priorizada.
Passo a passo
- 1
Receba eventos por webhook
Em Configurações → Webhooks, clique em Configurar Webhook, informe a URL do Webhook, escolha os Eventos e, se precisar, Headers customizados. Os eventos disponíveis são estes.
Evento Quando dispara Mensagem Enviada Uma mensagem saiu da Lexfy Mensagem Recebida O lead enviou uma mensagem Conversa Criada Uma conversa nova começou Conversa Atualizada Status, etapa, tags ou responsável mudaram Follow-up Enviado Um follow-up automático foi enviado Campo Atualizado Um campo inteligente foi preenchido ou alterado Contato Criado Um contato novo entrou Contato Atualizado Dados do contato mudaram - 2
Deixe o agente chamar a sua API
Em Agentes → Habilidades, clique em Nova habilidade HTTP. Dê um Título da habilidade, defina método e URL na aba Configuração HTTP, a autenticação (Bearer ou API key) e as tentativas em Auth & Retry, os Parâmetros que a IA precisa coletar do lead e como ler a Resposta. Depois, use a habilidade na instrução da etapa com
@. - 3
Acompanhe o lançamento
A API pública será anunciada na aba Novidades.
Dúvidas frequentes
Quando a API pública sai?
Ainda sem data. Quando sair, esta aba terá autenticação, referência gerada a partir do arquivo OpenAPI, um ambiente para testar chamadas e um servidor MCP.
Existe documentação do que o webhook envia?
Ainda não está publicada. O caminho hoje é apontar o webhook para um endpoint de teste, disparar um evento e olhar o que chegou.
Posso ter mais de um webhook?
Não. Cada escritório tem um webhook, que pode escutar vários eventos. Se precisar de destinos diferentes, roteie do seu lado.