データパイプラインソースとしてのZendeskの設定 ​

チケット、ユーザー、組織、および関連するサポートデータを宛先に抽出するため、Zendesk Supportをデータパイプラインソースとして設定します。 このガイドを使用して、認証の設定、コネクションの作成、パイプラインの設定、オブジェクトの追加、同期動作の確認、および既知の制限の理解を行います。

サポートされている機能 ​

Zendeskをパイプラインソースとして使用する場合、次の機能がサポートされます:

• OAuth 2.0認証: OAuth 2.0ベアラートークンを使用して接続します。 詳細については、サポートされているコネクションタイプを参照してください。
• フルリフレッシュと増分同期: 増分同期では、利用可能な場合にZendeskのIncremental Exports APIを使用し、オブジェクトに応じてカーソルベースまたは時間ベースのページネーションを使用します。 詳細については、同期モードを参照してください。
• 論理削除の追跡: サポート対象オブジェクトの削除を検出し、削除されたレコードを宛先でマークします。 オブジェクトのリストについては、削除追跡を参照してください。
• 動的カスタムフィールド: チケット、ユーザー、組織で定義されたカスタムフィールドを検出し、型指定された宛先列として同期します。
• スキーマドリフトの検出と処理: 新しいフィールドを自動同期でスキーマの変更を自動的に検出して適用するか、新しいフィールドをブロックでスキーマを固定します。
• フィールドレベルのデータ保護: 機密フィールドをそのままレプリケートするか、宛先に到達する前にハッシュ化します。
• 構成可能な同期頻度: 時間ベースの間隔またはcron式を使用して同期をスケジュールします。

前提条件 ​

Zendeskをデータパイプラインソースとして接続する前に、次の要件を満たしてください:

• Zendesk Supportアカウント。
• Zendeskテナントのサブドメイン。 たとえば、https://acme.zendesk.comでサインインする場合、サブドメインはacmeです。
• 同期するデータの読み取り権限を持つZendeskユーザーアカウント。

サポートされるコネクションタイプ ​

Zendeskデータパイプラインは、readスコープを使用したOAuth 2.0認証をサポートしています。 設定手順については、Zendeskへの接続を参照してください。

Zendeskへの接続 ​

ZendeskコネクターではOAuth 2.0認証を使用します。

WorkatoでZendeskに接続するには、次の手順を実行します:

パイプラインの設定 ​

Zendeskをデータパイプラインソースとして設定するには、次の手順を実行します:

[minute] [hour] [day of month] [month] [day of week]

0 8 * * *

サポートされるオブジェクト ​

Zendeskデータパイプラインは、Zendesk SupportおよびHelp Center REST APIからデータを同期します。 次の表は、サポートされているオブジェクトをカテゴリ別に示しています。 各オブジェクトは、宛先内の個別のテーブルとして同期されます。

チケットとチケット履歴 ​

ユーザーと組織 ​

設定とビジネスルール ​

Enterprise限定オブジェクト ​

次のオブジェクトは、Zendesk Enterpriseプランでのみ同期されます。 接続済みアカウントにアクセス権がない場合、Workatoはこれらのオブジェクトを省略します:

Help Center ​

次のオブジェクトは、ZendeskアカウントでHelp Centerが有効になっている場合にのみ同期されます:

同期モード ​

Zendeskデータパイプラインは、フルリフレッシュと増分同期をサポートしています。 同期モードは、パイプラインに追加するときにオブジェクトごとに設定されます。

完全更新 ​

フルリフレッシュ同期では、選択したオブジェクトについてZendeskから利用可能なすべてのレコードを読み取り、宛先テーブルを上書きします。 実行ごとに完全なスナップショットが必要な設定オブジェクトと参照オブジェクトには、フルリフレッシュを使用します。

増分同期 ​

増分同期では、前回の正常な実行以降に追加または変更されたレコードのみを抽出します。 Workatoは、利用可能な場合にZendeskのIncremental Exports APIを使用し、専用の増分エンドポイントを公開していないオブジェクトについては、時間枠付きのリストクエリまたは親から派生したカーソルにフォールバックします。

各オブジェクトの増分メカニズムを確認するには、サポートされているオブジェクトの表を参照してください。

削除追跡 ​

削除追跡をサポートするオブジェクトの場合、Workatoは削除されたレコードを削除するのではなく、宛先でマークします。 Workatoは、オブジェクトに応じて、次のネイティブフィールドを通じて削除を検出します:

削除追跡をサポートするオブジェクトを確認するには、サポートされているオブジェクトの表を参照してください。

削除されたチケットの保持 ​

Zendeskは、削除されたチケットを増分エクスポートで約120日間保持します。 最初の30日間、Zendeskはユーザー提供フィールドをスクラブし、チケットIDを保持します。 次の90日間は、最小限のデータのみが残ります。 120日後、WorkatoはZendesk APIから削除レコードを復元できません。

