ウェブフックの作成

Webhookキャンペーンを作成するか、マルチチャネルキャンペーンにWebhookを含めると、アプリ以外のアクションをトリガーできます。具体的には、Webhook を使用して他のシステムやアプリケーションにリアルタイムの情報を提供できます。

ウェブフックを使用して Salesforce や Marketo などのシステムに情報を送信できます。Webhook を使用してバックエンドシステムに情報を送信することもできます。たとえば、顧客がカスタムイベントを一定回数実行した後に、プロモーションを顧客のアカウントにクレジットしたい場合があります。

ウェブフックとは何か、Braze でどのように使用できるかについて詳しく知りたい場合は、先に進む前に「ウェブフックについて」をご覧ください。

ステップ 1:メッセージを作成する場所を選択してください

メッセージをキャンペーンとキャンバスのどちらを使用して送信すべきかわからない?キャンペーンは単一のシンプルなメッセージキャンペーンに適していますが、キャンバスは複数段階のユーザージャーニーに適しています。

• campaign
• canvas

ステップ 2:ウェブフックを作成

Webhook をゼロから作成するか、既存のテンプレートのいずれかを使用するかを選択できます。次に、エディターの [作成] タブでウェブフックを作成します。

「作成」タブは以下のフィールドで構成されています。

言語

国際化は URL とリクエスト本文でサポートされています。メッセージを国際化するには、「言語を追加」をクリックして必須フィールドに入力します。Liquidの該当箇所にテキストを入力できるように、コンテンツを書く前に言語を選択することをおすすめします。利用可能な言語の一覧をご覧ください。

Webhook URL

ウェブフック URL または HTTP URL は、エンドポイントを指定します。エンドポイントは、Webhook でキャプチャした情報を送信する場所です。ベンダーに情報を送信する場合、ベンダーはこの URL を API ドキュメントに記載する必要があります。自社のシステムに情報を送信する場合は、開発チームまたはエンジニアリングチームに問い合わせて、正しい URL を使用していることを確認してください。

Braze では、標準ポート 80 (HTTP) および 443 (HTTPS) を介して通信する URL のみを許可しています。

Liquidを使用してウェブフックURLをパーソナライズできます。特定のエンドポイントでは、ユーザーを特定したり、URL の一部としてユーザー固有の情報を提供したりする必要がある場合があります。Liquidを使用するときは、URLに使用するユーザー固有の情報ごとにデフォルト値を必ず含めてください。

リクエスト本文

リクエストボディは、指定した URL に送信される情報です。Webhook リクエストの本文を作成するには 2 つの方法があります。

JSON キーと値のペア

JSON キーと値のペアを使用すると、JSON 形式を必要とするエンドポイントへのリクエストを簡単に記述できます。この機能は、JSON リクエストを必要とするエンドポイントでのみ使用できます。たとえば、キーがの場合message_body、対応する値はになりますYour order just arrived!。キーと値のペアを入力すると、コンポーザーがリクエストを JSON 構文で設定し、JSON リクエストのプレビューが自動的に表示されます。

Liquidを使用して、ユーザー属性、カスタム属性、またはイベントプロパティをリクエストに含めるなど、キーと値のペアをパーソナライズできます。たとえば、顧客の名とメールアドレスをリクエストに含めることができます。各属性にデフォルト値を含めることを忘れないでください。

生のテキスト

未加工テキストオプションを使用すると、任意の形式の本文を想定するエンドポイントへのリクエストを柔軟に記述できます。たとえば、この機能を使用して、リクエストが XML 形式であることを期待するエンドポイントへのリクエストを作成できます。[Liquidを使用したパーソナライゼーションと国際化の両方が未加工テキストでサポートされています][16]。

Content-Typeリクエストヘッダーをに設定する場合application/x-www-form-url-encoded、リクエスト本文は URL でエンコードされた文字列としてフォーマットする必要があります。例えば:

1
to={{custom_attribute.${example}}}&text=Your+order+just+arrived

ステップ 3:その他の設定を行う

リクエストヘッダー (オプション)

特定のエンドポイントでは、リクエストにヘッダーを含める必要がある場合があります。コンポーザーの「設定 (Settings)」セクションでは、ヘッダーをいくつでも追加できます。一般的なリクエストヘッダーは、Content-Type仕様 (XML や JSON など、本文にどのような種類のデータが含まれるのかを記述したもの) と、ベンダーまたはシステムの認証情報を含む認証ヘッダーです。

