イベントストリーム

• プッシュメッセージイベント（送信済み、受信済み、クリック済み、失敗、配信停止済み）
• メールイベント（送信済み、開封済み、クリック済み、バウンス済み、配信停止済みなど）
• SMSイベント（送信済み、失敗、配信停止済みなど）
• アプリ内メッセージイベント（インプレッション、クリック済みなど）
• ライブアクティビティイベント（送信済み、配信済み、確認済み配信、失敗、配信停止済み、クリック済み）

​

一般的なユースケース

• エンゲージメントデータを一元化 — CRM、CDP、またはデータウェアハウスにイベントをストリーミングして、クロスチャネルのアクティビティ（開封、クリック、バウンス）を個別のツールに分散させず、一か所に集約します。
• 分析、レポーティング、コンプライアンス — すべてのメッセージイベントをウェアハウスに蓄積して、トレンド分析、監査、または規制上の記録保存に活用します。
• エンゲージメント離脱の監視 — 配信停止、バウンス、却下を自社システムで追跡して、リテンションリスクを早期に発見します。
• 外部ワークフローのトリガー — ユーザーがメッセージを開封またはクリックしたときに他のツールで自動化を実行します（例：リードスコアを更新する、フォローアップシーケンスを開始する）。
• バッチ同期と余分なインテグレーションを置き換える — イベントにリアルタイムで対応し、OneSignalを直接宛先に接続することで、中間ツールとメンテナンスコストを削減します。

​

技術チームを始めるために

1. 宛先とスコープを決定 — イベントをどこに送るか（自社 API、データウェアハウス、CDP など）、どのイベントタイプをストリーミングするか（プッシュ、メール、SMS、IAM、ライブアクティビティ）、エンドポイントを適切にサイジングするためのメッセージ量の見積もりを合意します。
2. HTTPエンドポイントを設定 — POSTリクエストを受け入れる公開アクセス可能なエンドポイントを構築または設定します。応答時間を低く保つために、重い処理なしにイベントを迅速に記録する必要があります。パフォーマンスの期待値とエンドポイントが遅れた場合の動作については再試行 / 無効化をご覧ください。
3. OneSignalでイベントストリームを設定 — データ > イベントストリームで、イベントを選択し、URLと認証ヘッダーを設定し、イベントストリームデータフィールドとLiquid構文を使用してJSONボディを定義します。
4. エンドツーエンドでテスト — 本番エンドポイントに切り替える前にwebhook.siteを使用してペイロードの形式とヘッダーを確認します（テストを参照）。

​

セットアップ

• 公開アクセス可能な HTTP(S) エンドポイントを指す有効なURLまたはIPアドレス
• URLとIPアドレスは公的にルーティング可能である必要があります
• ドメインには、認識されたトップレベルドメイン（例：「.com」、「.net」）が含まれている必要があります

​

イベントの選択

​

イベントストリームフィルター

​

イベントストリームの構成

​

認証ヘッダー

• Authorizationヘッダー：Authorizationヘッダーを追加します。YOUR_TOKENはシステムまたはサードパーティによって提供されます：
  • Basic {{YOUR_TOKEN}}
  • Bearer {{YOUR_TOKEN}}
  • ApiKey {{YOUR_API_KEY}}
• カスタムヘッダー：次のようなカスタムヘッダーを追加することもできます：
  • X-API-Key: {{YOUR_API_KEY}}

​

構成のテスト

​

許可されないヘッダー

• content-length
• referer
• metadata-flavor
• x-google-metadata-request
• host
• x-onesignal*

​

ボディ

​

パーソナライゼーション

​

ボディの例

