Este guia apresenta o passo a passo para obter os dados corretamente para fazermos a integração da IA no Zendesk chat.
⚠️ Importante: durante o processo, você deverá anotar algumas informações (IDs e códigos) e enviá-las para nossa equipe ao final.
1. Criar marca no Zendesk
Se necessário, crie uma nova marca dentro do Zendesk:
-
Acesse: Conta → Gerenciamento de marca → Marcas
-
Clique em Criar nova marca
⚠️ Importante: cada marca permite apenas um Web Widget. Caso já exista um ativo, será necessário criar uma nova marca.
2. Criar Web Widget
Para habilitar a comunicação com os usuários:
-
Acesse: Canais → Mensagens → Adicionar canal
-
Selecione Web Widget
-
Associe à marca criada
Após criar o widget
O Zendesk irá mostrar um código HTML parecido com este:
<script id="ze-snippet" src="https://static.zdassets.com/ekr/snippet.js?key=XXXX"></script>
📌 Ação obrigatória:
Copie o código HTML disponibilizado pois terá que nos enviar junto com os outros dados.
3. Criar integração de conversas
Agora será necessário configurar a integração responsável pela troca de dados:
-
Acesse: Aplicativos → Integrações → Integrações de Conversas
-
Clique em Criar Integração
Preencha as informações:
-
Nome: Defina um nome para a integração (Exemplo: Openclick-Sunshine)
-
Webhook: (fornecido pela nossa equipe)
Ative as seguintes opções:
-
Incluir usuário completo
-
Incluir origem completa
Em eventos (assinaturas de webhook), selecione todos os itens abaixo, como:
-
Participante entrou na conversa
-
Participante saiu da conversa
-
Conversa criada
-
Mensagem da conversa
-
Conversa lida
-
Digitação do usuário
📌 Ação obrigatória:
Após salvar, copie os identificadores:
-
ID do aplicativo (App ID)
-
ID da integração (Integration ID)
-
ID do webhook (Webhook ID)
-
Segredo compartilhado (Shared secret)
4. Gerar chave de API da integração
Para autenticação da integração:
-
Acesse a integração criada no passo anterior
-
Vá até a aba Chaves da API
-
Clique em Criar chave
Ação obrigatória:
Após salvar, copie os identificadores:
-
ID da chave (Key ID)
-
Chave secreta (Secret key)
Esses dados serão utilizados na configuração do agente de IA.
5. Criar a API de Conversas
-
Acesse Aplicativos e integrações → APIs → API de conversas
-
Clique em Criar chave de API
-
Nome: Defina um nome para a integração (Exemplo: Openclick-Sunshine)
📌 Ação obrigatória:
Após clicar em seguinte, copie os identificadores:
-
ID da chave (Key ID)
-
Chave secreta (Secret key)
⚠️ Importante: A Chave secreta (Secret key) é exibida uma única vez.
6. Envie os dados
Nos envie todos os dados anotados para que possamos realizar a configuração.