Skip to content

Braze to Braze webhookを作成する

Braze to Braze webhookは、キャンペーンやCanvas内のWebhookを使用して、Braze内部からBraze REST APIを呼び出すことを可能にする。APIトリガーのキャンバスを起動するといったオーケストレーションタスクにこれを使え。キャンバスからユーザー属性、カスタムイベント、または購入を更新するには、代わりにユーザー更新を使用する。ユーザープロファイルの変更に対応し、更新処理をより効率的に行うように設計されている。

この記事を最大限に活用するには、webhookの仕組みと、Brazeでwebhookを作成する方法について理解しておく必要がある。

ユーザーデータの変更にはユーザー更新を使用する

カスタム属性の変更、カスタムイベントの記録、購入の記録を含む、キャンバス内からのユーザープロファイル更新には、Braze to Braze webhookではなくUser Updateを使用する。

ユーザー更新は複数の変更をまとめてバッチ処理で送信するため、Webhookよりも高速だ。Webhookよりも設定が簡単で、高度なJSONコンポーザーを通じて複雑な更新をサポートする。例えば、ユーザーがメッセージを何回見たかを数えるには、Braze to Braze webhookではなく、User Updateのインクリメントとデクリメント機能を使う。

Braze to Braze webhookの使用タイミング

ユーザー更新機能は、ユーザープロファイルを更新するためのBraze to Braze webhookとほぼ同じタスクを処理できる。単純なカスタム属性を超える複雑な更新には、高度なJSONコンポーザーを使用できる。

Brazeのステップから直接ユーザーを更新する以外のシナリオで、Braze内部からBrazeのREST APIを呼び出す必要がある場合、Braze to Braze webhookを使用できる。一般的な例としては：

キャンバス内でのユーザー更新については、ユーザー更新を使用することを推奨する。

前提条件

BrazeからBrazeへのWebhookを作成するには、接続したいエンドポイントへの権限を持つAPI キーが必要だ。例えば、APIトリガーのキャンバスを起動するには、そのcanvas.trigger.send権限を持つAPI キーが必要だ。

Braze-to-Braze Webhook の設定

BrazeからBrazeへのWebhookを作成する一般的なワークフローは、以下のステップに従う：

  1. キャンペーンまたはキャンバスのコンポーネントとして ウェブフックを作成します。
  2. [空白のテンプレート] を選択します。
  3. コンポーズタブで、APIのユースケースに合わせてWebhookのURLとリクエストボディを指定する。
  4. 設定タブで、エンドポイントの要求に応じてHTTPメソッドとリクエストヘッダーを指定する。
  5. 追加の配信設定（例：カスタムイベントからのトリガー）を構成し、キャンペーンまたはキャンバスの残りの部分を構築する。

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

このユースケースでは、2つのキャンバスを作成し、BrazeからBrazeへのwebhookを使用して、最初のキャンバスから2番目のキャンバスをトリガーする。これは、ユーザーが別のキャンバス内の特定ポイントに到達したときのエントリトリガーのような役割を果たします。

  1. まず、2 つ目のキャンバスを作成します。これは最初のキャンバスによってトリガーされるキャンバスです。
  2. キャンバスのエントリスケジュールで、[API トリガー] を選択します。
  3. キャンバス ID を書き留めます。後でこのステップが必要になる。
  4. 続いて 2 つ目のキャンバスのステップを作成し、キャンバスを保存します。
  5. 最後に、最初のキャンバスを作成する。2つ目のキャンバスをトリガーしたいステップを見つけ、ウェブフック付きの新しいステップを作成する。

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

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

リクエストヘッダーと方法

Brazeは認証のためにHTTPヘッダーを必要とする。そのヘッダーにはAPI キーを含める必要がある。また、コンテンツタイプを宣言する別のヘッダーも必要だ。

  • リクエストヘッダー：
    • 承認： Bearer YOUR_API_KEY
    • Content-Type: application/json
  • HTTPメソッド： POST

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

Brazeダッシュボードで、WebhookのリクエストヘッダーにAuthorizationとContent-Typeフィールドが表示される。

Request body

テキストフィールドに/canvas/trigger/send リクエストを追加する。詳細は、APIトリガーによる配信でCanvasメッセージを送信するを参照のこと。以下はこのエンドポイントのリクエスト本文の例です。ここで your_canvas_id は、2 つ目のキャンバスのキャンバス ID です:

1
2
3
4
5
6
7
8

{
  "canvas_id": "your_canvas_id",
  "recipients": [
    {
      "external_user_id": "{{${user_id}}}"
    }
  ]
}

ユーザーが最初のキャンバスでこのWebhookステップに到達すると、BrazeはAPI経由でそのユーザーに対して2つ目のキャンバスをトリガーする。

考慮事項

  • ユーザー更新：Canvasからのユーザープロファイル更新（属性、イベント、購入履歴）には、効率性と費用対効果を高めるため、Braze to Braze webhookではなくユーザー更新機能を使用する。
  • Braze to Braze webhookはエンドポイントのレート制限の対象となる。
  • ユーザープロファイルの更新は、全体の消費量にカウントされるデータポイントを生成する。一方、メッセージングエンドポイントを通じた別のメッセージの送信は、データポイントを消費しない。
  • 匿名ユーザーを対象とするには、Webhookのリクエスト本文で external_idの代わりに braze_idを使用する。
  • Braze to Braze webhookは、再利用可能なWebhookテンプレートとして保存できる。
  • メッセージアクティビティログをチェックして、Webhook の失敗を確認し、トラブルシューティングすることができる。
Github   GitHub でこのページを編集
New Stuff!