Passar para o conteúdo principal

Como configurar conectores de Dados para Workflows e Inbox

Aprenda a usar Data connectors para conectar seus dados externos ao vivo com o Intercom Inbox e os Workflows.

Escrito por Beth-Ann Sher

Data connectors são integrações sem código e profundamente incorporadas que podem conectar seus dados externos ao vivo ao Intercom. Esses dados ao vivo podem ser usados para alimentar Fin, Workflows e o Inbox, permitindo que seus clientes resolvam suas dúvidas automaticamente.

Uma ótima maneira de começar é pensar nas perguntas comuns que seus colegas passam muito tempo respondendo, usando informações que atualmente não estão disponíveis no Intercom.

Podem ser perguntas nas quais seus clientes simplesmente querem obter informações que você armazena em um sistema externo, como “Qual é o status do meu pedido?”, ou executar um Data connector como “Reagendar uma entrega” ou “Processar um reembolso” no seu sistema externo.

Quando você sabe quais perguntas deseja resolver, é surpreendentemente simples e rápido configurar um Data connector com pouca ou nenhuma expertise técnica.


Criando um Data connector

É aqui que você configurará todas as diferentes conexões que tiver com dados externos (por exemplo, Shopify, Salesforce, etc.), dependendo do seu caso de uso. Clique em + Novo.

Dica: Também é possível usar Data connectors para Fin.

Nome e descrição

Dê ao seu Data connector um nome único que explique exatamente qual Data connector ele executará (por exemplo, “Obter ID do pedido”). Use o campo de descrição para dizer aos colegas quando usar este Data connector e quais informações eles podem esperar que ele recupere (por exemplo, “Obter pedido para um ID dado. O ID do pedido deve ser armazenado em Conversation CDA”).

Para permitir que o Fin use este conector diretamente, navegue até a aba Fin e defina Como o Fin deve usar este conector? para Enabled (direct trigger). Se você quiser que ele seja usado apenas dentro de um Workflow, Task, Procedure, ou Macro, defina como Disabled (manual trigger).

Conexão API

Em seguida, preencha os detalhes da requisição. É aqui que você precisará inserir a URL HTTPS para o sistema de terceiros ao qual está se conectando (por exemplo, Shopify, Salesforce, etc.).

Requisição API

Você pode especificar qual Data connector você deseja que essa requisição execute selecionando o método:

  • GET - Ler e armazenar informações do sistema de terceiros.

  • POST - Criar ou adicionar informações ao sistema de terceiros.

  • PUT - Atualizar informações no sistema de terceiros.

  • DELETE - Remover informações do sistema de terceiros.

  • PATCH - Atualizar informações no sistema de terceiros.

Neste exemplo, pediremos que a requisição faça um GET do ID do pedido na API e insira a URL.

Para fazer uma requisição, a URL deve ser um endereço HTTPS.

Dicas:

  • Você pode inserir atributos de User, Conversation, Company e eventos como valores modelados na URL e no corpo da requisição dos métodos POST e PUT. Use atributos de dados personalizados que você já configurou no seu workspace. Ou, para muito mais flexibilidade de dados, tente usar objetos personalizados.

  • Data connectors convertem automaticamente respostas XML para JSON. Se sua API retornar XML, basta inserir o endpoint normalmente — o Intercom fará a conversão e exibirá o JSON resultante na etapa Test response. Você poderá então mapear e usar os dados como faria com uma API JSON nativa.

Cabeçalhos HTTP

Você pode optar por adicionar quaisquer parâmetros adicionais a esta requisição clicando em Add key value pair e então selecionar Key value pair sob HTTP Headers:

Autenticação

Data connectors suportam tokens fixos e dinâmicos para autenticação. Sob os HTTP Headers, você pode selecionar o authentication token que deseja usar na requisição, que será então adicionado ao cabeçalho.

Observação: Você pode anexar múltiplos tokens a um único data connector. Certifique-se de configurar cada token com uma chave de cabeçalho diferente. Todos os tokens anexados serão enviados com a requisição.

Corpo da requisição

Se você estiver fazendo uma requisição POST ou PUT, terá a opção de fornecer um corpo de requisição para incluir quaisquer dados que deseja enviar na requisição:

Certifique-se de incluir os cabeçalhos HTTP apropriados conforme exigido pela API à qual está fazendo a requisição (por exemplo, accept: application/json e Content-Type: application/json). Se você estiver enviando um corpo JSON, Content-Type: application/json deve ser adicionado explicitamente — sem ele, a API não analisará o corpo da requisição e rejeitará todos os campos como inválidos, mesmo que o JSON esteja corretamente formatado.

Testar resposta

