Webhookは、メールでのフォローアップ送信後、カスタムチケットフィールドやタグをチケットに追加するなど、チケットに対してさまざまなアクションを実行するために、当社のAPIと組み合わせて使用できます。
注：フォローアップメールのWebhookイベントは、ウェブチャットのチケットにのみ適用できます。
まず、フォローアップメールが送信されたかどうかを検出するために、Webhookを設定します。
- そのためには、まず「設定」＞「API」に移動してください。
- Webhookセクションまでスクロールし、「Webhookを追加」ボタンをクリックしてください。
- 表示されるポップアップで、次のフィールドに入力してください。
- Webhook名: Webhookの名前。これはあなたのドメインに対して一意になります。
- ターゲットURL: 必須のHTTPS URL – 不正アクセスを防ぐため、データ暗号化を確実にするHTTPSリスナーURLのみを許可しています。
- 認証メカニズム: Helpshiftでは、セキュリティを強化するためのオプションとして、以下を提供しています。
- Basic auth: ユーザー名とパスワードベース
- カスタム認証: シークレットキーベース
- 認証なし: 選択した場合、認証は適用されません。これにより、テスト中に柔軟性が得られます。
- イベント: 「フォローアップメール送信済み」を選択
- フィルター: Webhookを実行するトリガーを指定します。
- 通知配信失敗メール: 通知の配信が失敗した場合にメールで通知を受け取るためのオプションフィールドです。
- 「保存」をクリックすると、WebhookがWebhookのリストに表示され、すぐに動作を開始します。
右側の歯車アイコンから変更または削除できます。
- Webhook の設定が完了したら、フォローアップメールが送信されたときに、開発者に REST API を設定して、チケットに対して自動的にアクションを実行させる必要があります。開始するには、開発者にAPI ポータルにアクセスさせ、Helpshift ドメインと API キーでログインしてもらってください。