Documentação para Desenvolvedores
Tudo o que você precisa para conectar o Deskwoot ao seu stack. Coloque o widget de chat no seu site ou controle conversas, contatos e caixas de entrada a partir do seu backend.
A API REST permite que seus próprios sistemas criem e respondam conversas, gerenciem contatos e atributos personalizados e reajam a eventos de webhook. Você se autentica com um token bearer criado em Configurações → Tokens de API. Cada token tem seus próprios escopos, então um job de relatórios pode ter só leitura enquanto a integração do seu back office tem escrita. Tokens de API fazem parte do plano Enterprise.
O widget JavaScript coloca o chat ao vivo do Deskwoot no seu site. É uma tag de script com um pequeno objeto de configurações, e traz mensagens em tempo real, anexos, login verificado para usuários logados e o Fynn, nosso agente de IA. Para mais controle, como abrir o chat pelo seu próprio botão ou identificar um usuário depois que a página carregou, o loader expõe uma pequena API em window.deskwoot.
Começando agora? Comece pelo widget: é um único snippet no template da sua página. Passe para a API REST quando quiser sincronizar dados do CRM ou abrir conversas a partir dos seus próprios apps.
Widget de Chat JavaScript
Coloque o chat ao vivo do Deskwoot no seu site. Cole um snippet, verifique usuários logados e abra o chat pelos seus próprios botões.
- Snippet de embed
- Opções de configuração
- API JavaScript
- Verificação de identidade
- Notas de CSP
API REST
Acesso programático a conversas, contatos, caixas de entrada, equipes e mais. Autentique-se com um token de API e controle o Deskwoot a partir do seu backend.
- Autenticação
- Conversas
- Contatos
- Caixas de entrada
- Webhooks
Relacionado no dashboard
Algumas integrações são configuradas direto no seu dashboard do Deskwoot:
- Configurações → Webhooks
- Assine eventos de conversa, mensagem e contato via callbacks HTTP.
- Configurações → Integrações
- Conecte Shopify, Stripe e WooCommerce, publique alertas no Slack e envie eventos para milhares de outros apps pelo Zapier.
- Configurações → Tokens de API
- Crie tokens com escopos próprios para a API REST.
Faltando uma integração ou precisa de ajuda para conectar algo? Fale conosco em hello@deskwoot.com.
Perguntas frequentes
As respostas curtas estão aqui. Para qualquer outra coisa, pergunte ao Fynn abaixo.
O Deskwoot tem uma API REST?
Sim. A API REST cobre conversas, mensagens, contatos, caixas de entrada, agentes, equipes, etiquetas, atributos personalizados, regras de automação, webhooks e artigos da central de ajuda. A referência completa com exemplos em curl está em deskwoot.com/docs/api. Tokens de API fazem parte do plano Enterprise.
Como autenticar requisições da API?
Crie um token em Configurações → Tokens de API e envie-o como token bearer no header Authorization de cada requisição. Cada token pertence a um workspace, tem seus próprios escopos (como read, write ou contacts:read) e pode ser revogado a qualquer momento sem afetar seus outros tokens.
Existem webhooks para novas conversas e mensagens?
Sim. O Deskwoot envia webhooks quando uma conversa é criada, atualizada, atribuída ou resolvida, quando uma mensagem é criada, quando um contato é criado ou atualizado e quando uma pesquisa CSAT é enviada. Você cadastra URLs de webhook para o workspace inteiro em Configurações → Webhooks e escolhe os eventos de cada URL. Cada entrega traz um header X-Deskwoot-Signature (HMAC SHA256), para você confirmar que veio de nós.
Existe especificação OpenAPI ou coleção Postman?
Sim. A especificação OpenAPI 3.1 está publicada em deskwoot.com/openapi.yaml. Importe-a no Postman, no Insomnia ou em outra ferramenta OpenAPI para navegar pelos endpoints ou gerar um cliente na sua linguagem.