Open Loyalty

Open Loyaltyは、クラウドベースのロイヤルティプログラムプラットフォームで、顧客ロイヤルティプログラムや報酬プログラムを構築・管理できます。BrazeとOpen Loyaltyの統合は、ポイント残高、ティアの変更、有効期限の警告などのロイヤルティデータをリアルタイムでBrazeに直接同期します。これにより、ユーザーのロイヤルティステータスが変化したときに、パーソナライズされたメッセージ（メール、プッシュ、SMS）をトリガーできます。

この統合はOpen Loyaltyによって管理されています。

統合について

この統合は、Brazeデータ変換を使用してOpen LoyaltyからのWebhookをキャプチャし、Brazeユーザープロファイルにマッピングします。

• リアルタイム更新：ロイヤルティイベント（ポイント獲得、ティアアップグレード）をBrazeにプッシュします。
• パーソナライゼーション：Brazeテンプレートでロイヤルティ属性（現在の残高、次のティア名）を使用します。
• 双方向：Brazeのエンゲージメントデータに基づいて、Open Loyaltyの顧客カスタム属性を更新します。

ユースケース

この統合は、以下のデータフローをカバーしています。

1. Brazeへのイベント同期（インバウンド）：Open LoyaltyからBrazeにデータを送信することで、ポイントの変更、ティアのアップグレード、報酬の交換を追跡します。データ変換により、このデータがユーザーイベントに変換されます。
2. Open Loyalty会員の変更（アウトバウンド）：「VIP」ラベルの追加やカスタム属性の更新など、Brazeでのユーザー行動に基づいてOpen Loyaltyの会員データを自動的に更新します。

前提条件

始める前に、以下のものが必要です。

統合

主な統合は、データ変換を使用してOpen LoyaltyのWebhookイベントをBrazeに同期します。

ステップ 1：BrazeでWebhook URLを生成する

まず、Brazeでデータ変換を作成し、データを受信するためのユニークなURLを生成します。

1. Brazeで、Data Settings > Data Transformationを開きます。
2. Create Transformationをクリックします。
3. 以下のフィールドに入力します。
   • Transformation name：説明的な名前を付けます（例：「Open Loyalty Point Update Events」）。
   • Select destination：POST: Track usersを選択します。
4. Create Transformationをクリックします。
5. 右側にあるWebhook URLを見つけ、Copyをクリックします。

重要

このURLは安全に保管してください。次のステップで必要になります。

ステップ 2：Open LoyaltyでWebhookサブスクリプションを作成する

Open Loyaltyに、先ほど生成したURLへ特定のイベントを送信するよう設定します。

1. Open Loyalty管理パネルにログインします。
2. General > Webhooksに移動します。
3. Add new webhookをクリックし、サブスクリプションを設定します。
   • eventName：追跡したいイベントを選択します（例：AvailablePointsAmountChanged、CustomerLevelChanged、CampaignEffectWasApplied）。
   • url：ステップ1のBraze Webhook URLを貼り付けます。
   • 以下のヘッダーを追加します。
     • Content-Type: application/json
     • User-Agent: partner-OpenLoyalty
4. Webhookサブスクリプションを保存します。

ステップ 3：データ変換を設定する

受信したOpen LoyaltyのペイロードをBrazeのプロパティにマッピングするJavaScriptロジックをBrazeに記述します。

1. Brazeで、ステップ1で作成したデータ変換を開きます。
2. Open Loyaltyでイベントをトリガーし（例：メンバーのポイントを変更したり、ティアを割り当てたり）、Webhook detailsペインにサンプルペイロードを生成します。
3. Transformation codeエディターで、受信データをマッピングするスクリプトを記述します。以下の例をガイドとして使用してください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// 1. Parse the incoming Open Loyalty payload
const data = payload.data;

// 2. Construct the Braze API body
let brazecall = {
  "events": [
    {
      // CRITICAL: Map the identifier (e.g., loyaltyCardNumber -> external_id)
      "external_id": data.customer.loyaltyCardNumber,

      // Define the Event Name (what you see in Braze)
      "name": "Loyalty Event Triggered",

      // timestamp
      "time": new Date().toISOString(),

      // Map specific properties you want to use in emails/segments
      "properties": {
        "event_type": payload.type, // for example, 'AvailablePointsAmountChanged'
        "new_balance": data.amount,
        "change_amount": data.amountChange,
        "tier_name": data.tier ? data.tier.name : null
      }
    }
  ]
};

return brazecall;

4. Validateをクリックして、コードがサンプルペイロードに対して正しく実行されることを確認し、Activateをクリックします。

BrazeでOpen Loyaltyを使用する

インバウンドの統合が完了したら、アウトバウンド更新を設定し、Brazeでの行動に基づいてOpen Loyalty会員を変更します。

ステップ 1：Braze Webhook Campaignを設定する

このプロセスでは、Braze Webhookを使用してOpen Loyalty Member APIにPATCHリクエストを送信します（例：「VIP」ラベルを追加する）。

1. Brazeで、新しいWebhook Campaignを作成します（またはCanvas内のWebhookを使用します）。
2. Compose Webhookをクリックします。
3. Webhook URL：Open Loyaltyインスタンス、テナントID、ユーザーID用のBraze Liquid変数を使ってURLを構築します。

   • フォーマット：

     https://<YOUR_OL_INSTANCE>/api/<TENANT_ID>/member/loyaltyCardNumber={{${user_id}}}

4. 以下のフィールドに入力します。
   • Request Method：PATCH
   • Request Headers：
     • Content-Type: application/json
     • X-AUTH-TOKEN: <YOUR_PERMANENT_TOKEN>
     • User-Agent: Braze
5. Request Body：Raw textを選択し、ペイロードを貼り付けます。

1
2
3
4
5
6
7
8
9
10
{
  "customer": {
    "labels": [
      {
        "key": "braze_vip_segment",
        "value": "optedIn"
      }
    ]
  }
}

ステップ 2：トリガーを設定する

1. DeliveryまたはEntry Scheduleタブに移動します。
2. 以下のフィールドに入力します。
   • Delivery Method：アクションベース。
   • Trigger：関連するトリガーを定義します（例：ユーザーがBrazeで特定のSegmentに入る）。
   • Launch：Campaignを有効化します。

トラブルシューティング

インバウンドイベントを検証する

データ変換がアクティブになると、データがカスタムイベントとしてBrazeに表示されます。Perform Custom EventトリガーでCampaignを作成し、定義したイベント（例：Loyalty Event Triggered）が利用可能かどうかを確認することで検証できます。

アウトバウンドWebhookを検証する

Brazeのメッセージアクティビティログを確認し、Webhookが200 OKステータスを返したことを確認します。

• 401エラー：Open Loyalty APIトークンを確認してください。
• 404エラー：BrazeのユーザーIDがOpen Loyaltyに存在しません。