ZendeskのWebhook機能とAPIを合わせ技してみた。

株式会社エクレクト（eclect, inc.）カスタマーサクセスマネージャーの寺田です！

本noteでは、Zendeskを利用するうえでのコツやTips、サービスのアップデート情報などをお届けします。
記念すべき第1回、取り上げるのはWebhook機能とAPIです！（第1回から渋い題材を取り上げましたw）

Webhook機能って？

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

以前から提供されているHTTPターゲット機能も同種のものなので、そちらの名称に聞き馴染みがある方もいらっしゃるかもしれません。（ちなみに、HTTPターゲット機能は来月に提供終了になりますので、Webhook機能への移行が未了の方はお気を付けください！）

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

「Webhook機能ってどんなときに使うの？」ですが、以下参考ページのように、ZendeskからSlackに対してチケットの新規作成を通知する、などが代表的な利用事例かなと思います。

参考ドキュメント - dely Tech Blog：
Zendeskからslackへの通知方法

APIって？

APIそのものの説明はWikipedia先生に委ねまして 汗、ここではZendeskのAPIについてほんと簡単にお話を。。

Zendeskは豊富にAPIを備えていて、チケットや組織・ユーザーの情報、トリガやマクロといった各種設定内容など、Zendeskの中に格納されている情報のほとんどをAPI経由で登録・更新ないし取得することができるようになっています。
（Zendesk Supportだけではなく、Zendesk Guideで構築したヘルプページ＝FAQに記事を登録する、記事の一覧を取得する、などのAPIも用意されています！）

APIは一般公開されていますので「豊富って言うけど、どんなラインナップなの？」と気になった方はドキュメントもご参照ください！

参考ドキュメント：
Zendesk API Reference

合わせ技してみた！

では本題。Webhook機能とZendesk TicketAPIを使った、ちょっとしたTipsをご紹介します！
今回やってみるのは「ユーザーフィールドに登録された値を、チケットフィールドに自動で転記する」です！

例えば、ユーザーフィールドにその顧客が契約するサポートプラン、オプション内容が登録されているとします。

これだけですと、本顧客から問い合わせが入った際、チケットフィールドにはこの内容は登録されていません。
ユーザーフィールドに登録された内容を見に行き、必要に応じて手動で転記をする必要が出てきます。

後々、Zendesk Exploreを使って「サポートプラン毎にどのくらい問い合わせ入ってるのかな？」を分析しようとしたときに分析ができないと悲しいですよね？
そこで、Webhook機能＋TicketAPIを使って自動転記しちゃいましょう！

やってみよう！

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

Webhookを作成したらそれで終わり、ではありません。

本Webhookに情報を送信するためのトリガないし自動化を作成する必要があります。
今回はチケットが作成されたタイミングでユーザーフィールドの値をチケットフィールドに転記するためのトリガを作成します。

では、試してみましょう！
問い合わせフォームからリクエストを送信してみると...

チケットフィールドにユーザーフィールドの値が登録されています！これで分析にも利用できますね！

「ちゃんとトリガ発動してるのかしら？」は、チケットのイベント欄で確認できますよ。（ちなみに、更新ユーザーは、Webhook作成時に登録されたアカウントのユーザーになります。）

本Tipsご利用時の注意点

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

もう1点、実はこのTipsはZendesk側は動作保証・サポートをしていない外法です 汗（「大事なことを最後に言うなよ」ですね。。）
ときに正常に動作をしないこともあり得ますので、利用される際はご留意くださいませ！

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

最後に

初回からかなり渋い題材を取り上げました 汗
Zendeskの活用具合はユーザー様によって様々ですので、もう少しライトな内容も今後は投稿していく予定です。ご了承くださいませ。。

では、引き続きみなさまにお役立ていただける情報を発信していきたいと思います！

---

当社エクレクトは、Zendeskパートナーとして2年連続でAPAC Partner of the Yearを受賞しております！
ニュースリリースはこちら

Zendeskの導入支援・データ移行・テンプレートの制作、各種関連アプリケーションの開発、既存システムとの連携などZendeskに関わるサービスをワンストップで提供しています！
https://eclect.co.jp/