文档 API参考

了解Zendesk集成服务亚博

亚博Zendesk集成服务(ZIS)是一组简化Zendesk集成构建和运行的服务。这可以包括Zendesk和外部系统之间的数据同步，为Zendesk应用程序提供后端(业务逻辑亚博)，或者触发另一个系统中的自动化工作流。

与ZIS集成提供以下好处:

  • 开发集成的更快、更容易的过程
  • 减少了对外部托管中间件的需求，从而减少了管理托管集成的基础设施的成本和工作量
  • 利用ZIS平台推出时的新特性和增强功能
  • 提供跨不同集成的通用用户体验

子服务

ZIS的核心是一个工作流运行器。它监听一个系统中的事件，并通过在另一个系统中采取行动进行响应。事件驱动的数据流可以是双向的，从Zendesk到外部系统，反之亦然。亚博

ZIS提供以下服务来支持此功能:

  • ZIS注册服务:创建集成，存储工作流定义和其他亚博电脑端为了你的整合
  • ZIS Connections Service:获取、存储和管理Zendesk和第三方服务的API凭据亚博
  • ZIS配置服务:为您的集成存储特定于用户的配置数据
  • ZIS链接服务:存储实体之间的关系。示例:对于与Jira同步数据的集成，ZIS Links存储Jira issue和Zendesk ticket之间的链接。亚博指子的链接
  • ZIS入站Webhooks服务:从外部系统触发ZIS中的工作流

了解ZIS Bundle和资源亚博电脑端

ZIS资亚博电脑端源包括子流，子的行为,JobSpecs。它们是基于zis的集成的基本组件。

ZIS包是集成中使用的ZIS资源的声明。亚博电脑端当将一个包上传到ZIS Registry Service时，就部署了集成。看到解剖一个ZIS束了解更多信息。

子流

ZIS Flow对象将数据流背后的逻辑描述为状态机结构。它是用JSON定义的，并且基于亚马逊州语言。

流定义了许多步骤以及执行这些步骤的顺序。它允许像条件一样的流控制，并提供在两者之间传递数据的能力州。

下面的例子展示了一个运行单个操作的基本流程:

             

              
“example_flow”：｛“类型”：“子:流”，“属性”：｛“名称”：“example_flow”，“定义”：｛“StartAt”：“example_state”，“州”：｛“example_state”：｛“类型”：“行动”，“ActionName”：“子:example_integration:行动:example_action”，“结束”：真正的｝｝｝｝｝

流超时

流只能运行100秒的设定持续时间。如果流的运行时间超过此持续时间，则流将被终止。流中的所有状态都遵守此超时。如果流在操作或等待状态中途超时，它将提前终止。

流动状态转移极限

ZIS流的执行最多可以经历250个状态转换。如果您的流包含使用的循环，则需要注意这一点州地图。

子的行为

动作是HTTP请求的包装器。ZIS包括一些内置操作，例如向ZIS配置服务添加数据或执行简单的数据转换。它们可以从流中引用，而不必在bundle中定义为单独的资源。看到ZIS内置动作。

您还可以定义自己的自定义操作来执行ZIS内置操作未提供的任务。例如，向第三方系统(如Slack或Shopify)的公共api发出请求，或向我们内置操作未涵盖的Zendesk api发出请求。亚博自定义操作还可以用于调用API调用集成开发人员托管的函数，从而创建“外部操作”。看到ZIS自定义动作。

JobSpecs

Job Spec对象告诉ZIS要监听哪个触发事件，以及在该事件发生时运行哪个流。它指定事件的事件源和事件类型，以及该事件发生时触发的流。例子:

             

              
“example_jobspec”：｛“类型”：“子::JobSpec”，“属性”：｛“名称”：“example_job_spec”，“event_source”：“支持”，“event_type”：”票。TicketCreated”，“flow_name”：“子:example_integration:流:example_flow”｝｝

每个作业规范定义了一个事件和一个流之间的关系。要将多个事件类型与同一流关联，需要创建多个作业规范。

要了解可以触发流的事件类型，请参见触发ZIS流。

触发ZIS流

ZIS中的流是由事件触发的，这些事件是发生某事的近实时通知。例如，一个用户已经被创建，一个票据的状态已经改变，一个自定义对象已经被删除，或者一个webhook已经从外部系统收到。事件有三种类型:

  • 原生Zende亚博sk事件:原生Zendesk事件自动发布到ZIS。看到触发事件参考。
  • 第三方事件:第三方事件的触发机制是ZIS入站Webhook服务，您可以将其配置为侦听来自外部系统的事件。看到ZIS入站Webhooks API。
  • 自定义Zend亚博esk事件:您可以创建一个亚博Zendesk webhook指向一个ZIS入站Webhook。然后，您可以将Zendesk webhook连接到亚博亚博Zendesk触发或自动化。此设置允许您基于Zendesk中的自定义事件调用ZIS流。亚博您还可以使用此设置在原生Zendesk事件到达ZIS之前过滤它们。亚博

至少一次交付

亚博Zendesk事件被设计为对每个操作至少触发一次。但是，单个操作可以多次触发相同的事件。这可能导致同一个操作多次运行ZIS流。例如，设计用于发布新票证的Slack消息的ZIS集成可能会为同一个票证创建事件发布多个消息。

异步执行

ZIS流由事件队列异步触发。触发流所需的时间根据此事件队列的大小而变化。在大多数情况下，流在触发事件后的几秒钟内启动。然而，在繁忙时期，可能需要几分钟。

事件的突然增加或大量正在进行的事件流可能会延迟ZIS流的开始。如果流中存在错误，则在ZIS重新尝试流时可能会导致延迟。

避免延误

在构建和测试新的ZIS集成时，我们建议您逐渐增加触发事件的数量。这可以帮助您检测可能导致大量事件延迟的错误。

我们建议您在进行数据迁移、批量导入或其他大规模更改之前禁用ZIS集成。这可以帮助你避免延误，并保持在内部使用限制。要禁用ZIS集成，请参见禁用集成。

作为禁用ZIS集成的替代方法，您可以更新它们以跳过或忽略导入的数据。例如，您可以在批量导入期间添加的任何票据上包含特定标记。你可以添加选择状态到任何与票据相关的ZIS流，以忽略带有此标记的票据。

与ZIS的集成是如何工作的

下图是如何使用ZIS进行集成操作的示例:

  • 事件从Zendesk产品或外部系统接收亚博
  • 选定的事件导致流运行。流由一个一系列的状态它们表示需要执行的业务逻辑。
  • 这些状态可以利用来自其他ZIS服务的信息，如客户配置设置、对象关系和API凭证。

连接

连接存储服务或系统(如Slack、Shopify或Zendesk)的凭据。亚博可以使用连接对ZIS流中的API请求进行身份验证。连接作为资源存储在ZIS连接服务中。亚博电脑端

有关更多信息，请参见理解连接。