Deskwoot logoDeskwoot

Documentação para Desenvolvedores

Tudo que você precisa para integrar o Deskwoot ao seu stack - incorpore o widget de chat ou controle a plataforma programaticamente a partir do seu backend.

O Deskwoot é construído com filosofia API-first, então tudo que você pode fazer no dashboard também está disponível via HTTP. A API REST permite criar e responder conversas, gerenciar contatos, sincronizar atributos personalizados, escutar eventos de webhook e puxar analytics para sua própria ferramenta de BI. A autenticação é um simples bearer token que você gera em Configurações → Tokens de API, com escopos por token para que você possa dar acesso somente leitura a um job de relatórios e acesso completo à sua integração de backoffice.

O SDK de Widget JavaScript é como você coloca o chat ao vivo do Deskwoot no seu site. É uma única tag de script mais um pequeno objeto de configuração, e ele cuida de mensagens em tempo real, pré-preenchimento de identidade para usuários autenticados, gatilhos proativos de chat, hardening de CSP, anexos de arquivos e o fallback de bot de IA automaticamente. Se você quer controle mais profundo - mudar cores em tempo de execução, abrir o widget a partir do seu próprio botão, rastrear contexto de página - o SDK expõe uma pequena API JavaScript em window.$deskwoot.

Se você está começando agora, recomendamos ler primeiro o SDK do Widget (a maioria dos times coloca em produção em menos de 10 minutos) e depois passar para a API REST quando precisar sincronizar dados de CRM ou automatizar criação de tickets a partir dos seus próprios apps.

SDK do Widget

Widget de Chat JavaScript

Incorpore o widget de chat ao vivo do Deskwoot no seu site. Cole o snippet de script, configure cores e comportamento, e deixe os visitantes alcançarem seus agentes.

  • Snippet de embed
  • Opções de configuração
  • API JavaScript
  • Pré-preenchimento de identidade
  • Notas de CSP
Abrir docs
API REST

API HTTP

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.

  • Auth + tokens
  • Conversas
  • Contatos
  • Caixas de entrada
  • Webhooks
Abrir docs

Relacionado no dashboard

Superfícies de integração que ainda não têm sua própria página de docs vivem diretamente no seu dashboard Deskwoot:

  • Configurações → Webhooks - assine eventos de conversa, mensagem e contato via callbacks HTTP
  • Configurações → Integrações - conectores de um clique para Shopify, Stripe, WooCommerce, Slack, Zapier e mais
  • Configurações → Tokens de API - crie tokens com escopo para a API REST

Faltando uma integração ou precisa de ajuda para conectar algo? Fale conosco em hello@deskwoot.com.

Perguntas frequentes

Dúvidas de desenvolvedores sobre a API e webhooks do Deskwoot.

O Deskwoot tem uma API REST?

Sim. O Deskwoot expõe uma API REST completa para conversas, contatos, mensagens, caixas, equipes, agentes, etiquetas, atributos personalizados, regras de automação e artigos da central de ajuda. A API alimenta o app móvel oficial e está documentada em deskwoot.com/docs/api com exemplos em curl e JavaScript.

Como autenticar requisições da API?

Gere um token de API em Configurações > Acesso de Desenvolvedor. Passe-o como Bearer token no header Authorization em toda requisição. Os tokens são limitados a um workspace e podem ser revogados a qualquer momento sem afetar outros tokens.

Existem webhooks para novas conversas e mensagens?

Sim. O Deskwoot dispara webhooks em eventos de conversa (criada, status alterado, atribuída, resolvida) e eventos de mensagem (nova de entrada, nova de saída, nova nota privada). Você registra URLs de webhook por caixa ou workspace e o Deskwoot assina cada entrega para que você possa verificar a origem.

Posso construir um canal personalizado com a API do Deskwoot?

Sim. A API REST aceita mensagens de entrada em qualquer identificador de origem que você definir, então você pode integrar chat dentro de um app móvel, chat dentro de um jogo, dispositivos IoT ou qualquer superfície personalizada. As respostas de saída passam pela mesma API e disparam seu próprio callback de entrega.

Onde encontro os limites de taxa da API?

O limite base é de 60 requisições por minuto por token para a maioria dos endpoints, com limites maiores para operações em lote. A tabela completa por endpoint está em deskwoot.com/docs/api/rate-limits. Ao atingir o limite, a resposta traz um header Retry-After para que seu cliente recue de forma limpa.

Existe especificação OpenAPI ou coleção Postman?

Uma especificação OpenAPI 3 é publicada em deskwoot.com/docs/api/openapi.json e pode ser importada para Postman, Insomnia ou qualquer ferramenta compatível com OpenAPI para gerar clientes em qualquer linguagem. A especificação fica sincronizada com a API ao vivo a cada release.