Resumo
Nesta documentação, abordaremos:
- Habilitar as configurações de sincronização do Zendesk no Discourse
- Configurar um webhook do Zendesk
- Configurar um gatilho (trigger) do Zendesk
Habilitando as configurações de sincronização do Zendesk
Para começar, você precisará habilitar o plugin do Zendesk, ativar a configuração de sincronização e fornecer um token seguro.
- Navegar para as Configurações do Plugin: Vá para o seu site Discourse e navegue até a página de configurações do plugin do Zendesk em
/admin/plugins/discourse-zendesk-plugin. Alternativamente, você pode encontrar as configurações pesquisando em/admin/site_settings. - Habilitar o Plugin: Encontre e ative a configuração
zendesk enabledse ela ainda não estiver ativada. - Habilitar Configuração de Sincronização: Encontre e ative a configuração
sync comments from zendesk. - Fornecer Token do Webhook: No campo
zendesk incoming webhook token, gere e adicione uma string segura aleatória. Este token será usado posteriormente para configurar o webhook do Zendesk. - Configurar Categorias de Autogeração: A sincronização bidirecional funciona apenas para tópicos em categorias configuradas para a autogeração de tíquetes do Zendesk. Ative
zendesk autogenerate all categoriesou adicione categorias específicas à configuraçãozendesk autogenerate categories. Sem isso, o webhook ignorará silenciosamente os comentários recebidos.
Configurando um webhook do Zendesk
Siga estas etapas para configurar um webhook no Zendesk:
- Acessar a Página de Webhooks: Navegue até a seção Webhooks no Zendesk em Apps and integrations (Aplicativos e integrações) → Webhooks.
- URL de exemplo:
https://<instance_name>.zendesk.com/admin/apps-integrations/webhooks/webhooks
- URL de exemplo:
- Criar um Webhook:
- Clique no botão Actions (Ações) no canto superior direito.
- Selecione Create Webhook (Criar Webhook).
- Preencha os detalhes do webhook:
- Request method (Método de requisição):
PUT - Endpoint URL (URL do Endpoint):
https://<discourse.example.com>/zendesk-plugin/sync - Request format (Formato da requisição): JSON
- Request method (Método de requisição):
- Testar o Webhook:
- Clique no botão Test Webhook (Testar Webhook).
- Selecione ‘Custom Test’ (Teste Personalizado) no menu suspenso.
- Substitua o JSON pelo seguinte, inserindo seu token:
{
"ticket_id": "{{ticket.id}}",
"topic_id": "{{ticket.external_id}}",
"email": "{{current_user.email}}",
"token": "INSERT TOKEN HERE"
}
- Pressione Send Test (Enviar Teste). Espere um
400 Bad Requestcomo um sinal positivo com a página HTML exibida indicando sucesso.
Configurando um gatilho (trigger) do Zendesk
Configure um gatilho no Zendesk para automatizar ações:
- Acessar a Página de Gatilhos: Vá para a seção Triggers (Gatilhos) no Zendesk em Admin (Administrador) → Objects and Rules (Objetos e Regras) → Business Rules (Regras de Negócio) → Triggers.
- URL de exemplo:
https://<instance_name>.zendesk.com/admin/objects-rules/rules/triggers
- URL de exemplo:
- Criar um Gatilho:
- Clique em Add trigger (Adicionar gatilho).
- Nomeie-o como “Discourse Sync” e defina a categoria como “Notifications” (Notificações).
- Configure as condições e ações conforme ilustrado abaixo.
- Use o mesmo corpo JSON da etapa de teste do webhook, substituindo novamente “INSERT TOKEN HERE” pelo seu token.
- Salvar o Gatilho: Após a configuração, certifique-se de salvar o gatilho.
No entanto, há um problema quando um comentário no Zendesk contém um anexo — a mensagem está chegando, mas o anexo está faltando. Não tenho certeza se há um parâmetro adicional que precisa ser passado no webhook para lidar com anexos. Alguém poderia esclarecer se há algum parâmetro específico necessário para isso?
