摘要
本文档将介绍：
- 在 Discourse 中启用 Zendesk 同步设置
- 配置 Zendesk Webhook
- 设置 Zendesk 触发器
启用 Zendesk 同步设置
首先，您需要启用 Zendesk 插件，启用同步设置，并提供一个安全的令牌（token）。
- 导航到插件设置: 访问您的 Discourse 站点并导航到 Zendesk 插件设置页面，路径为
/admin/plugins/discourse-zendesk-plugin。或者，您也可以在/admin/site_settings搜索找到设置。 - 启用插件: 查找并启用
zendesk enabled设置（如果尚未启用）。 - 启用同步设置: 查找并启用
sync comments from zendesk设置。 - 提供 Webhook 令牌: 在
zendesk incoming webhook token中生成并添加一个随机的安全字符串。此令牌稍后将用于配置 Zendesk 的 Webhook。 - 配置自动生成类别: 双向同步仅适用于已配置 Zendesk 工单自动生成的类别。请启用
zendesk autogenerate all categories，或将特定类别添加到zendesk autogenerate categories设置中。如果没有进行此配置，Webhook 将会静默忽略传入的评论。
设置 Zendesk Webhook
按照以下步骤在 Zendesk 中配置 Webhook：
- 访问 Webhooks 页面: 在 Zendesk 中，导航到 应用和集成 (Apps and integrations) → Webhook (Webhooks) 部分。
- 示例 URL:
https://<instance_name>.zendesk.com/admin/apps-integrations/webhooks/webhooks
- 示例 URL:
- 创建 Webhook:
- 点击右上角的 操作 (Actions) 按钮。
- 选择 创建 Webhook (Create Webhook)。
- 填写 Webhook 详细信息：
- 请求方法 (Request method):
PUT - 端点 URL (Endpoint URL):
https://<discourse.example.com>/zendesk-plugin/sync - 请求格式 (Request format): JSON
- 请求方法 (Request method):
- 测试 Webhook:
- 点击 测试 Webhook (Test Webhook) 按钮。
- 从下拉菜单中选择“自定义测试”(Custom Test)。
- 用以下内容替换 JSON，并插入您的令牌：
{
"ticket_id": "{{ticket.id}}",
"topic_id": "{{ticket.external_id}}",
"email": "{{current_user.email}}",
"token": "INSERT TOKEN HERE"
}
- 点击 发送测试 (Send Test)。预期会收到一个包含 HTML 页面指示成功的
400 Bad Request响应，这被视为积极信号。
设置 Zendesk 触发器
在 Zendesk 中配置一个触发器以实现操作自动化：
- 访问触发器页面: 在 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)。
- 按照下图所示配置条件和操作。
- 使用与测试 Webhook 步骤中相同的 JSON 正文，再次将“INSERT TOKEN HERE”替换为您的令牌。
- 保存触发器: 配置完成后，请确保保存触发器。
但是，当 Zendesk 中的评论包含附件时，会出现一个问题——消息已收到，但附件丢失了。我不确定是否需要通过 webhook 传递其他参数来处理附件。有人能澄清一下是否需要任何特定参数吗？
