> ## Documentation Index
> Fetch the complete documentation index at: https://strattumai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Zendesk

> Configure o conector Zendesk para ingerir tickets, usuários e organizações na plataforma strattum.ai.

<Note>
  Este guia cobre a configuração do conector Zendesk para **desenvolvimento local**. Para ativar o conector via Console strattum.ai, consulte o [Quickstart de Data Pipelines](/data-pipelines/quickstart).
</Note>

## Visão geral

O conector Zendesk extrai dados do Zendesk Support e os carrega na infraestrutura strattum.ai de forma incremental. A sincronização ocorre automaticamente a cada **15 minutos**.

| Recurso       | Modo de carga | Campo de cursor |
| ------------- | ------------- | --------------- |
| Tickets       | Incremental   | `updated_at`    |
| Users         | Incremental   | `updated_at`    |
| Organizations | Full Refresh  | —               |

***

## Pré-requisitos

<CardGroup cols={2}>
  <Card title="Conta Zendesk ativa" icon="circle-check">
    Acesso a uma instância Zendesk Support com login funcional.
  </Card>

  <Card title="Perfil Agent ou Admin" icon="shield-check">
    O usuário associado ao token precisa ter perfil **Agent** ou **Admin** — perfis Light Agent não têm acesso à API.
  </Card>
</CardGroup>

***

## Variáveis de ambiente

Adicione as variáveis abaixo ao arquivo `.env` (veja o guia de [configuração local](/data-pipelines/local-development#2-configurar-variáveis-de-ambiente)):

| Variável            | Descrição                           | Exemplo                          |
| ------------------- | ----------------------------------- | -------------------------------- |
| `ZENDESK_SUBDOMAIN` | Subdomínio da sua conta Zendesk     | `acme` (para `acme.zendesk.com`) |
| `ZENDESK_EMAIL`     | E-mail do agente associado ao token | `dados@suaempresa.com`           |
| `ZENDESK_API_TOKEN` | Token de API do Zendesk             | `abc123...xyz`                   |

```bash theme={null}
ZENDESK_SUBDOMAIN=suaempresa
ZENDESK_EMAIL=seu@email.com
ZENDESK_API_TOKEN=seu_token_aqui
```

<Warning>
  Nunca comite o arquivo `.env` no repositório. Certifique-se que ele está listado no `.gitignore`.
</Warning>

***

## Como obter o API Token

<Steps>
  <Step title="Faça login no Zendesk">
    Acesse `https://suaempresa.zendesk.com` com um usuário com perfil **Agent** ou **Admin**.
  </Step>

  <Step title="Abra o Admin Center">
    Clique no ícone de engrenagem na barra lateral esquerda para abrir o **Admin Center**.
  </Step>

  <Step title="Navegue até Apps and Integrations → APIs → Zendesk API">
    No menu do Admin Center, acesse **Apps and Integrations → APIs → Zendesk API**.
  </Step>

  <Step title="Acesse a aba Settings">
    Na página da Zendesk API, clique na aba **Settings**.
  </Step>

  <Step title="Ative Token Access">
    Habilite a opção **Token Access**. Se já estiver ativa, pule esta etapa.
  </Step>

  <Step title="Crie o token">
    Clique em **Add API token**, dê um nome descritivo (ex: `strattum-data`) e confirme.

    <Warning>
      O token é exibido **apenas uma vez**. Copie-o agora e salve em local seguro antes de fechar a janela.
    </Warning>
  </Step>
</Steps>

Após copiar o token, adicione-o ao `.env` e reinicie o worker se ele estiver em execução.

***

## Dados extraídos

| Recurso         | Incremental | Campo de cursor | Descrição                                            |
| --------------- | ----------- | --------------- | ---------------------------------------------------- |
| `tickets`       | Sim         | `updated_at`    | Todos os tickets e suas atualizações                 |
| `users`         | Sim         | `updated_at`    | Agentes, clientes finais e administradores           |
| `organizations` | Não         | —               | Organizações cadastradas (full refresh a cada ciclo) |

<Tip>
  Os dados ingeridos ficam disponíveis no **Data Catalog** com linhagem registrada automaticamente — sem nenhuma configuração adicional.
</Tip>

***

## Próximos passos

<CardGroup cols={2}>
  <Card title="Guia de desenvolvimento local" icon="terminal" href="/data-pipelines/local-development">
    Configure o ambiente local completo com Prefect, worker e Docker Compose.
  </Card>

  <Card title="Quickstart — Data Pipelines" icon="rocket" href="/data-pipelines/quickstart">
    Ative conectores via Console strattum.ai sem precisar de ambiente local.
  </Card>
</CardGroup>