CRM 帮助

Webhooks

如何进行..。up

Webhook允许您通过发送活动即时通知与第三方应用通信。 使用Webhooks ，您可以配置HTTP URL，并把它们与工作流规则相关联， 自动完成整个通知的过程。 欲了解Webhooks ，请参阅 webhooks.org。

场景

  • 在ZohoCRM里关闭某个商机后，您可以立即在客户支持软件使用 REST API启用客户门户访问（例如： Zoho Support)。
  • 在ZohoCRM里关闭某个商机后，您可以把客户信息推送到会计软件（例如： Zoho Books) 并自动生成发票给客户。
  • 基于从您的网站使用ZohoCRM的web表单收集的线索或联系人，您可以添加用户到电子邮件营销软件的邮件列表里（如： MailChimp）。
  • 您可以触发短信提醒给销售代表，提醒他们有客户会议、演示和其他活动。
  • 商机的阶段一旦更改为报价阶段您就可以立即在会计软件（例如： Zoho Books）里生成一个报价单。
  • 在ZohoCRM里关闭某个商机后，您可以在用 Zoho Creator创建的销售佣金应用中自动计算给销售代表的佣金。

目标群体

  • 有工作流管理权限的CRM用户
  • 有REST API技能的程序员

可用版本及所需权限

版本 企业版 专业版 免费版
是 否 否
Webhooks / WFR 6
1 - 即时操作
每个定时操作1个
（总共5个定时操作）		 - -
总通知数 / 天 2500 或 50 / 用户
（以较低者为准）		 - -
所需权限 管理工作流

WFR -工作流规则

Webhook中的字段列表

字段名称 描述 数据类型 最大限度
名称 指定webhook名称。 文本 字母数字（50个）
描述 添加webhook的说明。 文本 200 个字符
通知URL 指定第三方应用的REST API URL。 URL 200 个字符
方法 选择API方法的类型 - POST或GET。默认情况下，系统会选择POST方法。 单选按钮 -
模块

选择一个ZohoCRM模块。

支持的模块：

  • CRM的主要模块，如线索，客户，联系人，商机等。
  • 活动和任务

备注: 通话日志和备注模块不能创建webhooks。

 选择列表 -
附加实体参数

指定参数的名称和相应的参数值。 这是触发webhook对第三方应用程序的通知时发送的请求参数。

支持的模块：

  • CRM主模块
  • 用户
  • 机构
 字符串 3000 个字符
附加自定义参数                    为webhook指定CRM参数的名称和相应的值.  这也是触发webhook时发送的请求参数。名称和值如配置。 这个key/值对主要用于发送验证令牌，安全令牌等。 字符串 -
预览URL 预览完整的通知第三方应用webhook的URL。 文本 只读

设置 Webhooks

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

  • 创建一个webhook。
  • 关联webhook到工作流规则。
  • 测试webhook集成。

创建webhook

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

关联webhook到工作流规则

  1. 点击 设置 > 自动化 > 工作流规则。
  2. 在 工作流规则页面，点击 创建工作流规则。
  3. 在 工作流规则页面， 指定工作流规则参数。
  4. 在工作流操作部分，选择要触发的webhooks。
  5. 点击 保存。

测试webhook集成

  1. 根据您的工作流规则条件在CRM中添加测试数据。
  2. 在您的应用中查看从ZohoCRM通过webhook通知收到的数据。
  3. 如果有错误或数据不匹配，请修改您的webhook设置。
  4. 继续测试，直到在您的应用从ZohoCRM获得所需的数据。

重要提醒

  • 每个工作流规则最多可关联6个 webhooks（1个即时操作，5个定时操作）。
  • 使用webhook您可以将最多10个CRM字段的数据从ZohoCRM推送到第三方应用程序。
  • 使用webhook您不能将数据从其它应用程序中推送到ZohoCRM。
  • 根据第三方应用程序的限制，您必须定期更新API ticKet。
  • 如果由于第三方API的问题导致Webhook集成不可用，您将不会收到任何电子邮件通知。
  • 如果出现错误，Webhook会先发送一个通知，15分钟后，ZohoCRM系统会发出第二次通知。 此后，触发该工作流系统将不发送任何Webhook通知。
  • 如果超出了每一天的最大限制数，系统将不会发送剩余的Webhook通知给第三方应用，但会向管理员报错。 
  • Zoho CRM 会以下面的标准格式发送日期 和日期时间 字段数据给第三方应用程序：
    • 日期: yyyy-MM-dd
    • 日期时间: yyyy-MM-dd hh:mm