Em seguida, você precisará testar a resposta deste Data connector para garantir que está buscando os dados corretos do sistema de terceiros ao qual está se conectando.

Importante: Testar esta requisição faz uma conexão com a API, então ela concluirá o Data connector que você criou. Por exemplo, se você solicitou que EXCLUÍSSE dados na API, essa informação será excluída. Tente testar com uma requisição GET para garantir que você está apenas lendo informações e não as alterando.

Clique em Test request para verificar se o Data connector foi configurado corretamente. Você deve obter um tique verde e ver os detalhes dessa requisição se a conexão for validada com a API.

Estas são todas as informações que você pode agora usar para alimentar seus Workflows e fornecer respostas rápidas aos clientes, como status do pedido.

Dica: Data connectors convertem automaticamente respostas XML para JSON. Se sua API retornar XML, basta inserir o endpoint normalmente — o Intercom fará a conversão e exibirá o JSON resultante na etapa Test response. Você poderá então mapear e usar os dados como faria com uma API JSON nativa.

Transformação de dados

Por padrão, o Fin pode acessar todos os dados da resposta para gerar respostas. Selecione Manually restrict access se desejar limitar os dados que o Fin pode ler. Em seguida, marque os campos de dados que você deseja dar acesso ao Fin.

Você também pode editar os itens de dados individuais clicando no ícone de edit para dar ao seu dado de resposta um nome voltado ao cliente, bem como especificar quaisquer transformações nos dados.

Por exemplo, se a resposta da API retornar um saldo de 0, em vez do Fin afirmar que o saldo não pago é 0, ele pode responder afirmando que atualmente não há saldo não pago restante.

Use código para filtrar ou transformar a resposta

Com blocos de código para Data connectors, estamos capacitando você a transformar e manipular diretamente as respostas da API usando Python — diretamente na configuração do seu connector.

Mapeamento de objetos

Esta etapa é opcional. Ela informa ao Data connector onde armazenar essas informações no Intercom para que possam ser fornecidas aos clientes em seus Workflows como respostas às suas perguntas.

Cenários comuns onde talvez não seja necessário armazenar dados são tipos de requisição Data connector PUT, POST, DELETE. Para todas as requisições GET, se você quiser usar os dados em bots, precisará armazenar esses dados no Intercom.

Ao criar conectores de Dados para Fin, não é necessário mapear os dados de resposta para atributos ou objetos do Intercom. Em vez disso, Fin interpreta diretamente a resposta JSON e pode usá-la para resolver perguntas. A resposta é gerada com base na seção ‘Test response’. Cada item de linha corresponde a um ponto de dados na resposta JSON.

Os dados de resposta JSON podem ser armazenados em:

  • Objetos Padrão: atributos de Usuário e Conversação.

  • Objetos Personalizados: atributos de objeto que você criou no Intercom.

Selecione o objeto do Intercom e, em seguida, mapeie-o com o objeto da API externa.

Todos os atributos personalizados e objetos personalizados devem ser criados antes de poderem ser usados para armazenamento de respostas aqui.

Agora selecione os atributos de dados no Intercom nos quais você deseja armazenar estas informações. Por exemplo, selecionamos “Order” como o objeto do Intercom e então selecionamos “root” como o objeto da API no sistema externo e o mapeamos com o atributo da API “currency”:

Dados externos só podem ser armazenados em atributos de dados personalizados e não nos atributos de dados padrão do Intercom.

Mapeando dados de resposta para Objetos Personalizados

Ao mapear com Objetos Personalizados, você deve mapear o ID para o campo external_id; caso contrário, ele criará duplicatas a cada solicitação GET. Saiba mais sobre como configurar referências corretas com Objetos Personalizados

Atualizando referências de Pessoas ou Conversações

O próximo passo é selecionar quais referências de Pessoas ou Conversação se relacionam ao seu objeto personalizado que você deseja atualizar.

Colocar em produção

Depois de testar com sucesso seu Data connector, você está pronto para colocá-lo em produção.

Nota: Data connectors usam um sistema de versionamento rascunho/ao vivo. Quaisquer alterações que você fizer — incluindo na configuração de gatilho Fin na aba Fin — são salvas como rascunho e não afetarão o conector ativo até que você clique em Set live. Se o conector parecer se comportar de forma inesperada após uma alteração, verifique se a versão atualizada foi colocada em produção. A lista de conectores em Configurações mostra o status atual de cada conector (ao vivo ou rascunho).

O limite de tempo para Data connectors é de 15 segundos e não é configurável pelo cliente. Para Data connectors usados dentro de Fin Procedures em workspaces elegíveis, o tempo limite é estendido para 30 segundos.

