ウェブフックについて

この参考記事では、ウェブフックの基本について説明し、独自のウェブフックを作成するために必要なビルディングブロックについて説明しています。Braze でウェブフックを作成する手順をお探しですか？「ウェブフックの作成」 を参照してください。

Webhook は、アプリケーションがリアルタイムでデータを共有するための一般的な通信手段です。今日では、すべてを実行できるスタンドアロンアプリケーションはほとんどありません。ほとんどの場合、特定のタスクの実行に特化したさまざまなアプリやシステムで作業していますが、これらのアプリはすべて相互に通信できる必要があります。そこでウェブフックの出番です。

ウェブフックは、特定の基準が満たされた後に、あるシステムから別のシステムへの自動メッセージです。Braze では、通常、この基準によってカスタムイベントがトリガーされます。

基本的に、Webhookは、2つの別々のシステムがリアルタイムで送信されるデータに基づいて効果的なアクションを実行するためのイベントベースの方法です。このメッセージには、特定のタスクをいつ、どのように実行するかを受信システムに伝える指示が含まれています。そのため、Webhook を使用すると、データやプログラム機能へのより動的で柔軟なアクセスが可能になり、プロセスを合理化するカスタマージャーニーを設定できるようになります。

ユースケース

Webhook はシステムを相互に接続するための優れた方法です。結局のところ、Webhook はアプリの通信手段です。Webhook が特に役立つ一般的なシナリオは次のとおりです。

• Braze へのデータ送信と Braze からのデータ送信
• Braze が直接サポートしていないチャネルを経由して顧客にメッセージを送信
• Braze API への投稿

より具体的なユースケースには、次のようなものがあります。

• ユーザーがメールの購読を解除した場合、Webhookに同じ情報で分析データベースまたはCRMを更新してもらい、そのユーザーの行動を全体的に把握できるようにすることができます。
• Facebook メッセンジャーまたは Line 内のユーザーにトランザクションメッセージを送信します。
• ウェブフックを使用してLOB.comなどのサードパーティサービスと通信することで、アプリ内アクティビティやウェブアクティビティに応じて顧客にダイレクトメールを送信します。
• ゲーマーが特定のレベルに達したり、特定のポイント数を獲得したりした場合は、Webhookと既存のAPI設定を使用して、キャラクターのアップグレードまたはコインをアカウントに直接送信します。マルチチャネルメッセージングキャンペーンの一環としてウェブフックを送信する場合、プッシュメッセージやその他のメッセージを送信して、同時にゲーマーに報酬について知らせることができます。
• 航空会社の場合は、Webhook と既存の API 設定を使用して、顧客が一定数のフライトを予約した後に、顧客のアカウントに割引を付与できます。
• 「If This Then That」(IFTTT) レシピは無限にあります。たとえば、顧客がメールでアプリケーションにログインした場合、そのアドレスを自動的に Salesforce に設定できます。

ウェブフックの構造

ウェブフックは次の 3 つの部分で構成されています。

ウェブフックの一部	説明
HTTP メソッド	API と同様に、ウェブフックにはリクエストメソッドが必要です。これらはWebhookがヒットしたURLに渡され、与えられた情報をどう処理するかをエンドポイントに指示します。指定できる HTTP メソッドは 4 つあります。投稿、取得、入力、削除。
HTTP URL	ウェブフックエンドポイントの URL アドレス。エンドポイントは、Webhook でキャプチャした情報を送信する場所です。
リクエストボディ	Webフックのこの部分には、エンドポイントに通信している情報が含まれています。リクエスト本文は JSON のキーと値のペアでも、未加工のテキストでもかまいません。

HTTP メソッド

次の表では、Webhook で指定できる 4 種類の HTTP メソッドについて説明します。

HTTP メソッド	説明
POST	このメソッドは、受信サーバーに新しい情報を書き込みます。実際のアプリケーションでの POST メソッドの一般的な例は、Web サイトのコンタクトフォームです。フォームに入力した情報はすべてリクエストボディの一部となり、受信者に送信されます。これは、データを送信するときに使用される最も一般的な方法です。
GET	このメソッドは、新しい情報を書き込むのではなく、既存の情報を取得します。これは、サーバーからデータを要求するときに使用される最も一般的な方法です。/segments/listエンドポイントを例にとってみましょう。GET リクエストを行うと、セグメントのリストが返されます。
PUT	このメソッドは、エンドポイントの情報を更新し、既存の情報をリクエスト本文の内容に置き換えます。
削除	このメソッドは、HTTP URL内のリソースを削除します。

Braze のウェブフック

Braze では、ウェブフックをウェブフックキャンペーン、API キャンペーン、または Canvas コンポーネントとして作成できます。

• webhook campaign
• api campaign
• canvas component