メインコンテンツへスキップ
このページは、1つの実在アプリを最初から最後まで追うサンプルアプリ:OneSignalの完全な統合の一部です。アプリはClean Beansという共同生活の家のための掃除当番表アプリで、Expo(React Native)とSupabaseバックエンドで構築されています。 スワイプで消したプッシュは失われます。Clean Beansはアプリ内に7日間の履歴を残し、すべての画面のヘッダーに未読数を表示します。
Clean Beansの通知受信箱

受信箱には最近の通知が一覧表示されます。

アプリ自身は通知を記録しません。それでは、アプリが閉じている間に届いた通知を取りこぼしてしまいます。OneSignalはEvent Streamを通じてすべてのプッシュをバックエンドに知らせ、バックエンドが履歴を保持します。
1

OneSignalがプッシュごとにイベントを送信する

Event Streamは、プッシュが送信されたときと、クリックされたときに、バックエンド関数にPOSTします。
2

関数が行を保存または更新する

送信イベントで受信箱のエントリが作成されます。クリックイベントでそのエントリが既読になります。
3

アプリがテーブルを読み取る

受信箱の画面とヘッダーのバッジは、ユーザー自身の行を取得します。

Event Streamを設定する \

ダッシュボードの設定。 Data > Event Streamsで、次の内容のストリームを作成します。
  • URL: 関数のアドレス。
  • ヘッダー: 共有シークレット。たとえばX-Webhook-Secret。
  • イベント: message.push.sentとmessage.push.clicked。
  • 本文: リクエストの形を決めるLiquidテンプレート。
Event Stream body
上記のように、dataの各キーは名前で参照してください。{{ message.data }}だけを使うと、オブジェクト全体がPython風のdict({'type': 'kudos'})として出力されます。これは有効なJSONではないため、下の関数は本文の解析時にリクエストを拒否します。タイトルとコンテンツを.enで読み取るのも同じ理由です。受信箱に必要なのはtypeだけです。独自のWebhookで使うほかのキーは、1行ずつ追加してください。二重引用符を含む値もJSONを壊します。Kudosのプッシュにはユーザーが入力したテキストが含まれるため、"を含むkudosメッセージでは関数が解析できない本文が生成され、そのプッシュは受信箱に届きません。
このストリームは、すべてのデバイスに配信されたすべてのプッシュについてイベントを1件送信し、各イベントはプランのメッセージイベント量にカウントされます。使用するイベントだけを選択してください。

イベントを受信する \

関数は、ほかの処理より先にシークレットを確認します。
supabase/functions/inbox-webhook/index.ts
送信イベントは受信箱の行になります。OneSignalのイベントIDが一意キーなので、同じイベントが2回届いても行は2つ作成されません。
supabase/functions/inbox-webhook/index.ts
クリックイベントは、対応する行を既読にします。
supabase/functions/inbox-webhook/index.ts
タップされたプッシュを振り分けるdata.typeフィールドも各行に保存されるため、受信箱は正しいアイコンを表示し、正しい画面を開けます。

保存する前にLiquidを展開する \

ストリームは、OneSignalが受信者ごとにパーソナライズする前の、書かれたままのメッセージを報告します。バックエンドから送信したプッシュはすでに最終的なテキストになっていますが、Journeyのプッシュはそうではありません。Clean BeansのJourneyメッセージの1つには、次のタイトルがあります。
Journey push
端末には「Kitchen cleaned ✅」と表示されます。Webhookは上の行を受け取り、受信箱の最初のバージョンはそれをそのまま表示していました。 現在の関数は、値の参照とdefaultフィルターに対応した小さなレンダラーで、保存前にタイトルと本文を自ら展開します。値は2か所から取得します。
  • タグはデータベースから読み取ります。アプリは保存している値から各タグを設定しているため、関数は同じ値を読み取れます。ストリームの本文で{{ user.tags.user_name }}を渡す方法でも動作しますが、名前に二重引用符が含まれると本文が無効なJSONになります。
  • Journeyのイベントプロパティはストリームでは利用できません。関数は、カスタムイベントを発生させた掃除セッションからこれらを再構築します。
supabase/functions/inbox-webhook/index.ts
Event Streamsから受信箱やログを構築する場合は、Journeyとテンプレートのメッセージがどのような形で届くかを確認してください。含まれるLiquidは、Liquidのままです。ここでのように自分で展開するか、それらのメッセージを除外してください。

受信箱を表示する \

行レベルセキュリティにより各ユーザーは自分の行しか読み取れないため、アプリのクエリでユーザーによる絞り込みは不要です。
app/inbox.tsx
src/components/InboxButton.tsx

メールの設定を同期する \

同じストリームで、もう1つの問題も解決できます。ユーザーがメール内のUnsubscribeをタップすると、OneSignalはそのユーザーへのメール送信を停止しますが、アプリ自体の「Weekly Email Summary」スイッチはオンのままです。設定画面が実態と食い違い、バックエンドは送信を試み続けることになります。 ストリームに4つのメールイベントを追加すると、これを解決できます。関数はこれらをすべて同じように扱います。OneSignalはこの人に今後メールを送らないため、アプリの設定もそれに合わせてオフにします。
supabase/functions/inbox-webhook/index.ts
受信箱がすでに使っているフィールド(event_kind、event_id、external_id)で十分なため、ストリームの本文を変更する必要はありません。
これはアプリをOneSignalに合わせるもので、逆方向ではありません。ユーザーがアプリでメールを再びオンにしても、OneSignalのサブスクリプションは配信停止のままです。再購読させるには、バックエンドからOneSignalのサブスクリプションAPIを呼び出す必要があります。
同じEvent Streamのパターンで、メールの開封、アプリ内メッセージのクリック、SMSの配信など、OneSignalが把握しているあらゆる情報を自社システムと同期できます。

Event Streams

ストリームを設定し、イベントを選択する。

Event Streamのデータ

本文テンプレートで使用できるすべてのフィールド。