业务场景 1

在Zoho CRM里关闭商机后，用Zoho Creator应用计算销售佣金。

目的

销售经理和工资团队可以使用销售提成应用程序，根据您机构预定义的公式集为您的销售代表来计算佣金（例如，合同价或销售金额的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/api/xml/write - POST 方法

用户定义的参数（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>Em
  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>
  24.                     </add>
  25.                 </form>
  26.             </formlist>
  27.         </application>
  28.     </applicationlist>
  29. </ZohoCreator>

备注

  • 在上面的XML字符串中， name表示Zoho Creator应用中的字段，其数据值要从Zoho CRM推送。

自定义参数：

  1. https://creator.zoho.com/api/xml/write?XMLString=<XMLSTRING>&apikey=XXXXXXXXXXXX&ticket=XXXXXXXXXXX&zc_ownername=XXXXX

备注

  • 要从其他应用程序提取数据到Zoho Creator，您必须指定 Zoho API用户名，API Ticket和API Key。关于如何生成Zoho API，请参阅 在线帮助

步骤3: 设置工作流规则

在工作流规则页面执行以下步骤：

  1. 设置工作流标准为：
    • 类型是 新业务
    • 阶段是成交
  2. 选择 webhook为即时操作。
  3. 保存工作流规则。

工作流规则条件

关联Webhook到工作流规则

步骤4: 测试您的集成

  1. 在CRM里添加一个测试商机，类型和阶段字段分别为新业务和成交。输入测试数据时，确保金额，收盘数据，记录所有者，帐号名称和商机名称都填写上。
  2. 在Zoho Creator里开放销售佣金应用，检查CRM数据。 
    如果还没有收到任何数据，请修改webhook配置后继续进行测试。 测试成功后，请删除测试项目，并将此集成对您的CRM用户开放。

业务场景 2

发送短信提醒给客户和销售代表。

目的

有客户付款今天到期。您可以关联webhook 到工作流规则定时操作，以便发送短信给您的销售代表，提醒付款到期日，客户名称，和金额等详细信息。 /p>

前提条件

  • SMS网关服务帐号
  • 工作流规则访问权限

操作流程

  1. 创建SMS网关服务帐号
  2. 在Zoho CRM里配置webhook
  3. 设置工作流规则
  4. 测试您的webhook集成

步骤 1: 创建SMS网关服务帐号

在您的SMS网关服务中，创建一个帐号，获取以下信息以配置webhook:

  • 销售代表
  • 商机名称
  • 客户名称
  • 商机金额
  • 业务类型：新业务
  • 阶段：成交
  • 截止日期（自定义字段）

步骤 2: 配置Webhook

设置用户定义参数时选择线索模块以下字段：

  • SMS网关的IP地址
  • 用户名
  • API key

在Webhook中，指定以下细节：
通知URL:

  1. http://<IP Address>/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. <apikey>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</apikey>
  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. 在您的手机上检查短信提醒
    如果还没有收到短信提醒，请修改webhook配置后继续进行测试。 测试成功后，请删除测试项目，并将此集成对您的CRM用户开放。

参考错误代码

当执行webhook失败，Zoho CRM会显示以下错误消息:

HTTP 状态代码

  • 400 错误请求 -往往缺少必要的参数。
  • 401未授权 - API key无效。
  • 402 请求失败- 参数是有效的，但请求失败。
  • 404 未找到 - 请求的项目不存在。
  • 500, 502, 503, 504 服务器错误 - 第三方应用程序出了问题。

自定义错误

  • 内部流程错误 - webhook处理出错，webhook未执行。
  • 达到每日限额 - 公司达到每日限额。

 

Next TopicPrevious Topic

返回顶部

© 2014. Zoho Corporation Pvt. Ltd. 保留所有权利.