データ整合性の除外ウィンドウ ​

ZendeskのIncremental Exports APIは、データ整合性のため、過去60秒以内に更新されたレコードを除外します。 過去1分以内に更新されたレコードは、次回の実行まで増分同期の結果に表示されません。 Workatoはこの除外ウィンドウより前に同期カーソルを設定するため、次回の実行で以前に除外されたレコードをデータ損失なしで取得します。

スキーマとデータ型の処理 ​

Zendeskからデータを同期する場合、スキーマとデータ型には次の考慮事項が適用されます。

カスタムフィールド ​

Zendeskは、チケット、ユーザー、組織のカスタムフィールドをサポートしています。 Workatoは、コネクション設定時と各スキーマ更新時にカスタムフィールド定義を検出し、各カスタムフィールドを宛先の型指定された列として公開します。

Zendeskカスタムフィールド型は、次のように宛先の型にマッピングされます:

日付、日時、および数値のカスタムフィールド型は、提示された型に違反する可能性があるテナント制御の履歴値に対応するため、Stringにマッピングされます。 ソース型は、宛先列のメタデータとして保持されます。

タイムスタンプ ​

ほとんどのZendeskタイムスタンプは、UTCのISO 8601文字列です（例: 2024-01-15T10:30:00Z）。 Workatoは、これらの値を宛先でタイムゾーン付きタイムスタンプとして保持します。

ticketsのgenerated_timestampフィールドは、代わりにUnixエポック秒を使用します。 Zendeskは、この内部システムタイムスタンプを使用して、増分エクスポート内のチケットを並べ替えます。

ネストされたフィールド ​

Zendeskは、チケットのvia.channelなど、多くのリソースでネストされたオブジェクトを返します。 Workatoは、パス形式の列名（例: via_channel）を使用して、ネストされたプリミティブフィールドをフラット化します。 配列、ポリモーフィックフィールド、およびより深いネストされたオブジェクトは、JSON文字列列として保存されます。

合成列 ​

Workatoは、宛先テーブルに次の合成列を追加します:

機密データの処理 ​

Zendesk Supportデータには、特にチケットの説明とコメントに大量のPIIが含まれる場合があります。 これらのフィールドには、名前、メールアドレス、電話番号、郵送先住所、アカウント番号など、自由記述の顧客メッセージに埋め込まれた非構造化PIIが頻繁に含まれます。 ユーザーおよび組織レコードには連絡先情報が含まれ、カスタムフィールドに機密値が含まれる場合があります。

パイプライン設定中にフィールドレベルのデータ保護でHashオプションを使用し、PIIが宛先に到達する前に保護します。 詳細については、パイプラインを構成手順を参照してください。

制限事項 ​

Zendeskをデータパイプラインソースとして使用する場合、次の制限が適用されます。

システム駆動のチケット更新 ​

Zendeskの増分チケットエクスポートには、自動クローズ、SLAターゲット更新、アーカイブなどのシステムプロセスによって更新されたチケットが含まれます。 これらのシステム更新により、ユーザーに表示される変更が発生していない場合でも、チケットがエクスポートに表示されます。 積極的な自動化ルールを持つアカウントでは、想定よりも多い更新量が発生する場合があります。

追加専用履歴オブジェクトは再同期できません ​

ticket_field_historyおよびticket_tag_historyオブジェクトは、ZendeskのチケットEvent streamsから派生した追加専用の監査ログです。 これらのオブジェクトを再同期しないでください。 ZendeskのEvent streamsには保持期間の制限があるため、再同期すると、保持期間を過ぎた履歴が失われる可能性があります。

組織メンバーシップ ​

organization_membershipsオブジェクトは増分同期をサポートしておらず、実行のたびに完全に再インポートされます。 このオブジェクトは他のオブジェクトより低い頻度でスケジュールするか、不要な場合はパイプラインから除外します。

大量の詳細トラバーサル ​

ticket_audits、ticket_form_history、およびuser_identitiesオブジェクトでは、親チケットまたはユーザーごとに1回以上のAPI呼び出しが必要です。 大規模アカウントでこれらのオブジェクトを初期同期する場合、完了までに何時間もかかることがあります。 Workatoは最後に完了した親から詳細トラバーサルを再開するため、中断された同期は停止した場所から続行されます。

標準チケットメトリックリストはアーカイブ済みチケットを除外します ​

ticket_metricsオブジェクトは、アーカイブ済みチケットを除外するZendeskの標準リストエンドポイントを通じて同期されます。 アーカイブ済みチケットのメトリックは利用できません。

サンドボックスのレート制限 ​

Zendeskサンドボックスアカウントのレート制限は、プロダクションアカウントより大幅に低くなります。 サンドボックスに対してパイプラインをテストする場合は、この点を考慮してください。