こんにちは!ZeQの新進気鋭エンジニア、カマルです。
唐突ですが皆さんは、普段どんな課題管理ツールをお使いですか?JiraやAsana、Backlogなど、企業やチームによってさまざまなツールが導入されていますが、今回はその中でも、その柔軟性と拡張性で人気のJiraとZendeskを連携させる方法をご紹介します。
連携の背景・ニーズ
サポートチームがZendesk上で受け付けた顧客の課題を、Jiraでプロジェクト管理を行う開発チームに連携するケースを想定して、これらツールのシステム連携を検証してみました。この連携により、社内での情報の伝達ミスや情報格差を防ぎ、作業効率化やスピーディなお問い合わせ対応を実現することができます。
主な連携方法として、①連携アプリの利用 と②Webhookを用いたカスタム連携 の2つが挙げられます。どちらにするかは企業ごとのニーズによって異なるので、ぜひ本記事を参考にしてみてください!
案①: ZendeskマーケットプレイスのJira連携アプリの利用
ZendeskマーケットプレイスにはJira連携アプリが提供されています。このアプリをインストールすることで基本的な連携が可能です。
参照(Zendesk公式ヘルプ):Zendesk SupportとJiraの連携設定について
できること(機能概要):
- チケットと課題の同期: ZendeskチケットとJira課題を自動的に同期させることができます。これにより、両方のシステム間で情報が一貫して管理されます。
- 双方向の更新: ZendeskからJiraへのチケット情報の自動送信や、反対にJiraからZendeskへの更新の反映が可能です。これにより、チーム全体が最新の情報を共有しやすくなります。
- カスタムフィールドのマッピング: ZendeskとJira間でカスタムフィールドをマッピングし、データの整合性を保ちながら情報を移行・共有することができます。
- リアルタイムの通知とアラート: 重要なイベントが発生した際にリアルタイムで通知やアラートを受け取ることができ、迅速な対応が可能です。
連携アプリをインストールするだけで活用できる機能が盛りだくさんですが、ZendeskからJiraへ自動で課題を作成したい場合は、Webhookを使ったカスタム連携が必要です。
案②: Webhookを利用したカスタム連携の実装
Zendesk > Jiraへの自動での課題作成を含めた機能概要は以下です。
できること(機能概要):
- Zendeskチケットを自動的にJira課題として作成
- 複雑な条件に基づく自動課題作成
- 複数のJiraプロジェクトへの対応
自動化されたJira課題作成には多くのメリットがあります。例えば、複雑な条件下でも自動的に課題を生成することが可能になり、手作業の必要がなくなります。これにより、ヒューマンエラーや抜け漏れを防止できます。特にZendeskとJiraの連携において、自動で課題を生成できるため、都度の手作業が不要になります。
また、Jiraで複数のプロジェクトを管理している場合、自動化により複雑な割り当てや管理作業が不要になります。各プロジェクトごとにZendeskとの連携作業が必要な場合でも、自動化により効率的に管理できます。
以下から、Webhookを利用したカスタム連携の概要と手順をご紹介します。
Webhookを利用したカスタム連携概要
以下のステップでZendeskからJiraへの課題作成を自動化します。
- Zendeskでトリガが動く
- Webhookが起動する
- JiraのAPIを叩く
- Jiraで課題が作成される
ZendeskからJiraへ課題作成する具体的な手順
1. Jira APIトークンの取得
まず、JiraでAPIトークンを取得します。
- Jiraにログインします。
- アカウント設定(⚙️)に移動します。
- セキュリティ設定でAPIトークンを生成します。
- トークンをコピーして安全な場所に保存します。作成されたトークンは一度しか表示されないため、注意が必要です。
参照(Jira公式ドキュメント) :
「APIトークン」について: Atlassian アカウントの API トークンを管理する
図1. JiraのAPIキー設定画面
2. Webhookの作成
Zendeskのトリガで使用するWebhookを作成します。
- Zendeskに「ログイン」
- 「管理センター 」> 「アプリおよびインテグレーション」> 「Webhook」→「Webhookを作成する」>「トリガまたは自動化」を選択
- 「Webhookを作成する」画面でWebhook名を設定し、URLにJiraのAPIエンドポイントを入力
- 認証情報として先ほどJiraで取得したAPIトークンを使用
- リクエストタイプをPOSTに設定し、必要なヘッダーとボディを設定(JSON形式)
入力情報例:
▪️名前: 例「Zendesk→Jira課題作成」
▪️エンドポイントURL: Jiraの課題作成エンドポイントURL
例: https://{お使いのJiraドメイン}/rest/api/2/issue)
参照(Jira公式ドキュメント) : エンドポイントについて
▪️認証方法: 基本認証
参照(Jira公式ドキュメント) : REST APIの基本認証
▪️ユーザー名とパスワード: JiraのAPIアクセス用の認証情報(例: 管理者メールアドレスと先ほどコピしたAPIトークン)
▪️リクエスト方法: POST
▪️リクエスト形式: JSON
図2. ZendeskでのWebhook作成画面
3. Zendeskトリガの設定
次に、Zendeskでトリガを作成します。トリガの作成に際してJiraのプロジェクト情報(どのプロジェクトで課題を作成するのか)が必要になります。
Jiraプロジェクト情報の確認方法
- プロジェクトの確認:
▪️Jiraにログインし、ホーム画面から「プロジェクト」に移動します。
▪️選択したプロジェクトの「詳細ページ」に移動します。 - プロジェクトの名前の確認:
▪️プロジェクトの詳細ページから、プロジェクトの正式な名前を確認します。 - プロジェクトのキーの確認:
▪️プロジェクトの詳細ページから、プロジェクトのキーを確認します。
これらの手順により、Jiraのプロジェクトに関する必要な情報を確認することができます。これらの情報を使って、ZendeskからJiraに課題を作成する際に正しいプロジェクトを選択できます。
図3.0 Jiraのプロジェクト詳細ページ
Zendeskトリガの設定方法
- Zendesk管理センターに移動し、「オブジェクトとルール」 > 「トリガ」 を選択し、「トリガを作成」をクリック
- 「トリガ名」を設定
例:「新規チケット作成時にJira課題作成」 - 「カテゴリ」を設定
例:「Notifications」を選択 - トリガの条件を設定します。
条件:「チケット」=「作成された」 - アクション
「通知方法」>「アクティブな Webhook」から先ほど作成したWebhookを選択し、ペイロードとして以下のJSONボディを設定します。
注意事項:
YOUR_PROJECT_KEY:先ほど習得したキーを入力(上記の添付画像確認)
YOUR_PROJECT_NAME:先ほど習得した名前を入力(上記の添付画像確認)
{
"fields": {
"project": {
"key": "YOUR_PROJECT_KEY",
"name": "YOUR_PROJECT_NAME"
},
"summary": "{{ticket.title}}",
"description": "{{ticket.description}}",
"issuetype": {
"name": "Task"
}
}
}
図3.1Zendeskのトリガ設定画面
テスト
最後に、Zendesk側でチケットを作成し、Jira側で課題が作成されるかをテストします。
- Zendeskで新しいチケットを作成
- 設定したトリガ条件を満たす
- Jiraに移動し、新しい課題が作成されていることを確認
図4. Jiraの課題一覧画面
まとめ
いかがでしたでしょうか?
この手順を通じて、ZendeskとJiraの連携がいかにシンプルかをお分かりいただけたと思います。この連携設定により、サポートチームと開発チームの情報連携がスムーズになり、タスク・課題管理がより効率的になります。
またZendeskのトリガの設定次第で、Jiraに課題が作成されるタイミングや通知の表示なども変更できるので、自社の運用に合わせた連携方法を試してみてくださいね。
設定中に何か問題が発生した場合は、各システムのログを確認してトラブルシューティングを行ってみるのもおすすめです。是非トライしてみてください!
もしトラブルシューティングをしてもうまく設定できない、Zendesk側の設定に自信がない、自社に合った連携/運用方法がわからないなどのお悩みがあれば、お気軽にZeQへお問い合わせください!ZeQなら、現在のZendeskやJiraの使い方と理想の運用方法をヒアリングして、企業ごとに最適な連携方法や活用方法をご提案できます。些細なことでもお気兼ねなくお問い合わせください。