メモ:URLターゲットおよびブランドターゲットは提供を終了いたします。詳細については、「URLターゲットとブランドターゲットの提供終了に関するお知らせ」を参照してください。
これまでは、ターゲットを使用して外部のクラウドベースのアプリケーションやサービスに情報を渡し、Zendeskの変更を通知していました。この記事では、既存のターゲットをWebhookに変換する方法について説明します。
この記事では、次のトピックについて説明します。
ターゲットのWebhookへの変換について
ターゲットをWebhookに変換する場合、変換後もプロセスを継続させるには操作の順序が重要になります。以下のプロセスをお勧めします。
- ターゲットに基づいて新しいWebhookを作成する。
- Webhookの通知を送信するトリガを設定する。
- 新しいWebhookとトリガが期待通りに動作していることを確認し、ターゲットを非アクティブにし、ターゲットに関連するトリガがあればそれも非アクティブにします。
Clickatell、Pivotal、Twilio、X Corp、およびYammerターゲットの変換
Clickatell、Pivotal、Twilio、X Corp(旧Twitter)、Yammerのターゲット設定をWebhookに直接マッピングする方法はありません。Zendeskマーケットプレイスでニーズに合ったアプリを探すことをお勧めします。
ターゲットに基づいて新しいWebhookを作成する
ターゲットをWebhookに変換するには、ターゲットの情報を1つのウィンドウで開き、Webhookを別のウィンドウで開きます。
URLターゲットに基づいてWebhookを作成するには
- ブラウザウインドウで、URLターゲットを開きます。
- 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「ターゲット」>「ターゲット」を選択します。
- Webhookに変換したいターゲットを見つけ、「編集」をクリックします。
- 別のブラウザウィンドウで、Webhookページを開きます。
- 管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「アクションおよびWebhook」>「Webhook」を選択します。
- 「Webhookを作成する」をクリックします。
- 接続方法として「トリガ」または「自動化」を選択し、「次へ」をクリックします。
- ターゲットの値をWebhookフィールドにマッピングします。マッピング方法の詳細については、以下の各ターゲットを参照してください。
- 「Webhookを作成する」をクリックします。
Basecampターゲットの設定をWebhookにマッピングする
Basecampターゲットの値を以下のようにWebhookフィールドにマッピングします。
- タイトル:Webhookの名前。
- URL:WebhookのエンドポイントURL。
- Webhookの認証は、以下のいずれかの方法を選択します。
- ユーザー名とパスワード:Webhookの「認証」を「基本認証」に設定し、Basecampのユーザー名とパスワードを入力します。パスワードのコピー&ペーストはできません。
- APIトークン:Webhookの「認証」を「APIキー」に設定し、CampfireターゲットのAPIトークンを入力します。
- プロジェクトID:WebhookのエンドポイントURLの末尾に/projects/[ID]を追加します。例:https://corp.basecamphq.com/projects/2612430。
-
リソース:WebhookのエンドポイントURLの末尾のプロジェクトIDの後に追加します。
-
メッセージ:/posts/[ID]/commentsを追加します。例:
https://corp.basecamphq.com/projects/2612430/posts/25611692/comments
- To-Do:/todo_lists/[ID]を追加します。例:https://corp.basecamphq.com/projects/2612430/todo_lists/25611692。
-
メッセージ:/posts/[ID]/commentsを追加します。例:
Campfireターゲットの設定をWebhookにマッピングする
Campfireターゲットの値を以下のようにWebhookフィールドにマッピングします。
- タイトル:Webhookの名前。
- サブドメイン:WebhookのエンドポイントURL。
- APIトークン:Webhookの「認証」を「APIキー」に設定し、CampfireターゲットのAPIトークンを入力します。
- ルーム:この情報をWebhookのエンドポイントURLに追加します。
- SSL:Webhook作成時には適用されません。
- フォーマットを維持:Webhookの作成時には適用できません。
Get Satisfactionターゲットの設定をWebhookにマッピングする
Get Satisfactionターゲットの値を以下のようにWebhookフィールドにマッピングします。
- タイトル:Webhookの名前。
-
会社名:WebhookのエンドポイントURLに組み込みます。以下はその例です。
https://getsatisfaction.com/yourcompany/
- メールアドレスとパスワード:Webhookの「認証」を「基本認証」に設定し、Get Satisfactionのユーザー名とパスワードを入力します。パスワードのコピー&ペーストはできません。
Jiraターゲットの設定をWebhookにマッピングする
Jiraターゲットの置換には、ZendeskマーケットプレイスのJiraアプリを使用することを強くお勧めします。ただし、Jiraアプリを使用しない場合は、以下のようにJiraターゲットの値をWebhookフィールドにマッピングすることができます。
- タイトル:Webhookの名前。
- URL:WebhookのエンドポイントURL。
- ユーザー名とパスワード:Webhookの「認証」を「基本認証」に設定し、Jiraのユーザー名とパスワードを入力します。パスワードのコピー&ペーストはできません。
URLターゲットの設定をWebhookにマッピングする
URLターゲットの値を以下のようにWebhookフィールドにマッピングします。
- タイトル:Webhookの名前。
- URL:WebhookのエンドポイントURL。
- 方法:Webhookのリクエスト方法。
- 属性名:Webhookを作成するときには必要ありませんが、トリガのアクションを設定するときに使用されます。
- 基本認証:Webhookの「認証」を「基本認証」に設定し、URLターゲットのユーザー名とパスワードを入力します。パスワードのコピー&ペーストはできません。
- さらに、Webhookで「リクエスト形式」を「エンコードフォーム」に設定する必要があります。
Webhook通知を送るトリガを設定する
すでに、ターゲットに基づいて通知を送信するトリガが設定されています。このトリガを編集するか複製して編集します。新しいトリガを作成してもかまいません。
既存のトリガを編集してWebhook通知を送るように設定するには
- 管理センターで、サイドバーの「 オブジェクトとルール」をクリックし、「ビジネスルール」>「トリガ」を選択します。
-
既存のトリガを編集または複製します。
「通知方法」>「ターゲット」アクションの「メッセージ」の値を確認します。この値を新しいWebhookベースのアクションで再利用します。
- 「アクション」で、「アクションを追加」をクリックし、「通知方法」>「アクティブなWebhook」を選択します。
- ドロップダウンからターゲットを置き換えるために作成したWebhookを選択します。
- 必要な情報を送信するようにWebhookを設定します。
たとえば、URLターゲットを置き換える場合、以下のようにURLパラメータを設定します。
- キーをURLターゲットの「属性名」に設定します。
- 値を「通知方法」>「ターゲット」アクションの「メッセージ」に設定します。
- 「保存」をクリックします。
- Webhookに戻り、機能をテストします。
ターゲットと関連トリガを非アクティブにする
Webhookを作成し、関連するトリガを更新したら、適切なトリガ条件を開始してWebhookを徹底的にテストします。トリガは、ターゲット用とWebhook用の2つの「通知方法」アクションで構成されていますが、外部アプリケーションやシステムにメッセージが重複して届いてしまいます。
Webhookとトリガが正しく動作していることを確認したら、トリガを編集して、「通知方法」>「ターゲット」アクションを削除し、ターゲットを非アクティブにするか削除してください。