此参考信息描述了在与Zendesk集成服务(ZIS)构建集成时用于触发ZIS流的受支持的Zen亚博desk事件。

原生Zendesk事件类亚博型和通过入站webhook接收的自定义事件都可以在JobSpec对象中引用。然后将作业规范安装到将运行集成的Zendesk帐户上。亚博这告诉ZIS监听帐户上的特定事件类型。

当接收到正确类型的事件时,ZIS执行关联的流并将JSON对象传递到流的第一步。对象中包含有关事件特定更改的数据输入财产。可以在ZIS流中访问此属性.input美元参考路径

JSON对象还包括account_id子域名,integration_key属性。您可以在ZIS流中使用各自的.account_id美元.subdomain美元,.integration_key美元参考路径。

例子:

             
{“account_id”12345“integration_key”“my_integration_key”“子域名”“my_亚博zendesk_subdomain”“输入”{“ticket_event”{“元”{“序列”{“id”“C20565CD20591B5E81E2206E91ADFB2A”“位置”1“总”9}“版本”“1.0”“occurred_at”“2021 - 08 - 12 - t08:46:37z”“ref”“18 - 646602214”}“类型”“票”“票”{“assignee_id”313502247511“group_id”“优先”“紧急”“标签”“my_tag1”]“requester_id”323401287712“brand_id”32040676813“id”1001“状态”“新”“通过”{“通道”“网络”}“organization_id”361454622831“external_id”“41 ea202e1 - 123”“created_at”“2021 - 08 - 12 - t08:46:37z”“类型”“问题”“submitter_id”323401287712“updated_at”“2021 - 08 - 12 - t08:46:37z”“form_id”37201638591}}}}

顶级属性

事件包含以下顶级属性:

财产 数据类型 描述
account_id 整数 亚博Zendesk账户id
integration_key 字符串 从ZIS包检索的集成键
子域名 字符串 账户子域名
输入 对象 包含有关事件更改的信息

输入对象

输入对象内容取决于事件类型。它包含事件数据的JSON包装器。

亚博Zendesk域名事件 财产 内容
票事件 ticket_event 票事件
用户事件 user_event 用户事件
组织活动 organization_event 组织活动
自定义对象事件 custom_object_event 自定义对象事件
活动事件 activity_event 活动事件

每个域都有多个本机事件类型。每个本机事件类型在ZIS中都有一个关联的标记来触发流。

在通过入站webhook接收方接收用户定义事件的情况下,输入对象包含HTTP请求的主体。

至少一次交付

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

事件排序

单个动作可以触发一系列事件。例如,对票据的更新可能同时触发Comment Created和Status Changed事件。所有事件都包含输入。{event_domain} .meta.sequence对象。该对象包含有关事件顺序的信息。例如,票据事件包含对象input.ticket_event.meta.sequence财产。

输入。{event_domain} .meta.sequence对象包含以下属性:

财产 数据类型 描述
id 字符串 触发事件的动作Id。具有相同序列id的事件由相同的操作触发
位置 整数 事件在序列中的顺序。亚博Zendesk不保证这个订单
总计 整数 序列中的事件数

亚博Zendesk不保证序列id或序列位置的顺序。例如,序列id为“22222”的事件可能发生在序列id为“11111”的事件之前或之后。类似地,序列位置为“2”的事件可以发生在序列位置为“1”的事件之前或之后。Ticket Created事件不一定总是序列位置为“1”。不要使用序列id的顺序或序列位置作为集成业务逻辑的基础。

ZIS不保证事件的先进先出(FIFO)处理。ZIS可以无序地处理来自多个序列的事件。

在JobSpec中引用事件

在作业规范中引用事件来触发流。

例子:

             
“jobspec”{“类型”“子::JobSpec”“属性”{“名称”“example_job_spec”“event_source”“支持”“event_type””票。TicketCreated”“flow_name”“子:example_integration:流:example_flow”}}

要将Zendesk事件与流关联亚博,您可以指定event_source事件标签名称为event_type

亚博Zendesk事件 event_source event_type
票事件 支持 事件标签名称。看到票事件
用户事件 支持 事件标签名称。看到用户事件
组织活动 支持 事件标签名称。看到组织活动
自定义对象事件 阳光 事件标签名称。看到自定义对象事件
活动事件 阳光 事件标签名称。看到活动事件