Deskwoot para API
API de atendimento ao cliente para integrações e canais personalizados
A API de atendimento ao cliente do Deskwoot expõe tudo: conversas, contatos, mensagens, agentes, tags, campos personalizados. Construa canais próprios, chat in-app, roteamento de alertas IoT ou fluxos de suporte white-label completos.
A maior parte dos helpdesks trata a API como um adendo, atrás de planos enterprise e sem os endpoints que você realmente precisa. A API de atendimento do Deskwoot está incluída em todo plano, inclusive no nível gratuito.
REST + webhooks: cada entidade (conversas, contatos, mensagens, agentes, tags, campos personalizados) tem uma interface CRUD completa. Webhooks disparam em cada mudança de estado, então seu código de integração fica orientado a eventos em vez de baseado em polling.
Autenticação: OAuth 2.0 para contextos de usuário final (construa um fluxo 'Entrar com Deskwoot' no seu próprio app), tokens de API estáticos para serviço-a-serviço. Escopos por token deixam você conceder permissões somente leitura ou limitadas a integrações específicas.
Canais personalizados: marque cada conversa com um identificador 'source' próprio para rotear, filtrar ou reportar separadamente. Útil para chat in-app, ingestão de alertas IoT ou qualquer canal não padrão que as caixas embutidas não cobrem.
Padrões comuns de atendimento API-first que vemos: 1) Chat in-app a partir de um app mobile, em que o SDK posta direto na API, 2) Fluxos de form-para-ticket onde um formulário de contato no seu site cria um ticket Deskwoot via webhook, 3) Suporte a dispositivos IoT em que um Raspberry Pi ou sensor industrial pinga a API em caso de erro, 4) Widgets de suporte white-label em que um SaaS revende o Deskwoot sob a própria marca.
O que você ganha com o atendimento via API
REST + Webhooks
Manda mensagens, recebe callbacks de respostas. As duas direções documentadas. Arquitetura orientada a eventos de fábrica.
Tag de fonte por conversa
Marque cada conversa com um identificador de fonte personalizado para rotear ou filtrar canais próprios separadamente.
OAuth e tokens de API
Use OAuth para contextos de usuário final ou tokens de API estáticos para serviço-a-serviço. Escopos por token para acesso granular.
Suporte a SDK
SDKs oficiais para Node.js, Python e um SDK de widget JavaScript para chat in-app. SDKs de comunidade para Ruby, PHP e Go.
Idempotency keys
Cada endpoint de escrita aceita uma idempotency key, então retries são seguros. Crítico para condições de rede pouco confiáveis.
Configuração em minutos
Conecte o API em 3 passos. Sem código.
- 1Pegue seu token de API em Configurações → API.
- 2Faça POST em /api/v1/conversations para criar uma conversa.
- 3Configure uma URL de webhook para receber respostas.
FAQ de atendimento ao cliente via API
- Qual é a melhor API de atendimento para integrações personalizadas?
- Para casos de uso de canal personalizado e white-label, a API de atendimento precisa de: CRUD completo em conversas e contatos, webhooks para eventos, OAuth e token, idempotency keys e boa documentação. O Deskwoot cobre tudo isso. Zendesk e Intercom também têm APIs fortes, mas geralmente atrás de planos premium.
- O que é um software de atendimento API-first?
- Software de atendimento API-first expõe todo o conjunto de funcionalidades pela API, não só uma fração. Cada ação da UI (atribuir tickets, enviar mensagens, atualizar contatos) tem um endpoint correspondente. O Deskwoot é API-first; a API veio antes da UI no nosso processo de build.
- Onde estão os docs da API de atendimento?
- A referência completa da API está em /docs/api. SDKs para Node.js e Python estão linkados de lá. A spec OpenAPI é publicada para ferramentas como Postman e Insomnia.
- Como construo um canal personalizado com a API?
- Faça POST em /api/v1/conversations com seu identificador 'source' personalizado. Configure um webhook para receber respostas dos agentes. Seu canal personalizado (chat in-app, IoT etc.) envia e recebe via seu próprio código de integração; o Deskwoot cuida da semântica de caixa, IA, SLA e relatórios.
- Existem rate limits na API de atendimento?
- Sim. Padrão de 1000 requisições por minuto por token. Limites maiores em planos pagos ou sob solicitação. Respostas 429 incluem cabeçalho Retry-After.
- A API suporta webhooks para todo evento?
- Sim. Conversa criada, resolvida, reaberta, mensagem recebida, contato atualizado, tag adicionada, status alterado. A entrega de webhook é at-least-once com retries em respostas 5xx.
- Posso usar a API para migrar de outro helpdesk?
- Sim. O endpoint de bulk-import aceita contatos, conversas e mensagens em uma chamada. Temos scripts de migração prontos para Zendesk, Intercom, Help Scout, Front e Chatwoot.