Dica: Se você quiser mais visibilidade em tempo real sobre as taxas de sucesso e falha dos seus Data Connectors, você pode usar o Data Connector Execution Webhook. Isso pode ser útil para receber eventos de execução para criar painéis em tempo real, alertas e monitoramento de SLA em seus serviços externos.


Exibindo dependências do Data connector

Para gerenciar ou editar seus Data connectors em escala com segurança, você pode auditar proativamente onde cada Data Connector ou ação MCP é usado no Intercom.

Como habilitar a visualização "Used by":

A coluna Used by pode estar oculta por padrão. Para mostrá-la:

  1. Clique no menu (três linhas horizontais) no canto superior direito da tabela.

  2. Marque a caixa ao lado de Used by.

Esta coluna fornece uma lista clicável e ao vivo de referências. Clicar em qualquer item levará você diretamente àquela fonte.

Ele rastreia o uso do Data connector em:

  • Workflows

  • Procedures & Tasks

  • Custom Answers

  • Macros


Monitorando a saúde do Data connector

Depois que seu Data connector estiver ativo, você pode monitorar seu desempenho diretamente em Settings > Integrations > Data connectors.

Indicadores de status de integridade

Uma coluna Health exibe o status operacional de cada conector com base nas taxas de sucesso e latência de suas execuções recentes.

Status

Critério

Implicação

HEALTHY

Taxa de sucesso > 95% e latência normal.

Operando de forma ideal.

DEGRADED

Taxa de sucesso entre 80-95% OU a latência é 2x a linha de base histórica.

Apresentando problemas, mas ainda parcialmente funcional.

UNHEALTHY

Taxa de sucesso é 80% ou inferior.

Problemas críticos que exigem atenção imediata.

Passe o cursor sobre qualquer distintivo de status de integridade para ver uma análise detalhada de seu desempenho recente:

Field Name

Descrição

Taxa de sucesso

Porcentagem de execuções bem-sucedidas sobre o total analisado.

Latência externa

Tempo de resposta da API/serviço externo (p90, p50, méd, min, max em ms).

Observação: Apenas execuções bem-sucedidas são incluídas.

Latência interna

Sobrecarga de processamento interno (tempo gasto no sistema da Intercom para executar o conector de dados) (p90, p50, méd, min, max em ms).

Latência Intercom

Tempo total de execução, calculado como Latência Externa + Latência Interna (p90, p50, méd, min, max em ms).

Distribuição de status HTTP

Distribuição dos códigos de status HTTP retornados pelo serviço externo (ex.: 200, 500, timeout) com contagem e porcentagem. Retorna nulo se não houver execuções.

Distribuição dos tipos de falha

Detalhamento dos tipos de falha (ex.: "Connection Timeout", "Authentication Failed"), ordenados por frequência, com contagem e porcentagem. Retorna nulo se não ocorreram falhas.

Contagem de execuções

O número real de execuções analisadas no período atual.

Filtros de tempo

Use o filtro de tempo na parte superior do painel para ajustar a janela de relatório. Opções disponíveis: 1h, 6h, 24h, 7d ou 14d.

Logs

Clique em qualquer conector para abrir seu painel de integridade dedicado e, em seguida, selecione a aba Logs para ver um registro com carimbo de data/hora de cada execução. Cada entrada mostra o canal em que foi executada e se teve sucesso ou falhou — clique em qualquer entrada para expandir os detalhes completos da execução.

Você pode filtrar os logs por:

  • ID da execução

  • Conversa

  • Status (sucesso ou falha)

  • Tipo de falha

Observação: Os logs são mantidos por até 14 dias. Para solicitar uma janela mais curta de 7 dias, entre em contato com nossa equipe de Suporte. Para acesso programático aos dados de execução além do painel, consulte API access to execution results.


Movendo um conector de dados para rascunho

Se você quiser descontinuar conectores de dados antigos que não são mais necessários, você pode movê-los para o estado de rascunho.

Vá para Settings > Integrations > Data connectors e clique no conector de dados que você deseja mover para rascunho e, em seguida, selecione Set to draft.

Embora a Intercom bloqueie a tentativa de colocar um conector em rascunho se houver dependências ativas, você agora pode gerenciá-las proativamente usando a coluna 'Used by'. Esta coluna fornece uma lista indexada e em tempo real de cada Workflow, Procedure, Task, Macro, and Custom Answer que referencia a ação. Você pode clicar diretamente em qualquer item dessa lista para ir até essa automação específica e resolver a dependência.

Observação: Uma Procedure em estado pausado ainda conta como dependência ativa. Mover um conector para rascunho será bloqueado mesmo se cada Procedure que referencia estiver pausada em vez de ativa. Resolva todas as referências ao conector — inclusive as em Procedures pausadas — antes de tentar definir o conector como rascunho.

Respondeu à sua pergunta?