创建webhook

创建webhook

Webhook在每次CRM发生活动时发送即时在线通知,从而与第三方应用程序进行通信。通过Webhook,您可以配置 HTTP URL,并将其与工作流规则关联,以便实现整个通知流程自动化。如需关于 Webhook 的基本信息,请参考webhooks.org 。

场景
  • 在 Zoho Books 中关闭某个商机后,您可以推送客户信息到会计软件(例如Zoho Books)中,并自动为客户生成发票。
  • 您可以使用Zoho CRM的web表单,基于网站收集的线索或联系人,在电子邮件营销软件(如MailChimp)中向邮件列表添加订阅者。
  • 您可以为现场销售代表触发SMS提醒,关于客户会议、备忘录和其它活动。
  • 商机状态由观望转向报价时,可以在会计软件(例如 Zoho Books)中生成预估。
  • 在 Zoho CRM 中关闭某个交易之后,可以在 Zoho Creator内置的销售佣金应用程序中自动计算给销售代表的佣金。
目标受众
  • 有管理工作流权限的 CRM 用户
  • 有 REST API 技能的编程人员
可用性

所需权限
有管理工作流权限的用户可以使用此功能。

Webhook中的字段列表

字段名称
描述
限制以及数据类型
名称
指定webhook名称。
字母数字 (100)
说明为webhook添加说明。
200个字符
方法

选择API方法类型 - POST, GET,  PUT, 以及DELETE。

  • POST支持您在相关应用程序字段中输入数值。

  • GET支持您检索信息以更新Zoho CRM中记录的字段。

  • PUT更新相关应用程序中的现有值。

  • DELETE删除相关应用的现有值。

 

注意:系统默认POST方法。
选择列表
URL通知
指定第三方应用程序的REST API URL。
300个字符
授权类型
选择所需授权类型 -  常规 ( 包含 API密钥或AUTH令牌)  以及连接器 (OAuth, API密钥等)
单选按钮
连接器

如果选择连接器,可以从列表中选择适当的连接器。

 

注意:连接器选项将只列出现有的连接。可以选择已存在连接或创建新的连接

如果添加新连接,点击刷新按钮,下拉列表中将显示新添加的连接。
单选按钮
模块

选择Zoho CRM的一个模块。

支持的模块:

  • CRM的主要模块,例如线索,联系人,客户,商机等。
  • 任务,通话及会议模块。

注意:不能为通话记录或备注添加webhooks。

选择列表
标题

注意:URL 参数- 一个URL由Zoho CRM与其它应用间的触发信息组成。webhook中的URL常分为标题和正文。

添加到标题部分的参数有与其他应用程序标题同步的数据。除了触发信息外,标题可以携带API密钥/授权令牌。要形成标题URL参数,请选择模块参数和/或自定义参数

标题限制:一个webhook最多可以容纳10个标题URL参数。
模块参数

指定参数名称、参数类型和相应的参数值。添加多个参数来构建字符串。这种格式是动态的,CRM提供了从选择列表中选择字段值的选项。

参数类型包括:

  • CRM主要模块

  • 用户

  • 机构

-
自定义参数
为webhook指定CRM参数名称和相应的值。名称和值是配置的因为自定义参数的值是静态的。这个key/值主要用于发送Auth令牌、安全令牌、API密钥等。

正文

URL的主体部分包含URL字符串中关于触发其他应用程序的信息。您可以从选择列表中选择使用表单数据或原始数据,来配置URL的主体部分。

表单数据:创建URL的主体部分,只需将参数名称和参数类型或参数值加在一起即可。可通过三种方式创建表单-模块参数,自定义参数,以及用户定义的格式

用户定义的格式:指定参数名称和参数值。这种格式也是动态的,能够使用#号从插入合并字段选项中选择数值的类型。

原始数据:除了组成参数外,如果选择原始数据作为主体类型,还可以在文本编辑器中写出自己的数据值。可用以下任意格式输入数据,XML,JSON,HTML,或文本。也可以使用#合并字段来表示脚本中的字段值。

 


原始数据限制:在原始数据文本编辑框里,一个webhook 可最多容纳15000个字符。
预览URL
预览URL显示GETDELETE请求方式的完整Webhook URL,而对于POSTPUT方式,只显示配置的URL。
要预览URL,点击文本编辑器底部是刷新图标,也可以复制URL。
只读

设置Webhook

设置Webhook包括下列三个步骤:

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

