Zendesk

統合バージョン: 6.0

Chronicle SOAR と連携するように Zendesk を構成する

管理者が API トークンを生成するには、次の手順に従います。

Zendesk インターフェースのサイドバーに移動し、[管理者] アイコンをクリックし、[Channels] > [API] を選択します。

  1. [設定] タブをクリックし、トークン アクセスを有効にします
  2. [アクティブ　API　トークン] の右側にある [+] ボタンをクリックします。
  3. 必要に応じて、[API トークンの説明] に説明を入力します。
  4. 後で使用するためにトークンをコピーし、安全な場所に貼り付けます。ウィンドウを閉じると、完全なトークンが再び表示されることはありません。
  5. [保存] をクリックして、API ページに戻ります。

Chronicle SOAR で Zendesk 統合を構成する

Chronicle SOAR で統合を構成する方法について詳しくは、統合を構成するをご覧ください。

アクション

チケットにコメントを追加する

説明

既存のチケットにコメントを追加します。

パラメータ

パラメータ 種類 デフォルト値 説明
チケット ID 文字列 なし チケット番号。
コメントの本文 文字列 なし なし
著者の名前 文字列 なし なし
内部メモ ブール値 なし なし

ユースケース

なし

実行

このアクションはすべてのエンティティに対して実行されます。

アクションの結果

エンティティ拡充

なし

分析情報

なし

スクリプトの結果
スクリプトの結果名 値のオプション 例
is_success True/False is_success:False
JSON の結果
N/A

チケットにマクロを適用する

説明

チケットにマクロを適用します。

パラメータ

パラメータ 種類 デフォルト値 説明
チケット ID 文字列 なし チケット番号。
マクロのタイトル 文字列 なし なし

ユースケース

なし

実行

このアクションはすべてのエンティティに対して実行されます。

アクションの結果

エンティティ拡充

なし

分析情報

なし

スクリプトの結果
スクリプトの結果名 値のオプション 例
is_applied True/False is_applied:False
JSON の結果
N/A

チケットを作成

説明

特定のプロパティを持つチケットを作成します。

既知の制限事項

Unicode 文字を含むメールは、Zendesk API ではサポートされていません。これは「Email CC」パラメータに影響します。アクションで無視されます

パラメータ

パラメータ 種類 デフォルト値 説明
件名 文字列 なし なし
説明 文字列 なし なし
割り当てユーザー 文字列 なし ユーザーの姓名。
割り当てグループ 文字列 なし グループ名。
優先度 文字列 なし 優先度は、緊急、高、標準、低のいずれかです。
チケットのタイプ 文字列 なし 優先度は、緊急、高、標準、低のいずれかです。
タグ 文字列 なし なし
内部メモ チェックボックス オフ コメントを公開にするか、内部にするかを指定します。オフの場合は公開され、オンの場合は内部専用になります。
メールの CC 宛先 CSV なし メールアドレスのカンマ区切りのリストを指定します。これにより、チケット作成の通知も受信します。注: 最大 48 件のメールの CC を追加できます。これは Zendesk の制限です。
メールの CC を検証する ブール値 オン 有効になっている場合、「Email CCs」パラメータで指定されたメールアドレスのユーザーが存在するかどうかが確認されます。ユーザーが 1 人も存在しない場合、操作は失敗します。このパラメータが無効になっている場合、アクションではこのチェックが実行されません。

ユースケース

なし

実行

このアクションはすべてのエンティティに対して実行されます。

アクションの結果

エンティティ拡充

なし

分析情報

なし

スクリプトの結果
スクリプトの結果名 値のオプション 例
ticket_id なし なし
JSON の結果
N/A
ケースウォール
結果のタイプ 値 / 説明 タイプ
出力メッセージ *

「メールの CC を検証」が有効で、1 つ以上のメールが見つからない（失敗）: アクション「{アクション名}」の実行中にエラーが発生しました。理由: 次のメールアドレスのユーザーが見つかりませんでした: {entity.identifier}。スペルを確認するか、「メールの CC を検証」パラメータを無効にしてください。

少なくとも 1 つの入力が有効な電子メール・アドレスでない場合 アクション「{action name}」の実行中にエラーが発生しました。理由: 次のメールアドレスのユーザーが見つかりませんでした: {entity.identifier}。スペルを確認するか、「メールの CC を検証」パラメータを無効にしてください。

 一般

チケットの詳細を取得する

説明

チケット ID ごとに、チケットの詳細、コメント、添付ファイルを取得します。

パラメータ

パラメータ 種類 デフォルト値 説明
チケット ID 文字列 なし チケットの ID。

ユースケース

なし

実行

このアクションはすべてのエンティティに対して実行されます。

アクションの結果

エンティティ拡充

なし

分析情報

なし

