Todos os canais

API de atendimento ao cliente para integrações e canais personalizados

A API de suporte ao cliente do Deskwoot cobre conversas, contatos, mensagens, agentes, etiquetas e atributos personalizados. Crie canais próprios, chat dentro do seu app ou roteamento de alertas sobre a caixa compartilhada.


Visão geral

Muitos helpdesks tratam a API como detalhe e deixam de fora justamente os endpoints que você precisa. A API de suporte ao cliente do Deskwoot vem no plano Enterprise e cobre conversas, mensagens, contatos, caixas de entrada, etiquetas, times, webhooks e mais, documentada em uma especificação OpenAPI.

REST e webhooks: conversas, contatos, mensagens, etiquetas, times, atributos personalizados e mais estão disponíveis via REST. Os webhooks enviam eventos como conversa criada, atribuída ou resolvida, novas mensagens, mudanças de contato e avaliações CSAT para a sua URL, assinados com o seu segredo, então o seu código reage a eventos em vez de ficar consultando. Com os tickets ativados, os eventos de tickets também podem ir para lá.

Autenticação: tokens de API com escopos. Dê a cada integração só o que ela precisa, por exemplo acesso de leitura ou o escopo próprio que pode enviar mensagens de clientes para uma caixa de API.

Canais personalizados: crie uma caixa de API REST, envie as mensagens dos seus clientes para ela com o seu próprio ID por mensagem e defina uma URL de callback. Uma requisição repetida nunca cria duplicata, e as respostas dos agentes e do Fynn vão para a sua URL de callback, então o chat dentro do seu app ou qualquer canal que não vem pronto funciona como os outros.

Padrões comuns: 1) chat dentro de um app mobile, em que o seu backend envia mensagens para uma caixa de API, 2) um formulário de contato no seu site que abre uma conversa pela API, 3) alertas de dispositivos ou sistemas que chegam à caixa como conversas, 4) sincronizar contatos e dados de conversas com os seus próprios sistemas.

O que você ganha com o atendimento via API

  • REST e webhooks

    Leia e grave conversas, contatos e mensagens e receba webhooks para eventos.

  • Repetições seguras

    Cada mensagem recebida leva o seu próprio ID, então uma requisição repetida nunca cria duplicata.

  • Tokens de API com escopo

    Cada token recebe só os escopos de que uma integração precisa.

  • Especificação OpenAPI

    A referência completa fica em /docs/api, com um arquivo OpenAPI para Postman, Insomnia ou o seu próprio gerador de cliente.

  • Callbacks para respostas

    Defina uma URL de callback na caixa de API e as respostas dos agentes e do Fynn vão para o seu sistema.

Como começar

Conecte o API em 3 passos.

  1. No plano Enterprise, crie um token de API em Configurações → API Tokens.
  2. Crie uma caixa de API REST e envie as mensagens dos clientes para o endpoint inbound dela.
  3. Defina uma URL de callback para receber as respostas.

Perguntas frequentes

As respostas curtas estão aqui. Para qualquer outra coisa, pergunte ao Fynn abaixo.

Qual é a melhor API de atendimento para integrações personalizadas?

Para canais próprios, a API de suporte precisa de: endpoints para conversas e contatos, webhooks para eventos, tokens com escopo, repetições seguras e boa documentação. O Deskwoot tem tudo isso no plano Enterprise, com especificação OpenAPI. Zendesk e Intercom também têm APIs fortes.

Como construo um canal personalizado com a API?

Crie uma caixa de API REST em Configurações → Caixas de entrada com uma URL de callback. Envie as mensagens dos clientes para /api/v1/accounts/{accountId}/inbound com um token que tenha o escopo inbound:ingest, e as respostas dos agentes e do Fynn vão para a sua URL de callback. O Deskwoot cuida da caixa, da IA, dos SLAs e dos relatórios.

Existem rate limits na API de atendimento?

Sim. As requisições têm limite por token, por exemplo 120 mensagens recebidas por minuto, e uma requisição acima do limite recebe a resposta 429.

Quais eventos os webhooks enviam?

Os webhooks cobrem os principais eventos: conversa criada, atualizada, atribuída e resolvida, mensagem criada, contato criado e atualizado e CSAT enviado. Com os tickets ativados, um webhook também pode receber ticket criado, atualizado, atribuído e resolvido. Cada entrega é assinada com o seu segredo de webhook e repetida uma vez se o seu endpoint falhar.

Posso usar a API para migrar de outro helpdesk?

Para a maioria das migrações você não precisa da API: Configurações → Importar traz contatos e conversas do Chatwoot, Zendesk, Freshdesk, Intercom e Crisp, e uma importação CSV cobre contatos de qualquer outro lugar. A API ajuda com dados de outros sistemas.

Teste grátis por 7 dias

Demo interativa do Deskwoot