如需创建 Webhook

  1. 点击设置 > 自动化 > 动作 > Webhook
  2. Webhooks 页面,点击创建Webhook
  3. 新建 Webhook 页面,指定所有必要的参数。
  4. 点击保存。

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

有时候可能在webhook说明值编辑器中使用的合并字段值现在显示为 ${Unsupported_Field}。 以下是可能的原因:

自定义字段被删除

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

自定义查找字段被删除

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

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

如果您为所选模块使用了不再可用合并字段列表中某字段的合并字段值,则它将显示为 ${Unsupported_Field}

例如,如果您在线索模块的${Leads.Lead Id}值说明编辑器中插入合并字段值,其将显示为不支持的字段。

集成/功能被禁用

某个功能或集成被禁用于您的账户时,作为集成其中一部分创建的字段在取消激活后对账户也不可用。 如果此字段的合并字段值被插入值说明编辑器,它将显示为${Unsupported_Field}。 适用于下列功能/集成。

  • Google AdWords 集成 - 不再可用的 Google AdWords 字段将不受支持。
  • 访客追踪(Zoho SalesIQ 集成): 不再可用的访客追踪字段将不受支持。
  • 区域管理 - 不再可用的字段将不受支持。
  • 多货币 - 曾被取消激活的货币将不受支持。

如需将 Webhook 与工作流规则关联

  1. 点击设置> 自动化>工作流规则
  2. 在 工作流规则 页面,点击新建规则。
  3. 在 新建规则  页面中,指定工作流规则参数。
  4. 在 工作流操作 下方,选择 webhook。
  5. 在调用 Webhook 弹出页面,选择所需的 Webhook 并点击关联。
  6. 点击保存

如需测试 Webhook 集成

  1. 根据您的工作流规则条件在 CRM 中添加测试数据。
  2. 通过 Webhook 通知在您的应用程序中检查从Zoho CRM收到的数据。
  3. 如果发生错误或数据不匹配,在Zoho CRM中修改您的Webhook设置。
  4. 继续这一测试,直至您从Zoho CRM获取所需数据到您的应用程序中。

重要注意事项

  • 您可以为每条工作流规则关联最多 6 个(1 个即时操作和 5 个基于时间的操作)Webhook。
  • 您可以利用Webhook最多从10个Zoho CRM字段中传输数据至第三方应用程序。
  • 不可以使用Webhook从其它应用检索Zoho CRM的数据。
  • 您必须依据第三方应用程序中的限制定期更新 API 许可。
  • 如果Webhook集成因为第三方 API 中的任何问题停止运行,您不会收到邮件通知。
  • 在Webhook中,允许最多 10000 个字符用于用户定义格式,同时使用 POST 方法。
  • 如果这一过程中有任何故障,Webhook会先发送通知,Zoho CRM会在 15 分钟后发送第二次通知。之后,系统不会因为特定的工作流触发发送任何Webhook通知。
  • 如果您超过了每天的最大限制,系统不会将剩余的Webhook通知发送给第三方应用程序,而会将故障告知管理员。
  • URL通知字段中,如果您想要指定端口,请注意仅支持80 或 443端口号。
  • 您可在Webhook参数配置期间选择所需的日期/日期时间格式和时区
  • Webhook的限制:
    • 高级版 - 10000 次调用/天或 100 次调用/用户(以较低者为准)。
    • 旗舰版 - 100000 次调用/天或 500 次调用/用户(以较低者为准)。
    • 超级版 - 500000次调用/天或1000次调用/用户/天(以较低者为准)。 
业务场景 1

在Zoho CRM中关闭一个商机时,在Zoho Creator App中计算销售佣金。

目的

销售经理和工资团队可以使用销售佣金应用程序,依据公司预定义的公式计算销售代表的薪酬,(例如,完成的合同或销售金额的 2%)。此应用程序帮助您在计算销售代表佣金时减少手动输入,尽量减少错误,节省时间。此外,销售代表也可以追踪他们的每月佣金。

前提
  • Zoho Creator 应用程序中的账户
  • 访问 Zoho API 权限
  • 熟悉 Zoho Creator
步骤
  1. 在Zoho Creator中创建销售佣金应用程序(参考创建应用程序上的Zoho Creator教程)
  2. 在 Zoho CRM 中配置 Webhook
  3. 设置工作流规则
  4. 测试您的 Webhook 集成
步骤 1: 在 Zoho Creator 中创建销售佣金应用程序

