| 字段名称 |
描述 |
限制以及数据类型 |
| 名称 |
指定webhook名称。 |
字母数字 (100) |
| 说明 | 为webhook添加说明。 |
200个字符 |
| 方法 |
选择API方法类型 - POST, GET, PUT, 以及DELETE。
注意:系统默认POST方法。 |
选择列表 |
|
URL通知
|
指定第三方应用程序的REST API URL。
|
300个字符
|
|
授权类型
|
选择所需授权类型 - 常规 ( 包含 API密钥或AUTH令牌) 以及连接器 (OAuth, API密钥等)
|
单选按钮
|
|
连接器
|
如果选择连接器,可以从列表中选择适当的连接器。
注意:连接器选项将只列出现有的连接。可以选择已存在连接或创建新的连接。
如果添加新连接,点击刷新按钮,下拉列表中将显示新添加的连接。
|
单选按钮
|
| 模块 |
选择Zoho CRM的一个模块。 支持的模块:
注意:不能为通话记录或备注添加webhooks。 |
选择列表 |
| 标题 | 注意:URL 参数- 一个URL由Zoho CRM与其它应用间的触发信息组成。webhook中的URL常分为标题和正文。 添加到标题部分的参数有与其他应用程序标题同步的数据。除了触发信息外,标题可以携带API密钥/授权令牌。要形成标题URL参数,请选择模块参数和/或自定义参数。 |
标题限制:一个webhook最多可以容纳10个标题URL参数。 |
| 模块参数 | 指定参数名称、参数类型和相应的参数值。添加多个参数来构建字符串。这种格式是动态的,CRM提供了从选择列表中选择字段值的选项。 参数类型包括:
|
- |
|
自定义参数
|
为webhook指定CRM参数名称和相应的值。名称和值是配置的因为自定义参数的值是静态的。这个key/值主要用于发送Auth令牌、安全令牌、API密钥等。
|
|
|
正文
|
URL的主体部分包含URL字符串中关于触发其他应用程序的信息。您可以从选择列表中选择使用表单数据或原始数据,来配置URL的主体部分。 表单数据:创建URL的主体部分,只需将参数名称和参数类型或参数值加在一起即可。可通过三种方式创建表单-模块参数,自定义参数,以及用户定义的格式。 用户定义的格式:指定参数名称和参数值。这种格式也是动态的,能够使用#号从插入合并字段选项中选择数值的类型。 原始数据:除了组成参数外,如果选择原始数据作为主体类型,还可以在文本编辑器中写出自己的数据值。可用以下任意格式输入数据,XML,JSON,HTML,或文本。也可以使用#合并字段来表示脚本中的字段值。
|
原始数据限制:在原始数据文本编辑框里,一个webhook 可最多容纳15000个字符。
|
| 预览URL |
预览URL显示GET和DELETE请求方式的完整Webhook URL,而对于POST和PUT方式,只显示配置的URL。
要预览URL,点击文本编辑器底部是刷新图标,也可以复制URL。
|
只读 |
设置Webhook包括下列三个步骤:
如需创建 Webhook
有时候可能在webhook说明值编辑器中使用的合并字段值现在显示为 ${Unsupported_Field}。 以下是可能的原因:
您插入数值的合并字段被删除。 如果您的 webhook说明值编辑器继续包含已删除字段的合并字段值,该值将显示为 ${Unsupported_Field}。
您插入数值的自定义查找字段被删除。 如果您的 webhook 值说明编辑器继续包含已删除查找字段的合并字段值,该值将显示为 ${Unsupported_Field}。
如果您为所选模块使用了不再可用合并字段列表中某字段的合并字段值,则它将显示为 ${Unsupported_Field}。
例如,如果您在线索模块的${Leads.Lead Id}值说明编辑器中插入合并字段值,其将显示为不支持的字段。
某个功能或集成被禁用于您的账户时,作为集成其中一部分创建的字段在取消激活后对账户也不可用。 如果此字段的合并字段值被插入值说明编辑器,它将显示为${Unsupported_Field}。 适用于下列功能/集成。
如需将 Webhook 与工作流规则关联
如需测试 Webhook 集成
在Zoho CRM中关闭一个商机时,在Zoho Creator App中计算销售佣金。
销售经理和工资团队可以使用销售佣金应用程序,依据公司预定义的公式计算销售代表的薪酬,(例如,完成的合同或销售金额的 2%)。此应用程序帮助您在计算销售代表佣金时减少手动输入,尽量减少错误,节省时间。此外,销售代表也可以追踪他们的每月佣金。
在 Zoho Creator 中,创建使用下列字段的销售佣金应用程序:

如需在 Zoho Creator 中创建应用程序,请参考在线帮助
从商机模块中选择下列字段,同时设置用户定义参数:
在 Webhook 中,指定下列详细信息:
URL通知:
用户定义参数(XML 或 JSON)

注意:
自定义参数:
| 参数 |
说明 |
| authtoken* |
从您的 Creator 账户更改验证令牌。 参考Creator 帮助了解更多详细信息。 |
| zc_ownername* |
指定您的 Creator 账户的应用程序所有者姓名。 |
在工作流规则页面执行这些步骤:
发送 SMS 警报给客户和销售代表。
客户的一笔付款今天到期。 您可以通过在工作流规则中将 Webhook 与基于时间的操作关联来发送有付款到期日、客户姓名和金额详细信息的 SMS 给您的销售代表。
在您的 SMS 网关服务中,创建账户并获取此等详细信息来配置 webhook:
目前 Zoho 与下列 SMS 网关提供商合作:
您可以从上述供货商处购买 SMS 信用凭证和 API 详细信息。
从线索模块中选择下列字段,同时设置用户定义参数:
在 Webhook 中,指定下列详细信息:
通知目标 URL:
用户定义参数(XML 或 JSON)

注意
在工作流规则页面执行这些步骤:
Webhook 执行失败时,Zoho CRM 中将显示下列错误消息之一:
Zoho CRM 提供图示,显示不同功能中 Webhook 每日或每周的使用数据。 您可以从设置 > 自动化> 操作>Webhook 查看警报使用。