コンテンツタイプの指定にはキーを使用する必要がありますContent-Type。application/jsonapplication/x-www-form-urlencoded一般的な値はまたはです。

認証ヘッダーはキーを使用する必要がありますAuthorization。一般的な値は、Bearer {{YOUR_TOKEN}}Basic {{YOUR_TOKEN}}YOUR_TOKENベンダーまたはシステムから提供された認証情報です。

HTTP メソッド

使用すべき HTTP メソッドは、情報を送信するエンドポイントによって異なります。ほとんどの場合、POST を使用します。

ステップ 4: メッセージをテスト送信

キャンペーンを公開する前に、BrazeはWebhookをテストしてリクエストが適切にフォーマットされていることを確認することを推奨しています。

そのためには、[テスト] タブに切り替えて、テスト Webhook を送信します。Webhookは、ランダムユーザー、特定のユーザー（メールアドレスまたは外部ユーザーIDを入力）、または任意の属性を持つカスタマイズされたユーザーとしてテストできます。

テスト Webhook を送信すると、応答メッセージを含むダイアログが表示されます。Webhook リクエストが失敗した場合は、エラーメッセージを参照して Webhook のトラブルシューティングに役立ててください。次の例では、ウェブフック URL が無効な Web フックの応答の詳細を示しています。

```json 404 見つかりません

{ “error”: { “message”: “Unrecognized request URL. Please see https://lob.com/docs or email us at [email protected].”, “status_code”: 404 } }

```

ステップ 5: 残りのキャンペーンやキャンバスを作成

• campaign
• canvas

ステップ 6:確認とデプロイ

最後のキャンペーンやキャンバスの作成が終わったら、詳細を確認してテストし、送信しましょう！

知っておくべきこと

エラー、リトライロジック、タイムアウト

Webhookは、Brazeサーバーが外部エンドポイントにリクエストを行うことに依存しているため、構文やその他のエラーが発生する可能性があります。Webhookエラーを回避するための最初のステップは、Webhookキャンペーンの構文エラーをテストし、パーソナライズされた変数にデフォルト値があることを確認することです。ただし、APIキーの期限切れ、レート制限、予期しないサーバーエラーなどの問題が原因で、Webhookが機能しなくなる可能性があります。Webhook が送信に失敗すると、エラーメッセージが メッセージアクティビティログ に記録されます。

この説明には、エラーが発生した時刻、アプリ名、およびエラーメッセージが含まれています。

メッセージ本文がエラーの原因について十分に明確でない場合は、使用している API エンドポイントのドキュメントを確認する必要があります。これらは通常、エンドポイントが使用するエラーコードとその一般的な原因の説明を提供します。

他のキャンペーンと同様に、BrazeはWebhookキャンペーンの配信とそれらから生じるコンバージョンを追跡します。Webhook リクエストが送信されると、受信サーバーはリクエストで何が起こったかを示す応答コードを返します。次の表は、サーバーが送信する可能性のあるさまざまな応答、それらがキャンペーン分析に与える影響、エラーが発生した場合に Braze がキャンペーンの再配信を試みるかどうかをまとめたものです。

再試行すると、Brazeは指数バックオフを使用して約30分間5回試行した後、個々のWebhook呼び出しを中止します。

各 Webhook は、タイムアウトの 90 秒前に許可されます。

IP 許可リスト

BrazeからWebhookが送信されると、Brazeサーバーはお客様または第三者のサーバーにネットワークリクエストを送信します。IP許可リストを使用すると、Webhooksリクエストが実際にBrazeから送信されていることを確認でき、セキュリティがさらに強化されます。

Braze は次の IP アドレスからウェブフックを送信します。リストされている IP は、許可リストにオプトインされているすべての API キーに自動的かつ動的に追加されます。

Braze パートナーとのウェブフックの使用

Webhook を利用する方法は多数ありますが、当社のテクノロジーパートナー (Alloys) では、Webhook を使用して顧客やユーザーとの直接的なコミュニケーションを強化できます。

チェックアウト:

• メッセンジャー
• リマージ
• Lob.com * そして、さらに多くのテクノロジーパートナー！