在 Zoho Creator 中,创建使用下列字段的销售佣金应用程序:

  • 销售代表
  • 商机名称
  • 客户姓名
  • 机会金额
  • 业务类型: 新业务或现有业务
  • 结束日期
  • 销售佣金


如需在 Zoho Creator 中创建应用程序,请参考在线帮助

步骤 2: 配置 Webhook

从商机模块中选择下列字段,同时设置用户定义参数:

  • 商机名称
  • 预计成交日期
  • 类型
  • 记录所有者
  • 金额

在 Webhook 中,指定下列详细信息:

URL通知:

  1. https://creator.zoho.com.cn/api/xml/writePOST 方法

用户定义参数(XML 或 JSON)

  1. <ZohoCreator>
  2.     <applicationlist>
  3.         <application name='sales-commissions'>
  4.             <formlist>
  5.                 <form name='Commissions'>
  6.                     <add>
  7.                         <field name='Name'>
  8.                             <value> ${Potentials.Potential Name} </value>
  9.                         </field>
  10.                         <field name='Closed_Amount'>
  11.                             <value> ${Potentials.Amount} </value>
  12.                         </field>
  13.                         <field name='Closing_Date'>
  14.                             <value> ${Potentials.Closing Date} </value>
  15.                         </field>
  16.                         <field name='Customer_Name'>
  17.                             <value> ${Accounts.Account Name} </value>
  18.                         </field>
  19.                         <field name='Type_of_Business'>
  20.                             <value> ${Potentials.Type} </value>
  21.                         </field>
  22.                         <field name='Sales_Rep'>
  23.                          <value> ${Potentials.Potential Owner} </value></field>
  24.                     </add>
  25.                 </form>
  26.             </formlist>
  27.         </application>
  28.     </applicationlist>
  29. </ZohoCreator>

注意:

  • 在上述 XML 字符串中,姓名代表 Zoho Creator 应用程序中的字段和将从 Zoho CRM 推送的数据值。
  • <applicaton name> 是包含 Zoho Creator 中表单的应用程序名称。 从 Zoho Creator 应用程序设置选项卡中获取您的应用程序名称。
  • <form name> 是您在 Zoho Creator 中编辑记录的表单名称。 从Zoho Creator 账户表单设置中获取您的表单名称。
  • 确保 Creator 应用程序中的日期格式采用年-月-日格式。 您可以从您的 Zoho Creator 账户的应用程序设置中更改日期格式。

自定义参数:

参数
说明
authtoken*
从您的 Creator 账户更改验证令牌。 参考Creator 帮助了解更多详细信息。
zc_ownername*
指定您的 Creator 账户的应用程序所有者姓名。 

注意
如需检索从其它应用到 Zoho Creator 的数据,您必须指定 Zoho API 的用户名和验证令牌。 如需生成 Zoho API 信息,请参考在线帮助
步骤 3: 设置工作流规则

在工作流规则页面执行这些步骤:

  1. 设置工作流规则如下:
    • 类型为 新业务
    • 阶段为 赢单关闭
  2. 点击下一步

  1. 选择 Webhook 为即时操作。
  2. 调用 Webhook 弹出页面,从列表中选择所需的 Webhook 并点击关联
  3. 保存工作流规则。
将 Webhook 与工作流规则关联

步骤 4: 测试您的集成
  1. 在 CRM 中添加测试商机,类型和阶段字段分别为新业务和赢单关闭。 输入测试数据时,确保同时输入金额、日期、记录所有者、客户名称和商机名称。
  2. 在 Zoho Creator 中打开您的销售佣金应用程序,检查 CRM 数据。 
    如果您未收到任何数据,修改 Webhook 配置,继续测试。 测试成功后,删除测试条目,并将这一集成转出给您的 CRM 用户。
业务场景 2

发送 SMS 警报给客户和销售代表。

目的

客户的一笔付款今天到期。 您可以通过在工作流规则中将 Webhook 与基于时间的操作关联来发送有付款到期日、客户姓名和金额详细信息的 SMS 给您的销售代表。

前提
  • SMS 网关服务中的账户
  • 访问工作流规则的权限
步骤
  1. 在 SMS 网关服务中创建账户
  2. 在 Zoho CRM 中配置 Webhook
  3. 设置工作流规则
  4. 测试您的 Webhook 集成
步骤 1: 在 SMS 网关服务中创建账户

在您的 SMS 网关服务中,创建账户并获取此等详细信息来配置 webhook:

  • 销售代表
  • 商机名称
  • 客户姓名
  • 金额
  • 业务类型: 新业务
  • 阶段: 已结束并赢得客户
  • 付款到期日(自定义字段)

