目的

Webhook 是用户定义的 HTTP 回调函数。换句话说，它是经由 HTTP 发布的简单事件通知。在特定事件发生时，它将通过发布一条消息来通知 URL。也就是说，每当用户对 Zoho People 机构帐户数据执行操作时，它会通过发送即时通知来与第三方应用程序通信。Webhook 非常有用、灵活且完全可定制。我们还提供了一系列失败和成功的 webhook 来让您更好地理解错误消息。

Webhook 的好处

• 灵活且可定制
• 向第三方应用程序发送即时通知
• 用户可集成其自有的自定义应用程序或任何第三方应用程序
• 实时数据同步
• 提供 Webhook 列表、失败和成功的 Webhook

Webhook 的类型

• Webhook 列表：使用 Zoho People webhook，每当用户对机构帐户数据执行操作时，您可通过发送即时通知来与第三方应用程序通信。
  
• 失败的 Webhook：此页上列出了失败的 webhook 以及其 webhook 名称、表单名、关联记录、最后调用时间、重新执行操作和响应消息等详细信息。您还可使用表单、webhook 名称和持续时期等选项来过滤 webhook。
  
• 成功的 Webhook：此页上列出了成功的 webhook 以及其 webhook 名称、表单名、关联记录、最后调用时间和响应消息等详细信息。您还可使用表单、webhook 名称和持续时期等选项来过滤 webhook。
  

什么是 API？

Zoho People 提供了 API（应用程序编程接口）以用于将人力资源模块与第三方应用程序集成。利用 Zoho People API，您可提取 XML 或 JSON 格式的员工数据和表单数据，还可开发新应用程序或与现有业务应用程序集成。由于 Zoho People API 不依赖于编程语言，您可使用任何编程语言（Java、.Net、C、C++、PHP 等）来开发应用程序。要了解更多信息，请点击此处。

Webhook 中的字段

字段名称	描述	数据类型	最大限制
名称	指定 webhook 的名称。	文本	字母数字 (50)
描述	添加 webhook 的描述。	文本	250 个字符
待通知的 URL	指定第三方应用程序或 Zoho 应用程序（例如：Zoho People、Zoho Creator）的 API URL。	URL	250 个字符
方法	选择 API 方法的类型 - POST 或 GET。POST 是默认选择的方法。	单选按钮	-
模块	选择待传达到第三方应用程序的数据所在的“表单”。	选择列表	-
附加实体参数	指定参数名和对应的参数值。这是在触发第三方应用程序的 webhook 通知时发送的请求参数。	字符串	3000 个字符
附加自定义参数	为 webhook 指定 Zoho People 参数名和对应值。这也是在触发 webhook 时发送的请求参数。根据配置确定名称和值。这个键/值对主要用于发送身份验证令牌、安全令牌等。	字符串	-
预览 URL	预览待通知给第三方应用程序的 webhook URL。	文本	只读

Webhook 配置

Webhook 的配置简易明了。您只需要配置 HTTP URL 并将它们与工作流规则关联以使工作流过程自动化。请按照下面的步骤配置 webhook。

1. 以管理员身份登录。
2. 转至页面顶部的设置。
3. 单击自动化下面的 Webhook。
4. 单击新建 Webhook。
5. 为 Webhook 命名。
6. 添加描述
7. 指定待通知的第三方 URL。
8. 选择 API 方法类型：POST 或 GET。
9. 从列表中选择表单名或模块
10. 指定参数名和对应的参数值。您只可添加 10 个实体字段作为参数 <和/或> 以用户定义的格式指定参数。例如：XML、JSON 等，<和/或> 指定自定义参数名称和参数值。您只可以添加 5 个自定义参数。
11. 单击保存。

示例情景

通过 Webhook 更改离职表单中的员工状态

我们来看一下这个场景 - 一位员工正在辞职，而您希望在员工表单中将状态更改为已辞职。在引入 Webhook 之前，您需要在员工表单和离职表单中手动更新更改两次。而现在，您可使用 API 来配置 Webhook，从而在离职表单中自动发布通知。请按照下面的步骤为此情景配置 Webhook。

1. 以管理员身份登录。
2. 转至页面顶部的设置
3. 单击自动化下面的 Webhook
4. 单击新建 Webhook
5. 为 Webhook 命名。
6. 添加描述
7. 指定待通知的 URL。
   

   https://people.zoho.com.cn/people/api/forms/P_Separation/insertRecord

8. 选择 API 方法类型：POST。
9. 从列表中选择表单名称员工。
10. 针对用户定义格式，指定参数名 xmlData 和值描述，如下所示。
    
    • <Request>
    • <Record>
    • <field name="Employee_ID">${ZOHO_LINK_ID}</field>
    • <field name="Interviewer">${Reporting_To}</field>
    • <field name="Separation_date">${Exit_Date}</field>
    • </Record>
    • </Request>
11. 指定自定义参数：在“参数名”中输入 authtoken，在“参数值”中输入 authtoken key。
12. 单击保存。
    

    注：

    • 在上述 XML 字符串中，标记字段表示 Zoho People 中的字段，名称表示字段的标签名称，值标记表示要推送的数据。

自定义参数

https://people.zoho.com.cn/people/api/forms//insertRecord ?authtoken=XXXXXXXXXXXX&xmlData=<xmlData>