Braze-to-Brazeウェブフック

Webhookを使用して、Braze [REST API]2] と通信することができる。私たちはこれをBraze-to-Braze webhook-BrazeからBrazeへ通信するwebhookと呼んでいる。

前提条件

Braze-to-BrazeのWebhookを作成するには、到達したいエンドポイントのパーミッションを持つ[APIキー]3 ]が必要だ。

ユースケース

Braze-to-BrazeのWebhookでできることはたくさんあるが、ここでは一般的な使用例をいくつか紹介しよう：

• ユーザがメッセージを受信すると、カウンタのカスタム属性（整数）をインクリメントする。
• 最初のキャンバスから2番目のキャンバスをトリガーする。

このページの使用例は、[Webhookがどのように機能するか]4 ]と[BrazeでWebhookを作成する方法]5 ]をすでに知っていることを前提としている。

Braze-to-Brazeウェブフックの作成手順

Webhookリクエストの詳細はユースケースによって異なるが、Braze-to-Braze Webhookを作成するための一般的なワークフローは変わらない。

1. [キャンペーンまたはキャンバスのコンポーネントとしてウェブフック]5 を作成する。
2. 空白のテンプレートを選択する。
3. Composeタブで、Webhook URLと Request Bodyをユースケースに応じて指定する。
4. Settings “タブで、HTTPメソッドと リクエスト・ヘッダを指定する。
5. 必要に応じて、Webhookの残りの部分を構築し続ける。ユースケースによっては、カスタムイベントからキャンペーンやキャンバスをトリガーするなど、特定の配信設定が必要なものもある。

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

この使用例では、カスタム属性を作成し、特定のアクションが発生した回数をカウントするためにLiquidを使用する。

例えば、ユーザーがアクティブなアプリ内メッセージ・キャンペーンを何回見たかをカウントし、3回見たら二度とキャンペーンを受け取らないようにしたい場合がある。BrazeのLiquidロジックで何ができるか、より多くのアイデアについては、Liquidユースケースライブラリをチェックしよう。

Braze-to-BrazeのWebhookを作成するための一般的な手順に従い、Webhookを設定する際には以下を参照すること：

• Webhook URL:あなたの[RESTエンドポイントURL]7 の後に/users/track.例えば、US-06のインスタンスの場合、URLはhttps://rest.iad-06.braze.com/users/track となる。
• 要求本文:Raw Text

リクエストヘッダと方法

Brazeは認証のために、APIキーとcontent-type を宣言するHTTPヘッダーを要求する。

• 要求ヘッダー:
  • 認可する：Bearer {YOUR_API_KEY}
  • Content-Type:application/json
• HTTP メソッド:POST

YOUR_API_KEY を、users.track 権限を持つ Braze API キーに置き換える。APIキーは、Brazeダッシュボードの「設定」>「APIキー」で作成できる。

Request body

リクエストボディにユーザートラックリクエストを追加し、リキッドにカウンタ変数を代入する。詳しくは[ユーザートラック]8]を参照のこと。

以下は、このエンドポイントに必要なリキッドとリクエストボディの例である。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}}"
        }
    ]
}

ユースケース:最初のキャンバスから2番目のキャンバスをトリガーする

この使用例では、2つのCanvasを作成し、最初のCanvasから2つ目のCanvasをトリガーするためにウェブフックを使用する。これは、ユーザーが別のキャンバスのあるポイントに到達したときのエントリートリガーのような役割を果たす。

1. 最初のキャンバスによってトリガーされるキャンバスである。
2. キャンバスの入力スケジュールで、API-Triggeredを選択する。
3. キャンバスIDを控えておくこと。これは後のステップで必要になる。
4. 2つ目のキャンバスのステップを作り続け、キャンバスを保存する。
5. 最後に、最初のキャンバスを作成する。2つ目のキャンバスをトリガーしたいステップを見つけ、ウェブフック付きの新しいステップを作成する。

ウェブフックを設定する際は、以下を参照のこと：

• Webhook URL:あなたの[RESTエンドポイントURL]7 の後にcanvas/trigger/send.例えば、US-06のインスタンスの場合、URLはhttps://rest.iad-06.braze.com/canvas/trigger/send となる。
• 要求本文:Raw Text

リクエストヘッダと方法

Brazeは認証のために、APIキーとcontent-type を宣言するHTTPヘッダーを要求する。

• 要求ヘッダー:
  • 認可する：ベアラー YOUR_API_KEY
  • Content-Type:application/json
• HTTP メソッド:POST

YOUR_API_KEY を、canvas.trigger.send 権限を持つ Braze API キーに置き換える。APIキーは、Brazeダッシュボードの「設定」>「APIキー」で作成できる。

Request body

テキストフィールドにcanvas/trigger/send リクエストを追加する。詳細については、[APIトリガー配信によるCanvasメッセージの送信]9 を参照のこと。以下は、このエンドポイントのリクエストボディの例である。your_canvas_id は、2番目のキャンバスのキャンバス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ウェブフックをテンプレートとして保存し、再利用することができる。
• メッセージ・アクティビティ・ログをチェックして、ウェブフックの失敗を確認し、トラブルシューティングすることができる。