Skip to content

Brazeラーニングコースwebhookについて

このリファレンス記事では、Webhookの基本をカバーし、独自のWebhookを作成するために必要な構成要素を提供する。BrazeでWebhookを作成する手順をお探し？ウェブフックの作成」を参照のこと。

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

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

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

ユースケース

Webhookはシステム同士を接続する優れた方法である-結局のところ、Webhookはアプリが通信する方法なのだ。ウェブフックが特に役立つ一般的なシナリオをいくつか紹介しよう：

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

より具体的な使用例としては、以下のようなものがある：

  • ユーザーがメール配信を停止した場合、WebhookでアナリティクスデータベースやCRMに同じ情報を更新させることができ、ユーザーの行動を全体的に把握することができる。
  • FacebookメッセンジャーやLINE内でユーザーにトランザクションメッセージを送信する。
  • Webhooksを使用して、以下のようなサードパーティ・サービスと通信することで、アプリ内やWebでのアクティビティに応じて顧客にダイレクトメールを送信する。 Lob.com.
  • ゲーマーのレベルが一定に達したり、ポイントが一定数に達したら、ウェブフックと既存のAPIセットアップを使って、キャラクターのアップグレードやコインを直接アカウントに送る。マルチチャネル・メッセージング・キャンペーンの一環としてウェブフックを送信する場合、プッシュやその他のメッセージを送信して、ゲーマーに報酬を同時に知らせることができる。
  • もしあなたが航空会社なら、ウェブフックと既存のAPIセットアップを利用して、顧客が一定数のフライトを予約した後、顧客のアカウントに割引をクレジットすることができる。
  • 無限の “If This Then That”（IFTTT）レシピ-例えば、顧客がEメールでアプリにサインインすると、そのアドレスが自動的にSalesforceに設定される。

ウェブフックの構造

ウェブフックは以下の3つの部分から構成される：

HTTPメソッド、HTTP URL、リクエスト・ボディに分割されたウェブフックの例。詳細は以下の表を参照のこと。

Webhookの一部 説明
HTTPメソッド APIと同様に、ウェブフックにはリクエスト・メソッドが必要だ。これらは、ウェブフックがヒットするURLに与えられ、与えられた情報で何をすべきかをエンドポイントに伝える。指定できるHTTPメソッドは4つある：POST、GET、PUT、DELETEである。
HTTP URL ウェブフック・エンドポイントのURLアドレス。エンドポイントは、ウェブフックに取り込んだ情報を送信する場所だ。
Request body Webhookのこの部分には、エンドポイントに伝える情報が含まれている。リクエスト・ボディはJSONキー・バリュー・ペアか生のテキストである。

HTTPメソッド

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

HTTPメソッド 説明
POST このメソッドは、受信サーバーに新しい情報を書き込む。実際のアプリケーションでPOSTメソッドを使う一般的な例としては、ウェブサイトの問い合わせフォームがある。フォームに入力した情報はすべてリクエストボディの一部となり、レシーバーに送信される。これはデータを送信する際に最もよく使われる方法である。
GET この方法は、新しい情報を書き込むのではなく、既存の情報を検索する。これは、サーバーにデータを要求するときに使われる最も一般的な方法である。例えば、/segments/list 。GETリクエストをすると、セグメントのリストが返される。
プット このメソッドは、エンドポイント上の情報を更新し、既存の情報をリクエスト・ボディの内容と置き換える。
削除 このメソッドはHTTP URLのリソースを削除する。

BrazeのWebhooks

Brazeでは、Webhookキャンペーン、APIキャンペーン、またはCanvasコンポーネントとしてWebhookを作成できる。

  1. Brazeのダッシュボードで、Campaignsに行く。
  2. Create Campaignをクリックし、Webhookを選択する。

詳しくはウェブフックの作成を参照のこと。

  1. Brazeのダッシュボードで、Campaignsに行く。
  2. Create Campaignをクリックし、API Campaignを選択する。
  3. Add Messagesをクリックし、Webhookを選択する。
  4. Webhookオブジェクトを含むようにAPIコールをフォーマットする。

詳しくはウェブフックの作成を参照のこと。

  1. キャンバスで、新しいコンポーネントを作成する。
  2. コンポーネントのMessageセクションで、Webhookを選択する。

詳しくはウェブフックの作成を参照のこと。

  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!