Webhookを作成する

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

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

webhookとは何か、またBrazeでの使用方法について詳しく知りたい場合は、先にwebhookについてをご覧ください。

ステップ 1:メッセージを作成する場所を選択する

メッセージは、キャンペーンとキャンバスのどちらを使用して配信すべきでしょうか。キャンペーンは単一のシンプルなメッセージングキャンペーンに適していますが、キャンバスはマルチステップのユーザーのジャーニーに適しています。

• キャンペーン
• キャンバス

ステップ 2:Webhookを作成する

Webhookをゼロから構築するか、既存のテンプレートのいずれかを使用するかを選択できます。次に、エディタのComposeタブでWebhookを構築します。

「作成」タブには次のフィールドが含まれています:

言語

国際化は、URLおよびリクエストボディでサポートされています。メッセージを国際化するには、言語を追加をクリックして、必要なフィールドに記入してください。コンテンツを書く前に言語を選択することをお勧めします。そうすれば、Liquidに適切な場所にテキストを入力できます。利用可能な言語の完全なリストをご覧ください。

Webhook URL

Webhook URL、またはHTTP URLは、エンドポイントを指定します。エンドポイントは、Webhookでキャプチャしている情報を送信する場所です。ベンダーに情報を送信したい場合、ベンダーはAPIドキュメントにこのURLを提供する必要があります。自分のシステムに情報を送信する場合は、開発チームまたは開発チームに確認して、正しいURLを使用していることを確認してください。

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

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

Request body

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

JSONキーと値のペア

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

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

生のテキスト

生のテキストオプションを使用すると、任意の形式の本文を期待するエンドポイントへのリクエストを作成する柔軟性が得られます。例えば、この機能を使用して、リクエストがXML形式であることを期待するエンドポイントへのリクエストを作成することができます。両方のパーソナライゼーションと国際化は、Liquidを使用して生のテキストでサポートされています。

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

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

ステップ 3:追加設定を構成する

リクエストヘッダー（オプション）

特定のエンドポイントでは、リクエストにヘッダーを含める必要がある場合があります。作成者の設定セクションでは、好きなだけヘッダーを追加できます。一般的なリクエストヘッダーはContent-Type仕様（本文にどのようなデータが含まれるかを示すもので、XMLやJSONなど）と、ベンダーやシステムに対する認証情報を含む認証ヘッダーです。

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

Authorization headers must use the key Authorization.一般的な値は Bearer {{YOUR_TOKEN}}またはBasic {{YOUR_TOKEN}} で、YOUR_TOKENはベンダーまたはシステムによって提供される資格情報です。

HTTPメソッド

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

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

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

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

テストWebhookを送信した後、応答メッセージが表示されるダイアログが表示されます。Webhookリクエストが失敗した場合は、トラブルシューティングのためにエラーメッセージを参照してください。次の例は、無効なWebhook URLを持つWebhookの応答を詳述しています。

1
2
3
4
5
6
7
8
9
404 Not Found

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

ステップ 5: キャンペーンまたはキャンバスの残りの部分を作成する

• キャンペーン
• キャンバス

ステップ 6:レビューと展開

キャンペーンまたはキャンバスの最後の構築が完了したら、その詳細を確認し、テストしてから送信してください！

知っておくべきこと

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

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

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

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

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

BrazeはWebhookの送信を最大24時間再試行します。再試行する場合、Braze は指数バックオフを使用して約 30 分間にわたって FIVE 回試行し、個々の Webhook 呼び出しを中止します。

各Webhookはタイムアウトするまでに90秒が許可されています。

IP 許可リスト

BrazeからWebhookが送信されると、Brazeサーバーは顧客またはサードパーティのサーバーにネットワークリクエストを行います。IP許可リストを使用すると、WebhookリクエストがBrazeから送信されていることを確認でき、セキュリティの層が追加されます。

Brazeは次のIPからwebhookを送信します。記載されているIPは、許可リストにオプトインしたすべてのAPIキーに自動的かつ動的に追加されます。

Brazeパートナー{#utilizing-webhooks}とwebhookを使用する

webhookを使用する方法はたくさんあり、私たちの技術パートナー（Alloys）と一緒に、顧客やユーザーと直接コミュニケーションを向上させるためにwebhookを使用できます。

チェックアウト：

• Messenger
• Remerge
• Lob.com
• そして、私たちの多くの技術パートナーも！