Helpshiftは、APNS（iOS用）およびFCM/GCM（Android用）を通じて、Helpshiftから直接プッシュ通知を提供します。独自のプッシュサーバーをお持ちで、それらを使用してプッシュ通知を送信したい場合は、このガイドの手順を完了することで、カスタムプッシュ通知のルーティングを構成できます。

1. ダッシュボードでカスタムプッシュ通知を設定する
2. カスタムプッシュ通知を処理するためのウェブサービスを作成する
3. APNSまたはFCMへのプッシュ通知の作成
4. プッシュ通知のクライアントの設定

1. ダッシュボードでカスタムプッシュ通知を設定する

Helpshiftを設定して、プッシュ通知メッセージをAPNS（iOSの場合）およびFCM/GCM（Androidの場合）経由ではなく、カスタムURLに送信するように構成できます。最初の手順として、管理者がカスタムプッシュ通知を設定する必要があります。

そのためには、「設定」＞「アプリ設定」ページに移動し、カスタムプッシュ通知を設定したいアプリを選択し、プッシュ通知セクションまでスクロールしてください。

「プッシュ通知サーバーの選択」のオプションを「カスタムプッシュ通知」に変更してください。

「[プラットフォーム]プッシュ通知」のトグルをクリックして有効にしてください。

以下を選択するように求められます。

  • 認証方法：Webhookを受信するWebサービスの要件に応じて、認証方法を選択してください（なし、ベーシック認証、カスタム認証）。
  • ターゲットURL: これは、カスタムプッシュ通知を処理するサービスのURLです
  • 通知配信メール：プッシュ通知の配信に失敗した場合、ここに通知が送信されます

これは、HTTP Webhooksの作成に使用するプロセスと同じですので、設定は同様になるはずです。

これが構成されると、プッシュ通知が送信されるたびに、Webhookが生成され、URLに送信されます。

2. カスタムプッシュ通知を処理するウェブサービスを作成する

Helpshiftから送信されたWebhookをキャプチャし、APNS（IOS用）またはFCM/GCM（Android用）にカスタムプッシュ通知を作成できるWebサービスが必要です。

Helpshiftは、カスタムプッシュ通知を有効にした際に指定したターゲットURLに、標準のHTTPリクエストを送信します。このリクエストには、クライアント通知の生成に使用できる以下のプロパティがJSONオブジェクトとして含まれます。

  • プラットフォーム: (AndroidまたはIOSを示します)
  • ペイロード:
    • 説明: (エージェントからのメッセージ)
    • メッセージ: (アプリ名)
    • データ
      • origin: Helpshift
      • issue\_id: (チケットのGUID)
  • 対象者:
    • userid: (プッシュ通知に使用されるユーザートークン)
  • endTime: (イベントの時間)

このサービスはこれらのプロパティを取得し、一意のプッシュ通知を生成する必要があります。

3. APNSまたはFCMへのプッシュ通知を作成する

カスタムプッシュWebhookがWebサービスによってキャプチャされると、プッシュ通知をAPNS（IOSの場合）またはFCM/GCM（Androidの場合）に作成する必要があります。プッシュ通知の作成方法については、AppleとGoogleの次のドキュメントを参照してください。

プッシュ通知の特定のデバイスへのターゲティング：

プッシュ通知の一環として、サービスは通知を送信するデバイスを識別できる必要があります。これは、Helpshiftからのカスタムプッシュ通知の（userid）プロパティを通じて提供されるユーザートークンを介して行われます。

クライアントがHelpshiftをモバイルデバイスにロードし、Helpshiftプッシュ通知を設定すると、クライアントはそのトークンをHelpshiftと共有します。このトークンは、カスタムプッシュ通知ごとに提供され、通知が正しいデバイスに送信されるようにします。

プッシュ通知にHelpshiftスキーマを使用する：

プッシュ通知を作成する際に以下のスキーマを使用すると、Helpshiftは各デバイスに渡されるプッシュ通知を処理できます。プッシュ通知を処理するには、クライアントは以下のスキーマとともにSDKでhandlePush APIを使用する必要があります。

{
"origin" : "helpshift",
"issue_id" : ,
"alert" :
}

注：カスタムプッシュ通知で提供されます。

4. プッシュ通知のクライアントの設定

クライアントがプッシュ通知を受信するためには、Helpshiftを実行しているアプリケーションが、Helpshiftにユーザートークンを登録してプッシュ通知を初期化し、サービスでプッシュ通知を処理する方法を設定する必要があります。このプロセスは、開発者向けドキュメントに記載されています。