本レシピはStandardプラン以上の有償プランでご利用いただけます。ご利用をご希望の場合は下記よりお問い合わせください。
Zendeskで新規作成されたチケットやコメントをWebhookによってJira Softwareへ連携する方法を解説します。
レシピを使用するには事前にZendesk、および、Jira Softwareの利用契約が必要になります。
1.マイレシピへの登録
メニューの「シェアレシピ」から、「Zendesk - Jira Software連携」にチェックを入れ、画面下にある登録ボタンを押下します。
続いて「マイレシピ」から、操作メニューより「編集」を選択します。
参考:シェアレシピ・マイレシピとはなんですか?
ヘッダーでは、レシピ名とレシピ説明を変更することができます。
参考:レシピヘッダーでは何を設定すれば良いですか?
2.ZendeskのWebhook連携設定
「Zendesk - Webhook」を押下し、設定を展開します。
以下の情報をそれぞれ入力します。
- サブドメイン:Zendeskに設定したサブドメインを設定します。例えば下記URLの場合は「actrecipe」が該当します。
https://actrecipe.zendesk.com/ - ZENDESK WEBHOOK URLを生成:上記サブドメインを設定後にクリックすることで、ZendeskのWebhook設定に必要な「Zendesk Webhook URL」「Authentication (Header name)」「Authentication (Header value)」がぞれぞれ生成されます。
続いてZendeskのWebhook設定画面を表示します。下記URLの「***」をZendeskのサブドメインに変更してアクセスしてください。
https://***.zendesk.com/admin/apps-integrations/webhooks/webhooks
上記ページより「Webhookを作成する」ボタンをクリックし、下記の手順でWebhookの設定を行います。
- 「トリガまたは自動化」を選択し「次へ」ボタンをクリックします。
- 「詳細を追加」ステップでは下記の情報をそれぞれ入力します。
- 名前:任意の名称を入力します。
- 説明:任意の説明を入力します。
- エンドポイントURL:ActRecipeで生成された「Zendesk Webhook URL」をコピー&ペーストします。
- リクエスト方法:「POST」を選択します。
- リクエスト形式:「JSON」を選択します。
- 認証:「APIキー」を選択します。
- ヘッダー:「ヘッダー名」にはActRecipeで生成された「Authentication (Header name)」を、「値」には同「Authentication (Header value)」をそれぞれコピー&ペーストします。
- Webhookをテスト:下記を参照し、適宜Webhookのテストを実施してください。
サードパーティシステムとやりとりするためのWebhookの作成 – Zendeskヘルプ - 全ての入力が完了したら画面右下の「Webhookを作成する」ボタンをクリックします。
「Webhookを接続する」ステップでは「管理センター」リンクよりトリガを設定します。
トリガ設定画面は下記URLの「***」をZendeskのサブドメインに置き換えたものとなります。
https://***.zendesk.com/admin/objects-rules/rules/triggers
トリガページでは画面右上の「トリガを追加」ボタンをクリックし、条件等を設定します。
トリガで設定された内容によってZendeskのチケットがJira Softwareに連携されますので、お客様の運用に合わせて設定をお願いします。
以下は
[チケットの作成、または、更新、またはコメントがあった場合」かつ「ステータスが終了以外]
を条件とした例となります。
アクション内のJSONボディには下記の内容をコピー&ペーストしてください。
{
"ticket":{
"id":"{{ticket.id}}",
"link":"{{ticket.link}}",
"requester_name":"{{ticket.requester.name}}",
"requester_email":"{{ticket.requester.email}}",
"ticket_type":"{{ticket.ticket_type}}",
"title":"{{ticket.title}}",
"description":"{{ticket.description}}",
"status":"{{ticket.status}}",
"latest_comment":"{{ticket.latest_comment_html}}",
"comments":"{{ticket.comments}}",
"created_at":"{{ticket.created_at_with_timestamp}}",
"updated_at":"{{ticket.updated_at_with_timestamp}}"
}
}
全ての設定が完了しましたら画面右下の「保存」ボタンをクリックします。
「Zendesk - Webhook」タスクの設定は以上です。
3.Jira Softwareの連携設定
「Connecting Jira issues」を押下し、設定を展開します。
続いて「認証トークンを取得する」をクリックします。認証画面にて「Accept」ボタンをクリックします。
生成されたアクセストークンをコピーし、ActRecipeの「トークン」欄にペーストします。
続いて以下の設定を行います。
- Jira Site Name:Jira Softwareのサブドメインを入力します。
- Project Key:Jira上のプロジェクトのキーを入力します。キーは「プロジェクト>すべてのプロジェクトを表示」よりご確認いただけます。
入力が完了したら画面右下の保存アイコンで設定を保存します。
「Connecting Jira issues」の設定は以上です。
Webhookによるレシピの実行
Zendeskのトリガで設定した条件に該当するチケット等がWebhookによってJira Softwareに連携されます。
同一のチケットに対するコメントはJira Softwareのコメントとして追加されます。
ZendeskのトリガによってWebhookが実行されますとActRecipeのレシピが実行されますので、「レシピ実行履歴」より連携内容をご確認いただけます。
このレシピで連携できるSaaSについて