スクリプトの結果
スクリプトの結果名 値のオプション 例
ticket_details なし なし
JSON の結果
{
   "Details":
      {
        "ticket":
           {
             "follower_ids": [],
             "via":
               {
                     "source":
                           {"to": {},
                            "from": {},
                            "rel": "None"},
                    "channel": "web"
                },
              "updated_at": "2019-02-03T10:08:00Z",
              "submitter_id": 360638872459,
              "assignee_id": 360638872459,
              "brand_id": 360000159559,
              "id": 2,
              "custom_fields": [],
              "satisfaction_rating": "None",
              "sharing_agreement_ids": [],
              "allow_attachments": "True",
              "collaborator_ids": [],
              "priority": "high",
              "subject": "Test",
              "type": "incident",
              "status": "open",
              "description": "Test Test Test",
              "tags": ["test"],
              "forum_topic_id": "None",
              "organization_id": 360018882419,
              "due_at": "None",
              "is_public": "True",
              "requester_id": 360638872459,
              "followup_ids": [],
              "recipient": "None",
              "problem_id": "None",
              "url": "https://siemplifyhelp.zendesk.com/api/v2/tickets/2.json", "fields": [],
              "created_at": "2019-02-03T10:08:00Z",
              "raw_subject": "Test",
              "email_cc_ids": [],
              "allow_channelback": "False",
              "has_incidents": "False",
              "group_id": 360000361099,
              "external_id": "None"
           }
       },
    "Comments":
       [{
          "body": "Test Test Test",
          "plain_body": "Test Test Test",
          "via":
           {
              "source":
                      {"to": {},
                       "from": {},
                       "rel": "None"},
              "channel": "web"
            },
          "attachments":
           [{
              "thumbnails": [],
              "url": "https://siemplifyhelp.zendesk.com/api/v2/attachments/360701661660.json",
              "file_name": "Siemplify 10 2018-12-11 (1).lic",
              "content_url": "https://siemplifyhelp.zendesk.com/attachments/token/GeO6Xbc5I009xGRKLwWd7u7Qv/?name=Siemplify+10+2018-12-11+%281%29.lic",
               "height": "None",
               "width": "None",
               "mapped_content_url": "https://siemplifyhelp.zendesk.com/attachments/token/GeO6Xbc5I009xGRKLwWd7u7Qv/?name=Siemplify+10+2018-12-11+%281%29.lic",
               "content_type": "application/unknown",
               "inline": "False",
               "id": 360701661660,
               "size": 1272
            }],
          "audit_id": 393260420939,
          "created_at": "2019-02-03T10:08:00Z",
          "id": 393260420979,
          "author_id": 360638872459,
          "html_body": "<div> Test Test Test < br >< /div>",
          "type": "Comment",
          "public": "True",
          "metadata":
            {
               "system":
                  {
                     "latitude": 32.066599999999994,
                     "client": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
                      "ip_address": "1.1.1.1",
                      "location": "Tel Aviv, 05, Israel",
                      "longitude": 34.764999999999986
                   },
               "custom": {}
             }
         }],
     "Attachments": [{"test.txt": ""}]
 }

Ping

説明

接続をテストします。

パラメータ

なし

ユースケース

なし

実行

このアクションはすべてのエンティティに対して実行されます。

アクションの結果

エンティティ拡充

なし

分析情報

なし

スクリプトの結果
スクリプトの結果名 値のオプション 例
is_connected True/False is_connected:False
JSON の結果
N/A

チケットの検索

説明

キーワードでチケットを検索します。

パラメータ

パラメータ 種類 デフォルト値 説明
検索クエリ 文字列 なし クエリ コンテンツ（例: type:ticket status:pending）。

ユースケース

なし

実行

このアクションはすべてのエンティティに対して実行されます。

アクションの結果

エンティティ拡充

なし

分析情報

なし

スクリプトの結果
スクリプトの結果名 値のオプション 例
results_count なし なし
JSON の結果
N/A

更新チケット

説明

既存のチケットの詳細を更新する

パラメータ

パラメータ 種類 デフォルト値 説明
チケット ID 文字列 なし チケット番号。
件名 文字列 なし チケットの件名。
割り当てユーザー 文字列 なし ユーザーの姓名。
割り当てグループ 文字列 なし グループ名。
優先度 文字列 なし 優先度は、緊急、高、標準、低のいずれかです。
チケットのタイプ 文字列 なし チケットのタイプは、問題、インシデント、質問、タスクのいずれかです。
タグ 文字列 なし チケットに追加するタグ。
ステータス 文字列 なし ステータスは、[新規]、[対応待ち]、[保留中]、[保留]、[解決済み]、[クローズ] のいずれかです。
追加のコメント 文字列 なし チケットにコメントを追加する場合は、ここでコメントとして追加するテキストを指定します。
内部メモ チェックボックス オフ コメントを公開にするか、内部にするかを指定します。オフの場合は公開され、オンの場合は内部専用になります。

ユースケース

なし

実行

このアクションはすべてのエンティティに対して実行されます。

アクションの結果

エンティティ拡充

なし

分析情報

なし

スクリプトの結果
スクリプトの結果名 値のオプション 例
is_updated True/False is_updated:False
JSON の結果
N/A