ZendeskのWebhook機能とAPIの複合活用

本コラムでは、Zendeskを利用する上でのコツやTips、サービスのアップデート情報などをご案内しています。
今回は、Zendeskから他のシステム情報を受け渡す際などに便利に使用できる『Webhook機能とAPI』の活用について取り上げます。

Webhook機能とは？

ZendeskのWebhook機能は、Zendeskから別システムに対して、チケットやユーザーとして格納されている情報を送信（HTTPリクエスト）することができる機能です。

以前提供されていたHTTPターゲット機能も同種なので、そちらの名称に聞き馴染みがある方もいらっしゃるかもしれません。（※HTTPターゲット機能は、2022年2月に提供終了となりました。）

▼参考ドキュメント – Zendesk公式ヘルプ
≫ 管理センターでのWebhookの作成
≫ HTTPターゲットの提供終了とWebhookへの変換に関するお知らせ

Webhook機能の代表的な使い方としては、以下参考ページのように、ZendeskからSlackなど他のシステムへチケットの新規作成を通知する。などが挙げられます。

APIとは？

APIそのものについての説明は、Wikipediaをご覧いただき、本コラムではZendeskのAPIについて簡単にご説明します。

Zendeskは、豊富なAPIを備えており、チケットや組織・ユーザーの情報、トリガ（自動化機能）やマクロといった各種設定内容など、Zendeskに格納されている情報のほとんどをAPI経由で登録・更新および取得することができます。

Zendesk Supportに限らず、Zendesk Guideで構築したヘルプページ＝FAQに記事を登録したり、記事の一覧を取得したりするAPIも用意されています。

APIは一般公開されているので、他のラインナップについては以下のドキュメントをあわせてご参照ください。

▼参考ドキュメント
≫ Zendesk API Reference

Webhook機能とAPIの合わせ技

ではここから、Webhook機能とZendesk TicketAPIを使った、ちょっとしたTipsをご紹介します。
今回は、「ユーザーフィールドに登録された値を、チケットフィールドに自動で転記する」という内容です。

例えば、以下図のようにユーザーフィールドにお客さまが契約する「サポートプラン」、「オプション内容」等が登録されているとします。

これだけでは、お客さまから問い合わせが入った際、チケットフィールドは空の状態なので、ユーザーフィールドに登録された内容を見て、必要に応じて手動で転記をする必要があります。

また、この状態では、後々Zendesk Exploreを使って、「サポートプラン毎にどのくらい問い合わせ入ってるのか？」などの分析もできません。
このような際に、Webhook機能＋TicketAPIを使うことで情報の自動転記が可能になります。

具体的な設定例

まずは、Webhookを作成します。ここでは、チケット更新用のAPIであるUpdate Ticketを使用します。

上記手順でWebhookを作成したら、情報を送信するためのトリガもしくは自動化を作成します。
今回はチケットが作成されたタイミングでユーザーフィールドの値をチケットフィールドに転記するためのトリガを作成します。

ここまで設定ができたら、実際に問い合わせフォームからリクエストを送信してみます。

すると、チケットフィールドにユーザーフィールドの値が登録されています。これで、分析にも利用できるようになります。

ご利用時の注意事項

ZendeskAPIには、コール数の上限が設定されています。本Tipsをお試しの際は、APIの利用状況を事前にお確かめください。上限に達してしまうと、本Tips以外でAPIを利用している他の連携もストップしてしまいます。

もう1点重要なのは、今回ご紹介をしたTipsは、Zendeskでは動作保証・サポート非対応となります。よって、正常に動作をしないこともあり得ますので、十分なテストの上でご利用ください。

参考ドキュメント – Zendesk公式ヘルプ：
≫ APIアクティビティの使用回数制限をトラッキングする
≫ トリガとターゲットを使用してチケットを更新することはできますか？

エクレクトは、日本におけるZendeskの公認販売代理店および導入サポート企業として、最上位のプレミアパートナーに認定されています。最適なプランのご提案から導入支援、運用コンサルティング、システム連携、他システムからのデータ移行、拡張アプリケーション開発など、Zendeskに関わるすべてのサービスをワンストップで提供しています。

Zendeskをプラットフォームとした幅広い連携ソリューションで、CX向上を実現します。
≫ 「やりたい」をかたちにする エクレクトのCXソリューション