> ## Documentation Index
> Fetch the complete documentation index at: https://help.whatix.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> Gerencie tokens, webhooks e a atividade da API pública do Whatix.

A tela **API** centraliza os tokens de acesso, os webhooks de entrada e a atividade da API pública do Whatix. Use-a para conectar outros sistemas, como um ERP ou uma ferramenta de automação, ao Whatix.

<Frame>
  <img src="https://mintcdn.com/whatix-help/7EYQERw5JQa0PoAD/src/img/api.jpg?fit=max&auto=format&n=7EYQERw5JQa0PoAD&q=85&s=d48371755796cc55387c8d9286b5ec47" alt="Tela API na aba Tokens, com os botões Documentação e Novo token e a tabela de tokens com nome, prefixo, escopos, último uso e status" width="1600" height="293" data-path="src/img/api.jpg" />
</Frame>

<Tip>
  Para saber como integrar sistemas ao Whatix, com endpoints, autenticação e exemplos, clique em **Documentação** no topo da tela.
</Tip>

## Abas

* **Tokens**: lista os tokens criados, com nome, prefixo, escopos, último uso e status.
* **Webhooks**: lista os webhooks de entrada, que recebem dados de outros sistemas.
* **Atividade**: mostra cada chamada feita à API, com data, método, endpoint, status e erro. Filtre por token para ver o uso de uma integração específica.

## Criar um token

Clique em <button type="button" aria-label="Botão Novo token (exemplo visual)" className="inline-flex h-8 items-center gap-1 rounded-md bg-emerald-500 px-3 text-sm font-medium text-slate-900 transition-colors hover:bg-emerald-600"><span aria-hidden="true">＋</span> Novo token</button> .

<Frame>
  <img src="https://mintcdn.com/whatix-help/7EYQERw5JQa0PoAD/src/img/api-token.jpg?fit=max&auto=format&n=7EYQERw5JQa0PoAD&q=85&s=027e7fbb64bfe0a3c2f7349318e38628" alt="Janela Novo token de API com o nome da integração, as opções de permissão Envio, Só leitura e Personalizado e a lista de escopos" width="576" height="758" data-path="src/img/api-token.jpg" />
</Frame>

<Steps>
  <Step title="Dê um nome">
    Em **Nome da integração**, identifique o sistema que vai usar o token, como "ERP Cobrança" ou "n8n".
  </Step>

  <Step title="Escolha as permissões">
    * **Envio**: enviar mensagens, ler conversas e disparar fluxos.
    * **Só leitura**: acesso de leitura a todos os recursos.
    * **Personalizado**: você liga e desliga cada escopo, como `messages:send` ou `contacts:write`.
  </Step>

  <Step title="Crie o token">
    Clique em **Criar token** e copie o token exibido.
  </Step>
</Steps>

<Warning>
  O token completo aparece **uma única vez**, logo após a criação. Copie e guarde em um lugar seguro antes de fechar a janela. Depois disso, a tabela mostra só o prefixo.
</Warning>

<Note>
  Conceda só os escopos que a integração precisa. Quem tiver o token consegue agir no Whatix dentro dessas permissões.
</Note>

## Webhooks de entrada

Um webhook de entrada é um endereço que recebe dados de qualquer sistema externo, como uma loja virtual, um CRM, uma planilha ou uma ferramenta de automação. Cada webhook executa uma ação com os dados recebidos, como criar uma oportunidade em um [pipeline](/atendimento/pipelines).

<Frame>
  <img src="https://mintcdn.com/whatix-help/7EYQERw5JQa0PoAD/src/img/api-webhooks.jpg?fit=max&auto=format&n=7EYQERw5JQa0PoAD&q=85&s=b069d341353960e87fab2c303328321c" alt="Aba Webhooks com um webhook na lista e a chave de ativação" width="1600" height="236" data-path="src/img/api-webhooks.jpg" />
</Frame>

A lista mostra o nome de cada webhook, o início do endereço e uma chave para ativar ou desativar. Selecione um webhook para ver a URL completa, o mapeamento dos campos e as requisições recebidas.

### Criar um webhook

Na aba **Webhooks**, clique em <button type="button" aria-label="Botão Novo webhook (exemplo visual)" className="inline-flex h-8 items-center gap-1 rounded-md bg-emerald-500 px-3 text-sm font-medium text-slate-900 transition-colors hover:bg-emerald-600"><span aria-hidden="true">＋</span> Novo webhook</button> .

<Frame>
  <img src="https://mintcdn.com/whatix-help/7EYQERw5JQa0PoAD/src/img/api-webhook-novo.jpg?fit=max&auto=format&n=7EYQERw5JQa0PoAD&q=85&s=804f7bdfb4223db9488667f5049fa616" alt="Janela Novo webhook com os campos Nome, Ação, Autenticação, Pipeline, Etapa, Origem e Responsável pelos cards" width="512" height="585" data-path="src/img/api-webhook-novo.jpg" />
</Frame>

<Steps>
  <Step title="Identifique o webhook">
    Dê um **Nome** que indique o sistema de origem, como "Loja Virtual".
  </Step>

  <Step title="Escolha a ação e a autenticação">
    Em **Ação**, defina o que o Whatix faz ao receber os dados, por exemplo, **Criar oportunidade no pipeline**. Em **Autenticação**, escolha como a chamada será validada.
  </Step>

  <Step title="Configure o destino">
    Os campos seguintes dependem da ação. Para criar oportunidades, escolha o **Pipeline**, a **Etapa**, a **Origem** e o **Responsável pelos cards**.
  </Step>

  <Step title="Crie e mapeie">
    Clique em **Criar webhook**. A URL secreta é gerada nesse momento. Depois que o sistema de origem fizer a primeira chamada, clique na requisição capturada para mapear os campos recebidos.
  </Step>
</Steps>

<Note>
  Se, no momento da chamada, não houver um responsável disponível, o card é atribuído ao administrador da conta. O card nunca deixa de ser criado.
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.