What's my plan?
Suite Team, Growth, Professional, Enterprise, or Enterprise Plus
Support Team, Professional, or Enterprise
位置:管理中心 > 应用和整合 > 操作和 Webhook > Webhook

Webhook 是从 Zendesk管理中心的 Webhook 页面 创建 和管理的。

您必须是管理员或具有权限的自 定义用户角色 中的专员才能管理 Webhook。

本文章涵盖以下主题:
  • 编辑和管理 Webhook
  • 查看 Webhook 的活动
  • 调试 Webhook

编辑和管理 Webhook

在大多数情况下,管理员可以编辑、复制、取消激活和删除 Webhook。但是,根据应用要求创建的 Webhook 可以编辑,但不能复制或删除。根据应用要求创建的 Webhook 可以由应用开发者更新,并覆盖帐户管理员所做的更改。Webhook 创建后,您无法更改其连接方法。

编辑 Webhook 的步骤

  1. 在管理中心,单击侧栏中的应用和整合 (),然后选择操作和 Webhook > Webhook。
  2. 在列表中找到该 Webhook,单击选项菜单图标 (),然后单击 编辑。
  3. 根据需要修改 Webhook。

    所有字段都可以编辑。但是,使用身份验证时, 密钥、 密钥或 密码 在创建或更新 Webhook 后无法查看。要移除自定义标头,单击删除图标 ()。

  4. (可选) 测试 您对 Webhook 所做的更改。
  5. 单击保存。

复制 Webhook 的步骤

  1. 在管理中心,单击侧栏中的应用和整合 (),然后选择操作和 Webhook > Webhook。
  2. 在列表中找到该 Webhook,单击选项菜单图标 (),然后单击 复制。
  3. 编辑 Webhook 的 名称 ,并根据需要修改 Webhook。
  4. 单击更新。

取消激活 Webhook 的步骤

  1. 在管理中心,单击侧栏中的应用和整合 (),然后选择操作和 Webhook > Webhook。
  2. 在列表中找到该 Webhook,单击选项菜单图标 (),然后单击 取消激活。
  3. 在确认对话框中,单击 取消激活。

删除 Webhook 的步骤

  1. 在管理中心,单击侧栏中的应用和整合 (),然后选择操作和 Webhook > Webhook。
  2. 在列表中找到该 Webhook,单击选项菜单图标 (),然后单击 删除。
  3. 单击删除。

查看 Webhook 的活动

每个 Webhook 都有一个活动日志。除了详细的调用记录之外,您还可以查看最近 7 天内的请求数。

如果端点返回某些 HTTP 响应代码,Webhook 调用会自动重试最多 3 次。有关重试场景的更多信息和示例,请参阅我们开发者文档中的 Webhook 重试逻辑 。

Zendesk 会尽力单次向 Webhook 发送操作。但我们无法对此保证。同一操作可能会多次调用 Webhook,或者在某些情况下,例如 Webhook 断路器 被触发时,可能根本不会发送操作。要检测重复的调用,您可以使用 Webhook 签名。如果这对您的工作流程产生问题,请确保您的 Webhook 生成的操作是幂等的。

  1. 在管理中心,单击侧栏中的应用和整合 (),然后选择操作和 Webhook > Webhook。
  2. 在列表中找到该 Webhook,单击选项菜单图标 (),然后单击 查看详情。
  3. 单击活动标签。
  4. 单击 筛选 以按开始日期、开始时间、结束日期、结束时间或状态筛选活动日志,然后单击 应用筛选。

调试 Webhook

如果 Webhook 无法正常工作,失败的调用将显示在 Webhook 的活动日志中。您可以按状态 “失败” 或特定类型的错误筛选活动日志。在活动标签中,您还可以单击调用 ID,以查看 Webhook 特定调用的请求和响应。

在大多数情况下,响应来自接收 Webhook 请求的第三方服务,而不是 Zendesk 本身。通常需要使用此服务来修复错误。

您可以使用响应状态中的数字代码来诊断问题。这些响应状态代码是 HTTP 请求的标准响应状态代码。有关标准 HTTP 响应状态代码及其含义的列表,请参阅 MDN 网络文档中的 HTTP 响应状态代码 。

注意:如果服务使用自定义 HTTP 响应状态代码,您可能需要查阅其文档。

Webhook 请求有 10 秒钟的超时。“失败:“504 网关超时”响应状态表示服务在此超时期限内未响应 Webhook 的请求。超时期限不可调整。

翻译免责声明:本文章使用自动翻译软件翻译,以便您了解基本内容。 我们已采取合理措施提供准确翻译,但不保证翻译准确性

如对翻译准确性有任何疑问,请以文章的英语版本为准。

由 Zendesk 提供技术支持