Braze-to-Braze Webhook (ろう付け Webhook)

Webhookを使用してBraze REST APIと通信し、基本的にAPIでできることはすべて行うことができます。これを Braze-to-Braze Webhook (Braze から Braze への通信を行う Webhook) と呼びます。

前提 条件

Braze-to-Braze Webhook を作成するには、アクセスするエンドポイントの権限を持つ API キー が必要です。

ユースケース

Braze-to-Braze Webhook でできることはたくさんありますが、ここでは一般的なユースケースをいくつか紹介します。

• ユーザーがメッセージを受信したときにカウンターの整数カスタム属性をインクリメントします。
• 最初の Canvas から 2 つ目の Canvas をトリガーします。

このページのユースケースは、BrazeのWebhookの仕組みとWebhookの作成の方法に精通していることを前提としています。

Braze-to-Braze Webhook の作成手順

Webhook リクエストの詳細はユースケースごとに異なりますが、Braze-to-Braze Webhook を作成するための一般的なワークフローは同じです。

1. Webhookを作成する キャンペーンまたはキャンバスコンポーネントとして。
2. [Blank Template] を選択します。
3. [ 作成 ] タブで、ユースケースのメモに従って [Webhook URL ] と [要求本文 ] を指定します。
4. [ 設定 ] タブで、ユースケースのメモに従って [HTTP メソッド ] と [要求ヘッダー ] を指定します。
5. 必要に応じて、残りの Webhook の構築を続けます。一部のユースケースでは、カスタムイベントからキャンペーンやキャンバスをトリガーするなど、特定の配信設定が必要です。

ユースケース：カウンターの整数カスタム属性をインクリメントする

このユースケースでは、カスタム属性を作成し、Liquidを使用して特定のアクションが発生した回数をカウントします。

たとえば、ユーザーがアクティブなアプリ内メッセージキャンペーンを見た回数をカウントし、3回表示した後は再度キャンペーンを受け取らないようにすることができます。BrazeのLiquidロジックで何ができるかについては、 Liquidのユースケースライブラリをご覧ください。

Braze-to-Braze Webhook を作成するための一般的な手順に従い、Webhook を設定する際に以下を参照してください。

• Webhook URL:REST エンドポイント URL の後に /users/track.たとえば、US-06 インスタンスの場合、URL は https://rest.iad-06.braze.com/users/trackになります。
• 要求本文:生のテキスト

要求ヘッダーとメソッド

Brazeでは、認証のためにAPIキーを含むHTTPヘッダーと content-type、.

• 要求ヘッダー:
  • 認可：Bearer {YOUR_API_KEY}
  • コンテンツタイプ: application/json
• HTTP メソッド:ポスト:

YOUR_API_KEY権限のあるusers.trackBraze APIキーに置き換えてください。APIキーは、Brazeダッシュボードの [設定 ]> [APIキー]で作成できます。

リクエスト本文

リクエスト本文とLiquidにユーザートラックリクエストを追加して、カウンター変数を割り当てます。詳しくはユーザートラックを参照してください。

以下は、このエンドポイントに必要な Liquid と要求本文の両方の例であり、 your_attribute_count はユーザーがメッセージを見た回数をカウントするために使用している属性です。

1
2
3
4
5
6
7
8
9
{% assign new_number = {{custom_attribute.${your_attribute_count}}} | plus: 1 %}
{
    "attributes": [
        {
        "external_id": "{{${user_id}}}",
        "your_attribute_count": "{{new_number}}"
        }
    ]
}

ユースケース：最初の Canvas から 2 つ目の Canvas をトリガーする

このユースケースでは、2 つの Canvas を作成し、Webhook を使用して最初の Canvas から 2 番目の Canvas をトリガーします。これは、ユーザーが別のキャンバスの特定のポイントに到達したときのエントリトリガーのように機能します。

1. まず、2 つ目の Canvas (最初の Canvas によってトリガーされる Canvas) を作成します。
2. [Canvas Entry Schedule (キャンバスエントリスケジュール)] で [ API トリガー] を選択します。
3. キャンバス ID をメモします。これは後の手順で必要になります。
4. 2 つ目の Canvas のステップの作成を続行し、Canvas を保存します。
5. 最後に、最初のキャンバスを作成します。2 番目の Canvas をトリガーするステップを見つけ、Webhook を使用して新しいステップを作成します。

Webhook を構成するときは、以下を参照してください。

• Webhook URL:REST エンドポイント URL の後に canvas/trigger/send.たとえば、US-06 インスタンスの場合、URL は https://rest.iad-06.braze.com/canvas/trigger/sendになります。
• 要求本文:生のテキスト

要求ヘッダーとメソッド

Brazeでは、認証のためにAPIキーを含むHTTPヘッダーと content-type、.

• 要求ヘッダー:
  • 認可：持参人 YOUR_API_KEY
  • コンテンツタイプ: application/json
• HTTP メソッド:ポスト:

YOUR_API_KEY権限のあるcanvas.trigger.sendBraze APIキーに置き換えてください。APIキーは、Brazeダッシュボードの [設定 ]> [APIキー]で作成できます。

リクエスト本文

canvas/trigger/sendテキストフィールドにリクエストを追加します。詳細は、APIトリガー配信によるCanvasメッセージの送信を参照してください。以下は、このエンドポイントの要求本文の例で、 your_canvas_id は 2 番目の Canvas の Canvas ID です。

1
2
3
4
5
6
7
8
{
      "canvas_id": "your_canvas_id",
      "recipients": [
        {
          "external_user_id": "{{${user_id}}}"
         }
      ]
}

知っておきたいこと

• Braze-to-Braze Webhook には、エンドポイント のレート制限が適用されます。
• ユーザー プロファイルを更新すると追加の データ ポイントが発生しますが、メッセージング エンドポイントを介して別のメッセージをトリガーすると発生しません。
• 匿名ユーザーをターゲットにする場合は、Webhook の要求本文ではなく、代わりにexternal_id使用できますbraze_id。
• Braze-to-Braze Webhook を テンプレート として保存し、再利用することができます。
• メッセージ アクティビティ ログを確認して、Webhook のエラーを表示およびトラブルシューティングできます。