目前 Zoho 与下列 SMS 网关提供商合作:

您可以从上述供货商处购买 SMS 信用凭证和 API 详细信息。

步骤 2: 配置 Webhook

从线索模块中选择下列字段,同时设置用户定义参数:

  • SMS 网关的域名
  • 用户姓名
  • 验证令牌

在 Webhook 中,指定下列详细信息:

通知目标 URL:

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

用户定义参数(XML 或 JSON)

  1. <?xml version="1.0"?>
  2. <m:Library xmlns:m="http://www.screen-magic.com/ xmlns="http://www.defns.com/>
  3. <username>xxxx@xxxxx.com</username>
  4. <senderid>SMS-Provider</senderid>
  5. <accountid>XXXXXXX</accountid>
  6. <authtoken>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</authtoken>
  7. <message mobilenumber="${User.Mobile}">Hi ${User.Last Name}, Payment amount ${Potential.Amount} is due today from ${Account.Name}. Please contact ${Contact.Last Name} ASAP</message>
  8. </m:Library>

注意

  • 在上述 XML 字符串中,我们使用 Screen Magic 网关进行演示。

步骤 3: 设置工作流规则

在工作流规则页面执行这些步骤:

  1. 设置工作流规则如下:
    • 类型为 新业务
    • 阶段为 赢单关闭
    • 选择日期。
  2. 选择 Webhook 为基于时间的操作。
  3. 保存工作流规则。
工作流规则条件



将 Webhook 与工作流规则关联


步骤 4: 测试您的集成
  1. 在 CRM 中添加测试商机,类型和付款到期日期字段分别为现有业务和今天。输入测试数据时,确保同时输入金额、关闭日期、记录所有者、客户名称和商机名称。
  2. 在您的手机中检查 SMS 提醒
    如果您未收到 SMS,修改 Webhook 配置,继续测试。 测试成功后,删除测试条目,并将这一集成转出给您的 CRM 用户。
参考错误代码

Webhook 执行失败时,Zoho CRM 中将显示下列错误消息之一:

HTTP 状态代码
  • Bad Request - 可能缺失一个必填参数。
  • Unauthorized Request  - 提供了的身份验证令牌无效。
  • Request Failed - 参数有效,但请求失败。
  • Page not Found - 如果请求项不存在。
  • Third-party error - 由于第三方应用程序中的故障。
  • Third-party server not available - 在第三方API服务器上断开连接
  • Internal process failure - 如果处理webhook时出错。
  • Day limit reached - 如果机构已达到当天的最大限制。
  • Invalid URL - 如果该URL易受SSRF攻击或是无效的URL。
  • Socket timeout - 如果调用了webhook,但直到10秒才收到响应。
查看 Webhook 使用图

Zoho CRM 提供图示,显示不同功能中 Webhook 每日或每周的使用数据。 您可以从设置 > 自动化操作>Webhook 查看警报使用。

更多信息链接提供关于使用数据的详细信息。 请注意,该图示将涵盖过去 7 天的使用数据。




    • Related Articles

    • 创建工作流任务

      工作流任务是与工作流规则关联的动作之一。 任务是分配给用户的活动。 当您将工作流任务关联至工作流规则时,如果记录满足条件,触发规则,将自动分配给用户。 可用性 需要权限 角色中具有管理工作流权限的用户可以使用此功能。 如需创建工作流任务 点击设置 > 自动化 > 动作 >任务。 点击创建任务。 在 新建任务 页面,可进行以下操作: 从下拉列表中选择模块。 输入任务主题。 插入合并字段创建动态任务主题。 指定到期日期。 从下拉列表中选择任务状态。 从下拉列表中选择任务优先级。 ...
    • 在批准/拒绝后关联操作

      每个审批流程都可以关联一定操作,例如添加任务、更新字段、发送邮件提醒、调用webhook 等,这些操作可以在记录得到审批或拒绝后执行。 当您设置涉及多个用户审批记录的多个审批阶段时,您可以在每次审批后分配任务,也可以更新字段。 邮件提醒、webhook和自定义函数仅在最后一次审批后才能触发。 拒绝后的操作不包括上述五项。无法在拒绝后分配任务。分配任务 选项用于为下一个需要审批记录的用户设置任务。 这个任务最好是检查等待他们审批的记录。如果记录被拒绝,则不需要分配任务。 指派任务 ...