> ## Documentation Index
> Fetch the complete documentation index at: https://docs.strattum.ai/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](https://docs.strattum.ai/data-pipelines/quickstart).

## 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

> **Conta Zendesk ativa**
>
> Acesso a uma instância Zendesk Support com login funcional.

> **Perfil Agent ou Admin**
>
> O usuário associado ao token precisa ter perfil **Agent** ou **Admin** — perfis Light Agent não têm acesso à API.

***

## Variáveis de ambiente

Adicione as variáveis abaixo ao arquivo `.env` (veja o guia de [configuração local](https://docs.strattum.ai/data-pipelines/local-development.md#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`.

***

## Como obter o API Token

**1. Faça login no Zendesk**

Acesse `https://suaempresa.zendesk.com` com um usuário com perfil **Agent** ou **Admin**.

**2. Abra o Admin Center**

Clique no ícone de engrenagem na barra lateral esquerda para abrir o **Admin Center**.

**3. Navegue até Apps and Integrations → APIs → Zendesk API**

No menu do Admin Center, acesse **Apps and Integrations → APIs → Zendesk API**.

**4. Acesse a aba Settings**

Na página da Zendesk API, clique na aba **Settings**.

**5. Ative Token Access**

Habilite a opção **Token Access**. Se já estiver ativa, pule esta etapa.

**6. 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.

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.

***

## Próximos passos

> **[Guia de desenvolvimento local](https://docs.strattum.ai/data-pipelines/local-development.md)**
>
> Configure o ambiente local completo com Prefect, worker e Docker Compose.

> **[Quickstart — Data Pipelines](https://docs.strattum.ai/data-pipelines/quickstart)**
>
> Ative conectores via Console strattum.ai sem precisar de ambiente local.


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