Bastidores: Seu widget, do seu jeito com JavaScript


Nossa API permite criar automações e personalizações ilimitadas para o seu widget do tawk.to usando JavaScript. Nesta conversa com Mārtiņš, Lead Backend Engineer da tawk.to, você descobrirá alguns dos casos de uso mais populares da API JS e aprenderá como evitar os erros mais comuns. Você também terá uma prévia do que vem por aí para a API do tawk.to e poderá solicitar acesso agora.

1 — O que é uma API e o que ela pode fazer?

API significa Application Programmable Interface (Interface de Programação de Aplicações). É um meio pelo qual dois softwares diferentes podem se comunicar. No caso da API JavaScript, ela é usada no site onde o widget está instalado para influenciar e controlar o comportamento do widget e vários de seus aspectos.

2 — Quais são alguns dos benefícios de usar a JavaScript API do tawk.to?

Com a JavaScript API, há ações que podem ser realizadas e que seriam mais difíceis ao responder um chat no painel ou ao reagir a eventos no seu site. Por exemplo, você pode maximizar o widget diretamente pelo JavaScript do seu site — ou minimizá-lo, se necessário.


Um caso de uso comum é ter um botão “Contact us” (“Fale conosco”) com o widget completamente oculto até que o botão seja clicado. Para isso, você define o widget como oculto no carregamento inicial. Depois, basta maximizá-lo e torná-lo visível quando o botão “Contact us” for clicado.


Você também pode reagir ao widget de diferentes maneiras. É possível configurar eventos, por exemplo, quando o widget é carregado ou quando é maximizado ou minimizado. Você pode até ajustar o conteúdo do seu site conforme o estado do widget. Na verdade, a imaginação é o limite do que é possível fazer.

3 — Podemos substituir o ID padrão do usuário pelo nome e e-mail do visitante?

Esse é certamente um dos casos de uso mais comuns. Existem algumas maneiras de fazer isso.


Suponhamos que você tenha um CRM e já possua esses dados disponíveis. Você pode adicionar propriedades de nome e e-mail ao objeto do visitante. Quando o widget iniciar, ele coletará automaticamente essas informações e as enviará ao tawk.to. Assim, você verá imediatamente o nome e o e-mail do visitante.


Se o widget já estiver operacional — ou seja, já tiver carregado — você também pode definir o nome e o e-mail do visitante como atributos. E não está limitado apenas a nome e e-mail: vários atributos podem ser definidos. Suponha que você queira definir o plano que seu cliente está usando. Isso pode ser um atributo personalizado. Esses atributos personalizados aparecerão na barra lateral do chat, na guia Details.

4 — Podemos adicionar um número de telefone usando a JavaScript API?

Você deve definir um atributo chamado “phone”. Atualmente, não há suporte explícito para telefone. Assim, você pode defini-lo como um atributo de texto. Em breve teremos uma novidade empolgante — nosso novo CRM — no qual será possível definir telefone, além de vários e-mails e múltiplos números de telefone. Haverá muitos outros recursos interessantes. Ainda não posso revelar muito, mas estamos muito próximos do lançamento e muito animados, pois isso tornará a funcionalidade de atributos ainda mais útil e poderosa.

5 — Quais são os erros comuns cometidos ao usar a JavaScript API?

Um dos erros mais comuns é tentar fazer a API executar ações antes mesmo de ela estar pronta para aceitar comandos e enviar eventos.


Por isso existe o evento chamado onLoad. O erro frequente é tentar enviar comandos imediatamente — como minimizar ou maximizar o widget — e depois ficar sem entender por que não funciona, já que o widget e a API ainda não carregaram.


O segundo erro mais comum é habilitar o modo seguro sem compreender o que ele realmente faz e quais são os pré-requisitos necessários para funcionar corretamente.

6 — Existe uma REST API disponível no tawk.to?

Temos uma Rest API em beta privado atualmente disponível para nossos Parceiros. Se você é um parceiro e deseja acesso à REST API, basta entrar em contato com seu representante mais próximo.


A Rest API é voltada para executar ações em nome de um agente. Enquanto a JavaScript API serve para controlar o widget no seu site, a Rest API permite executar ações como um agente. Já existem vários recursos úteis e continuamos expandindo. Atualmente, os usos mais comuns incluem criar propriedades para seus clientes, convidá-los automaticamente e ler o histórico de conversas.


Também é possível gerenciar webhooks e sua Base de Conhecimento por meio da REST API. Suponha que você crie uma propriedade para seu cliente e queira que algumas entradas básicas da Base de Conhecimento sejam criadas automaticamente. Isso pode ser automatizado com a REST API.


E se você tiver um caso de uso realmente interessante, conte para nós e avaliaremos se nossa Rest API atende à sua necessidade.


Veja nossa Documentação da API JavaScript na Plataforma de Desenvolvedores do tawk.to.


Solicite acesso à REST API aqui: Obter acesso beta à REST API

Este artigo foi útil?

142 de 184 gostaram deste artigo