Краткое описание
В этой документации мы рассмотрим:
- Включение настроек синхронизации Zendesk в Discourse
- Настройку вебхука Zendesk
- Создание триггера Zendesk
Включение настроек синхронизации Zendesk
Для начала вам нужно включить плагин Zendesk, активировать настройку синхронизации и предоставить безопасный токен.
- Переход к настройкам плагина: Зайдите на ваш сайт Discourse и перейдите на страницу настроек плагина Zendesk по адресу
/admin/plugins/discourse-zendesk-plugin. Альтернативно, вы можете найти настройки, выполнив поиск на странице/admin/site_settings. - Включение плагина: Найдите и включите настройку
zendesk enabled, если она ещё не активна. - Включение настройки синхронизации: Найдите и включите настройку
sync comments from zendesk. - Указание токена вебхука: В поле
zendesk incoming webhook tokenсгенерируйте и добавьте случайную безопасную строку. Этот токен будет использоваться позже при настройке вебхука Zendesk. - Настройка категорий для автогенерации: Двусторонняя синхронизация работает только для тем в категориях, настроенных для автоматической генерации тикетов Zendesk. Либо включите
zendesk autogenerate all categories, либо добавьте конкретные категории в настройкуzendesk autogenerate categories. Без этого вебхук будет молча игнорировать входящие комментарии.
Настройка вебхука Zendesk
Следуйте этим шагам для настройки вебхука в Zendesk:
- Переход к странице вебхуков: Перейдите в раздел Webhooks в Zendesk в меню Apps and integrations → Webhooks.
- Пример URL:
https://<instance_name>.zendesk.com/admin/apps-integrations/webhooks/webhooks
- Пример URL:
- Создание вебхука:
- Нажмите кнопку Actions в правом верхнем углу.
- Выберите Create Webhook.
- Заполните данные вебхука:
- Request method:
PUT - Endpoint URL:
https://<discourse.example.com>/zendesk-plugin/sync - Request format: JSON
- Request method:
- Тестирование вебхука:
- Нажмите кнопку Test Webhook.
- В выпадающем списке выберите ‘Custom Test’.
- Замените JSON следующим содержимым, вставив ваш токен:
{
"ticket_id": "{{ticket.id}}",
"topic_id": "{{ticket.external_id}}",
"email": "{{current_user.email}}",
"token": "INSERT TOKEN HERE"
}
- Нажмите Send Test. Ожидайте ответ
400 Bad Requestкак положительный сигнал: на экране должна отобразиться HTML-страница, указывающая на успех.
Настройка триггера Zendesk
Настройте триггер в Zendesk для автоматизации действий:
- Переход к странице триггеров: Перейдите в раздел Triggers в Zendesk в меню Admin → Objects and Rules → Business Rules → Triggers.
- Пример URL:
https://<instance_name>.zendesk.com/admin/objects-rules/rules/triggers
- Пример URL:
- Создание триггера:
- Нажмите Add trigger.
- Назовите его “Discourse Sync” и установите категорию “Notifications”.
- Настройте условия и действия, как показано ниже.
- Используйте то же тело JSON, что и на шаге тестирования вебхука, снова заменив “INSERT TOKEN HERE” на ваш токен.
- Сохранение триггера: После настройки обязательно сохраните триггер.
However, there’s an issue when a comment in Zendesk contains an attachment—the message is coming through, but the attachment is missing. I’m not sure if there’s an additional parameter that needs to be passed in the webhook to handle attachments. Could someone please clarify if there are any specific parameters required for this?
