Zendesk Events API擴充功能概述

Zendesk 是客戶服務解決方案與銷售工具。 Zendesk 事件轉送 擴充功能可運用 Zendesk Events API 將事件從Adobe Experience Platform Edge Network傳送到Zendesk進行進一步處理。 您可以使用擴充功能來收集客戶設定檔互動,以用於下游分析和動作。

本文介紹如何在UI中安裝和設定擴充功能。

先決條件

您必須擁有Zendesk帳戶才能使用此擴充功能。 您可以在以下網址註冊Zendesk帳戶: Zendesk網站.

您也必須為您的Zendesk設定收集以下詳細資訊:

金鑰型別
說明
範例
子網域
在註冊程式中, 子網域 是專屬於該帳戶所建立。 請參閱 Zendesk檔案 以取得詳細資訊。
xxxxx.zendesk.com (其中 xxxxx 是在建立帳戶期間提供的值)
API權杖
Zendesk使用持有人權杖作為驗證機制,與Zendesk API通訊。 登入Zendesk入口網站後,產生API權杖。 請參閱 Zendesk檔案 以取得詳細資訊。
cwWyOtHAv12w4dhpiulfe9BdZFTz3OKaTSzn2QvV

最後,您必須為API權杖建立事件轉送密碼。 將密碼型別設為 Token,並將值設為您從Zendesk設定收集的API權杖。 請參閱以下檔案: 事件轉送中的秘密 以取得有關設定密碼的詳細資訊。

安裝擴充功能 install

若要在UI中安裝Zendesk擴充功能,請導覽至 事件轉送 並選取要新增擴充功能的屬性,或改為建立新屬性。

選取或建立所需的屬性後,導覽至 擴充功能 > 目錄. 搜尋"Zendesk",然後選取 Install 在Zendesk Extension上。

在UI中選取之Zendesk擴充功能的安裝按鈕

設定擴充功能 configure

IMPORTANT
根據您的實作需求,您可能需要在設定擴充功能前建立結構、資料元素和資料集。 開始之前,請先檢閱所有設定步驟,以決定您需要為使用案例設定的實體。

選取 擴充功能 ,位於左側導覽器中。 在 已安裝,選取 設定 在Zendesk擴充功能上。

在UI中選取之Zendesk擴充功能的設定按鈕

Zendesk網域,請輸入您Zendesk子網域的值。 在 Zendesk權杖,選取您先前建立且包含API權杖的密碼。

設定選項已在UI中填寫

設定事件轉送規則

開始建立新的事件轉送規則 規則 並視需要設定其條件。 選取規則的動作時,選取 Zendesk 擴充功能,然後選取 建立事件 動作型別。

定義規則

設定動作設定時,系統會提示您為將傳送至Zendesk的各種屬性指派資料元素。

定義動作設定

這些資料元素應對應,如下所示。

event 金鑰

event 是JSON物件,代表使用者觸發的事件。 請參閱Zendesk檔案,位於 事件剖析 以取得擷取之屬性的詳細資訊, event 物件。

下列索引鍵可在 event 物件對應至資料元素時:

event key
類型
平台路徑
說明
強制
限制
source
字串
arc.event.xdm._extconndev.event_source
傳送事件的應用程式。
不要使用 Zendesk 作為值,因為這是Zendesk標準事件的受保護來源名稱。 嘗試使用它將會導致錯誤。
值長度不得超過40個字元。
type
字串
arc.event.xdm._extconndev.event_type
事件型別的名稱。 您可以使用此欄位來表示特定來源的不同型別事件。 例如,您可以為使用者登入建立一個事件集,並為購物車建立另一個事件集。
值長度不得超過40個字元。
description
字串
arc.event.xdm._extconndev.description
事件的說明。
(不適用)
created_at
字串
arc.event.xdm.timestamp
反映事件建立時間的ISO-8601時間戳記。
(不適用)
properties
物件
arc.event.xdm._extconndev.EventProperties
包含事件詳細資料的自訂JSON物件。
(不適用)
NOTE
請參閱 Zendesk Events API 檔案 以取得事件屬性的其他指引。