{
  "Event Data": {
    "event.kind": "{{ event.kind }}",
    "event.id": "{{ event.id }}",
    "event.timestamp": "{{ event.timestamp }}",
    "event.datetime": "{{ event.datetime }}",
    "event.app_id": "{{ event.app_id }}",
    "event.subscription_device_type": "{{ event.subscription_device_type }}",
    "event.subscription_id": "{{ event.subscription_id }}",
    "event.onesignal_id": "{{ event.onesignal_id }}",
    "event.external_id": "{{ event.external_id }}",
    "event.data.page_name": "{{ event.data.page_name}}",
    "event.data.page_id": "{{ event.data.page_id}}",
    "event.data.target_name": "{{ event.data.target_name}}",
    "event.data.target_id": "{{ event.data.target_id}}",
    "event.data.failure_reason": "{{ event.data.failure_reason}}"
  },
  "Message Data": {
    "message.id": "{{ message.id }}",
    "message.name": "{{ message.name }}",
    "message.title": "{{ message.title.en }}",
    "message.contents": "{{ message.contents.en }}",
    "message.template_id": "{{ message.template_id }}",
    "message.url": "{{ message.url }}",
    "message.app_url": "{{ message.app_url }}",
    "message.web_url": "{{ message.web_url }}"
  }
}

​

JSONでのLiquid構文の使用

• 文字列 → 引用符で囲む必要があります。
• 数値 → 引用符で囲まないでください。
• オブジェクト → 引用符で囲んではいけません。

{
  "user_id": "{{ user.onesignal_id }}"
}

{
  "user_id": {{ user.onesignal_id }}
}

{
  "user_score": {{ user.tags.score }}
}

{
  "user_score": "{{ user.tags.score }}"
}

{
  "user_data": {{ user.tags }}
}

{
  "user_data": "{{ user.tags }}"
}

1. 直接言語チェックを使用する：より良い互換性のために、userLangのような変数ではなく、条件内で常にuser.languageを直接チェックします。
2. シンプルから始める：基本的なフレーズから始めて、徐々に複雑さを追加します。
3. 過度のネストを避ける：解析の問題を防ぐために、条件をフラットに保ちます。
4. 最初に基本的な句読点をテストする：特殊文字を使用する前に、シンプルな文と句読点から始めます。
5. フォールバックを使用する：翻訳が欠落している場合に備えて、デフォルト言語（例：英語）を確保します。
6. 標準キーに固執する：信頼性のために、content/title/enのような標準OneSignalキーを使用します。

​

結果とデバッグ

​

再試行 / 無効化

1. アプリと組織の管理者は、失敗量が顕著になったとき（無効化前）と、ストリームが無効化されたときに再度メールを受け取ります。
2. ダッシュボードのイベントストリームインデックスページにもバナーが表示されます。
3. 根本的な問題を修正し、ログタブまたはwebhook.siteでテストして、ストリームを再有効化します。

• イベントを素早く記録 — 重い処理なしに、受信イベントをキューまたはデータストアに書き込みます。
• 遅い応答と429を避ける — 一貫して遅い応答時間またはレート制限の応答は、イベントのバックアップを引き起こし、OneSignalがストリームを無効にする原因になります。
• 送信量に合わせてサイジング — 100kのメッセージを送信すると、選択したイベントタイプごとに最大100kのイベントが発生します。プランのメッセージボリュームを確認し、適切にプロビジョニングしてください。

​

成功のためのヒント

• まず自社サーバーにストリームをポイントします。 サードパーティAPIに直接接続することは可能ですが、受信側をコントロールできない場合、デバッグ、レート制限の処理、ボリュームの管理がより困難になります。
• サードパーティに転送する前にバッファリングします。 OneSignalはユーザーがイベントをトリガーする速さでイベントを送信します——大規模な送信により、外部のレート制限を圧倒したり、コストを増加させたりするバーストが発生する可能性があります（特にSMSプロバイダー）。イベントを受け入れ、キューに入れ、コントロールできるペースで外部APIに転送する軽量サービスを構築してください。
• サードパーティのAPIドキュメントを確認します。 多くのサービスは、イベントストリームでターゲットできる公開HTTP APIを提供しています。ストリームを設定する前に、認証、受け入れ可能なペイロード形式、レート制限に関するドキュメントを探してください。

​

メッセージイベントデータの制限

​

テスト

• Host：リクエストの送信元のIPアドレス。可能なIPのリストについては、REST API概要を参照してください。
• Request Content：イベントストリームのボディ内で送信されたデータ。