Webhook 中的字段列表

  设置 Webhook

设置 Webhook 包括以下三个步骤：

• 创建 webhook。
• 将 Webhook 与工作流规则关联。
• 测试 webhook 集成。

若要创建 webhook

1. 点击 （设置 图标）> 设置 > 自动化 > 工作流自动化 > Webhook。
2. 在 Webhook 页面中，点击“配置 Webhook”。
3. 在新建 Webhook  页面中，指定所有必需的参数。
4. 点击“保存”。

 识别不受支持的合并字段值

有时候您可能会注意到，您在 webhook 的参数值说明编辑器中使用的合并字段值现在显示为 ${Unsupported_Field}。下面是发生这种情况的一些原因。

自定义字段已删除

您已插入其值的合并字段已删除。如果 webhook 的参数值说明编辑器继续包含已删除字段的合并字段值，则该值将显示为 ${Unsupported_Field}。

自定义查找字段已删除

您已插入其值的自定义查找字段已删除。如果 webhook 的参数值说明编辑器继续包含已删除查找字段的合并字段值，则该值将显示为 ${Unsupported_Field}。

字段未在可用合并字段列表中列出

如果您为所选模块使用了未包含在可用合并字段列表中的字段的值，那么它将显示为 ${Unsupported_Field}。

例如，如果您在“商机”模块的参数值说明编辑器中插入字段值 ${Candidates.Candidate Id}，则它将显示为不受支持的字段。

 若要将 Webhook 与工作流规则关联

1. 点击 （设置 图标）> 设置 > 自动化 > 工作流自动化
2. 在工作流规则 页面中，点击“创建规则”。
3. 在创建新规则 页面中，指定工作流规则参数。
4. 在工作流动作 下面，选择 webhook。
5. 在“调用 Webhook”弹出窗口中，选择所需的 webhook 并点击“关联”。
6. 点击“保存”。

 若要测试 webhook 集成

1. 根据您的工作流规则条件在 Recruit 中添加测试数据。
2. 在您的应用程序中，通过 webhook 通知检查从 Zoho Recruit 收到的数据。
3. 如果存在错误或数据不匹配，请在 Zoho Recruit 中修改您的 webhook 设置。
4. 继续此测试，直至您的应用程序从 Zoho Recruit 获得期望的数据。

  重要提示

• 您可为每个工作流规则关联最多 6 个（1 个即时操作和 5 个定时操作）Webhook。
• 您可以使用 webhook 从 Zoho Recruit 向第三方应用程序传输最多 10 个 Recruit 字段的数据。
• 您不能使用 webhook 将其它应用的数据获取到Zoho Recruit。
• 您必须依照第三方应用程序中的限制定期更新 API 工单。
• 如果由于第三方 API 中的任何问题导致 Webhook 集成停止工作，您将不会收到任何邮件通知。
• 在 webhook 中，使用 POST 方法，我们允许用户定义的格式最多有 10000 个字符。
• 如果在该过程中出现任何故障，Webhook 将先发送通知，Zoho Recruit 系统将在 15 分钟之后发送第二次通知。此后，系统将不会为该特定工作流触发发送任何 Webhook 通知。
• 如果您超过每天的最大计数，系统将不会向第三方应用程序发送剩余的 Webhook 通知，并将向管理员通知失败情况。
• 在“待通知的 URL”字段中，如果您想要指定端口号，请注意，我们仅支持 80 或 443 端口号。
• Zoho Recruit 让您可以在 Webhook 参数配置过程中选择所需的日期/日期时间格式和时区。
• Webhook 限制：
• 专业版 - 10000 次调用/天，或 100 次调用/用户许可（以较低者为准）。
• 企业版 - 20000 次调用/天，或 500 次调用/用户许可（以较低者为准）。

  业务场景

向面试官发送短信提醒。

 目的

通过短信通知面试官，面试已安排好。

 先决条件

• 短信网关服务中的帐户
• 访问工作流规则的权限

 程序

1. 在短信网关服务中创建帐户 
2. 在 Zoho Recruit 中配置 webhook 
3. 设置工作流规则 
4. 测试您的 webhook 集成 

 第 1 步：在短信网关服务中创建帐户

在您的短信网关服务中，创建一个帐户并获得这些详情以配置 webhook。

• 招聘人员
• 应聘者名称
• 商机金额
• 面试详情
• 面试计划时间

目前，Zoho 已与以下短信网关提供商合作：

• Twilio
• Clickatell 
• Screen Magic 
• Message Media

您可向上述供应商购买短信和获取 API 详情。

 第 2 步：配置 Webhook

在设置用户定义的参数时从“面试”模块选择以下字段：

• 短信网关的域名
• 用户名
• 身份验证令牌

在 Webhook 中，指定以下详情：

待通知的 URL：

1. http://<Domain Name>/smsgateway/post - POST 方法

用户定义的参数（XML 或 JSON）

 第 3 步：设置工作流规则

按照工作流规则页面中的以下步骤操作：

1. 为所有新面试创建工作流。
   • 输入新业务。
   • 阶段是已成交-赢得。
   • 选择成交日期。
2. 如上所述配置 Webhook。
3. 点击保存并关联
4. 保存工作流规则。

 第 4 步：测试您的集成

1. 添加包含所有已更新面试详情的测试面试记录。
2. 在您的手机中查收短信提醒。如果您未收到短信，请修改 webhook 配置并继续测试。在成功测试之后，删除测试项并将此集成展示给您的 Recruit 用户。

---

 请参阅错误代码

当 Webhook 执行失败时，会在 Zoho Recruit 中显示以下错误消息之一：

 HTTP 状态码

• 400 错误请求 - 通常是缺少必需的参数。
• 401 未经授权 - 未提供有效的身份验证令牌。
• 402 请求失败 - 参数有效，但请求失败。
• 404 未找到 - 请求的项不存在。
• 500, 502, 503, 504 服务器错误 - 第三方应用程序发生错误。
• 错误代码 1 - 暂时不能连接到 API 服务器。您需要为我们从 Recruit 发送的请求检查 API 服务器日志和防火墙设置。

 自定义错误

• 内部处理故障 - 当由于在处理 webhook 中出现错误而导致未执行 webhook 时。
• 达到日限制 - 当公司达到一天的最大限制时。