profile 金鑰

profile 是JSON物件,代表觸發事件的使用者。 請參閱Zendesk檔案,位於 個人資料剖析 以取得擷取之屬性的詳細資訊, profile 物件。

下列索引鍵可在 profile 物件對應至資料元素時:

profile key
類型
平台路徑
說明
強制
限制
source
字串
arc.event.xdm._extconndev.profile_source
與設定檔相關聯的產品或服務,例如 SupportCompanyName,或 Chat.
(不適用)
type
字串
arc.event.xdm._extconndev.profile_type
設定檔型別的名稱。 您可以使用此欄位為特定來源建立不同型別的設定檔。 例如,您可以為客戶建立一組公司設定檔,為員工建立另一組公司設定檔。
設定檔型別長度不得超過40個字元。
name
字串
arc.event.xdm._extconndev.name
個人資料中的人員名稱
(不適用)
user_id
字串
arc.event.xdm._extconndev.user_id
此人在Zendesk中的使用者ID。
(不適用)
identifiers
陣列
arc.event.xdm._extconndev.identifiers
包含至少一個識別碼的陣列。 每個識別碼都包含型別和值。
請參閱 Zendesk檔案 有關詳細資訊,請參閱 identifiers 陣列。 所有欄位和值都必須是唯一的。
attributes
物件
arc.event.xdm._extconndev.attrbutes
包含使用者定義之個人相關屬性的物件。
請參閱 Zendesk檔案 以取得設定檔屬性的詳細資訊。

驗證Zendesk中的資料 validate

如果事件收集和Adobe Experience Platform整合成功,則Zendesk主控台中的事件應會顯示如下。 這表示整合成功。

設定檔:

Zendesk設定檔頁面

事件:

Zendesk事件頁面

請求限制 limits

根據帳戶型別,Zendesk Events API 可處理下列每分鐘要求數:

Account Type
每分鐘要求數
Team
250
Growth
250
Professional
500
Enterprise
750
Enterprise Plus
1000

請參閱 Zendesk檔案 以取得這些限制的詳細資訊。

錯誤與疑難排解 errors-and-troubleshooting

使用或設定擴充功能時,Zendesk Events API可能會傳回下列錯誤:

錯誤碼
說明
解決方法
範例
400
無效的設定檔長度: 當設定檔屬性的長度包含超過40個字元時,就會發生此錯誤。
設定檔屬性資料的長度上限為40個字元。
{"error": [{"code":"InvalidProfileTypeLength","title": "Profile type length > 40 chars"}]}
401
找不到路由: 當提供了無效的網域時,就會發生這個錯誤。
請確認已提供下列格式的有效網域: {subdomain}.zendesk.com
{"error": [{"description": "No route found for host {subdomain}.zendesk.com","title": "RouteNotFound"}]}
401
驗證無效或遺失: 當存取權杖無效、遺失或過期時,就會發生此錯誤。
確認存取權杖有效且尚未過期。
{"error": [{"code":"MissingOrInvalidAuthentication","title": "Invalid or Missing Authentication"}]}
403
許可權不足: 當沒有提供存取資源的足夠許可權時,就會發生此錯誤。
驗證是否已提供所需的許可權。
{"error": [{"code":"PermissionDenied","title": "Insufficient permisssions to perform operation"}]}
429
太多請求: 當超過端點物件記錄限制時,會發生此錯誤。
請參閱以上章節: 請求限制 以取得每個限制臨界值的詳細資訊。
{"error": [{"code":"TooManyRequests","title": "Too Many Requests"}]}

後續步驟

本檔案說明如何在UI中安裝和設定Zendesk事件轉送擴充功能。 如需在Zendesk中收集事件資料的詳細資訊,請參閱官方檔案:

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743