Skip to content

Braze間Webhookの作成

Braze間Webhookを使用すると、キャンペーンまたはキャンバス内のWebhookを使って、Braze内からBraze REST APIを呼び出すことができます。APIトリガーキャンバスのトリガーなど、オーケストレーションタスクに使用します。キャンバスからユーザー属性、カスタムイベント、または購入を更新する場合は、代わりにユーザーの更新を使用してください。ユーザープロファイルの変更用に設計されており、更新をより効率的に処理します。

この記事を最大限に活用するには、Webhookの仕組みと、BrazeでWebhookを作成する方法に精通している必要があります。

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

キャンバス内からユーザープロファイルを更新する場合（カスタム属性の変更、カスタムイベントの記録、購入の記録など）は、Braze間Webhookではなくユーザーの更新を使用してください。

ユーザーの更新は複数の変更をグループ化してバッチで送信するため、Webhookよりも高速です。Webhookよりもセットアップが簡単で、高度なJSONコンポーザーを使用した複雑な更新もサポートしています。たとえば、ユーザーがメッセージを閲覧した回数をカウントするには、Braze間Webhookではなくユーザーの更新の値の増減機能を使用してください。

Braze間Webhookを使用するタイミング

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

キャンバスステップからの直接的なユーザー更新以外のシナリオで、Braze内からBrazeのREST APIを呼び出す必要がある場合に、Braze間Webhookを使用できます。一般的な例は以下のとおりです。

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

前提条件

Braze間Webhookを作成するには、到達したいエンドポイントの権限を持つAPIキーが必要です。たとえば、APIトリガーキャンバスをトリガーするには、canvas.trigger.send権限を持つAPIキーが必要です。

Braze間Webhookのセットアップ

Braze間Webhookを作成する一般的なワークフローは以下のステップに従います。

  1. キャンペーンまたはキャンバスコンポーネントとしてWebhookを作成します。
  2. Blank Templateを選択します。
  3. Composeタブで、APIユースケースに合わせてWebhook URLとRequest Bodyを指定します。
  4. Settingsタブで、エンドポイントの要件に応じてHTTP MethodとRequest Headersを指定します。
  5. 追加の配信設定（たとえば、カスタムイベントからのトリガー）を構成し、キャンペーンまたはキャンバスの残りの部分を構築します。

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

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

  1. まず、2番目のキャンバス（最初のキャンバスによってトリガーされるキャンバス）を作成します。
  2. キャンバスのEntry Scheduleで、API-Triggeredを選択します。
  3. キャンバス IDをメモしてください。後のステップで必要になります。
  4. 2番目のキャンバスのステップの構築を続け、キャンバスを保存します。
  5. 最後に、最初のキャンバスを作成します。2番目のキャンバスをトリガーしたいステップを見つけ、Webhookを含む新しいステップを作成します。

Webhookを設定する際は、以下を参照してください。

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

リクエストヘッダーとメソッド

Brazeでは、APIキーを含む許可用のHTTPヘッダーと、コンテンツタイプを宣言するヘッダーが必要です。

  • Request Headers:
    • Authorization: Bearer YOUR_API_KEY
    • Content-Type: application/json
  • HTTP Method: POST

YOUR_API_KEYをcanvas.trigger.send権限を持つBraze APIキーに置き換えてください。APIキーは、BrazeダッシュボードでSettings > API Keysに移動して作成できます。

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

リクエストボディ

テキストフィールドに/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}}}"
    }
  ]
}

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

考慮事項

  • ユーザー更新: キャンバスからユーザープロファイルを更新する場合（属性、イベント、購入）は、効率性とコスト効果を高めるために、Braze間Webhookではなくユーザーの更新を使用してください。
  • Braze間Webhookはエンドポイントのレート制限の対象となります。
  • ユーザープロファイルの更新は全体の消費量にカウントされるデータポイントが発生しますが、メッセージングエンドポイントを通じて別のメッセージをトリガーする場合は発生しません。
  • 匿名ユーザーをターゲットにするには、Webhookのリクエストボディでexternal_idの代わりにbraze_idを使用してください。
  • Braze間WebhookをWebhookテンプレートとして保存して再利用できます。
  • メッセージアクティビティログを確認して、Webhookの失敗を表示およびトラブルシューティングできます。
New Stuff!