Developers

Aparência

Vai integrar a plataforma Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a plataforma Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/integrations/
- Comece pelo Setup (hosts, autenticação, loader do SDK): https://developers.zarv.com/setup
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [descreva aqui o que você quer construir]

Integrações ​

Uma integração liga uma campanha do SmartFlow a um sistema externo. O SmartFlow emite um evento a cada etapa do cadastro e a integração reage a ele: cria o cliente, atualiza o contato. Você configura tudo no admin Zarv.

Campanha, fluxo e funil

O admin chama a campanha de "fluxo" ou "funil". Estas páginas usam campanha.

LocaviaERP de locação de veículosCadastra cliente e condutor do lead aprovado e, se você quiser, cria o contrato pendente.Cotalk (Helena)CRMEspelha o estado do lead em um contato, com etiquetas e campos personalizados.

Para ligar qualquer uma delas, siga Conectar e ativar uma integração.

Como funciona ​

  1. O visitante avança na campanha e o SmartFlow emite um evento por etapa (lead.basic.completed, lead.email.completed e assim por diante) e, no fim, o evento terminal (lead.approved, lead.rejected, lead.completed).
  2. Cada par (evento, lead) vira um envio. A integração reage aos eventos de que precisa: a Locavia roda em lead.approved; a Cotalk (Helena) roda em todos os 11 eventos.
  3. O resultado aparece no sistema externo.
  4. Se um envio falha, ele é tentado de novo a partir do ponto em que parou. As regras de entrega do webhook da sua campanha estão em Webhook da campanha; elas se aplicam ao seu endpoint, não a estes envios.

Os eventos são os mesmos do webhook. A lista completa está em Webhook da campanha.

Uma conexão por campanha ​

Locavia e Cotalk (Helena) são configuradas por campanha. Cada campanha tem a sua própria conexão, com a sua própria credencial. Duas campanhas que usam a mesma conta externa guardam uma credencial cada, e uma campanha sem conexão nunca usa a conta de outra.

Dois níveis de liga/desliga ​

Workspace

Integração ativa, em Configurações › Marketplace.

Quem altera: administrador do workspace.

Campanha

Chave própria da integração, no editor da campanha.

Quem altera: quem edita a campanha.

Página do conector no Marketplace, com a chave Integração ativa
Workspace: a chave Integração ativa, na página do conector.Clique para ampliar

As duas precisam estar ligadas. Com a Integração ativa desligada, o painel da campanha fica travado.

Etapa Integrações no editor da campanha, com os painéis das integrações
Campanha: a etapa Integrações do editor.Clique para ampliar

Quem faz o quê ​

  • Administrador do workspace: liga a Integração ativa e altera a conta, a credencial e a conexão.
  • Quem edita a campanha: mantém as configurações da própria campanha.

Quando algo falha ​

O que você vê depende da integração. Na Locavia, a Visão geral mostra o Resumo de envios (com a contagem de Com falha), a aba Status lista os envios da campanha, e um e-mail de falha é enviado quando um envio esgota as tentativas. Na Cotalk (Helena), os erros aparecem ao salvar, e uma etiqueta ou campo apagado no CRM interrompe aquela parte e é citado no erro do envio. Os detalhes estão em cada página.