Workflows

ワークフローでウェブフックを使用する方法

更新日時 February 8, 2018

対象製品

Marketing Hub Professional, Enterprise

この記事は、ワークフローのウェブフック機能を使用して、HubSpotから外部のウェブアプリケーションに情報を受け渡す必要があるウェブ開発者を対象としています。


ウェブフックとは

ウェブフックとは、ウェブアプリケーションで何らかのアクションが完了したときに、そのアプリケーションから別のウェブアプリケーションにデータを送るための機能です。人間がEメールでメッセージを交換するように、ソフトウェアプラットフォームはウェブフックによってHTTPリクエストを行い、情報をやり取りします。ウェブフックを使用すると、データ、通知、アラートなど、リアルタイムの最新情報を送信できます。つまり、ウェブフックを活用すれば、アプリケーションやシステム間でデータを送受信できるので、マーケティングの自動化に大いに役立ちます。

想定される使用例

ウェブフックは一般的に次の用途に使用されます。

  • コンタクトがサイト内のフォームから情報を送信したときに、HubSpotのコンタクトデータをCRMなどの外部システムに送信する

  • 外部システムにコンタクトデータを送信して、コンタクトにソフトウェアのトライアルを提供する

  • 重要なイベントが発生したときに、外部システムから社内のチャットストリームにアラートを送信して、従業員に通知する

HubSpotでウェブフックをセットアップする方法

  • HubSpot Marketingを開いて、[コンタクト]、[ワークフロー]の順に移動します。
  • 新しいワークフローを作成するか、既存のワークフローを選択します。
  • プラス(+)アイコンをクリックして、新しいアクションを追加します。

  • ウェブフックをトリガー]を選択します。
  • ドロップダウンから[GET]または[POST]を選択します。
    • GET - 指定されたURLにGETリクエストを送信
    • POST - 指定されたURLにPOSTリクエストを送信(データを送信)
  • ウェブフックURLを入力します。
  • システムへのリクエスト送信に認証が必要な場合は、[認証を使用]のチェックボックスをオンにして、ユーザー名とパスワードを入力します。この設定を行うと、ユーザーエージェントが認証ヘッダーを使用します。基本的には、ユーザー名とパスワードを「username:password」のように1つに組み合わせてBase64でエンコードされた文字列が、Basic認証用のヘッダーとして使用されます。
  • 保存]をクリックします。
ユーザーが追加したイメージ

ウェブフックをテストする方法

ウェブフックアクションを含むワークフローを作成した後は、ダミーのウェブフックURLを使用して簡単なテストを実施できます。まずhttp://requestb.in/(英語)にアクセスして、RequestBinを作成します。なお、このサイトでは制限文字数を超えると結果が切り詰められることがありますのでご注意ください。このURLをウェブフックアクションのウェブフックURLとして使用します。

ユーザーが追加したイメージ
次に、任意のコンタクトレコードに移動し、[ワークフロー]、[アクティブなワークフローを選択]、[コンタクトを登録]の順に選択してコンタクトを登録します。

下図は、前述したウェブフックのリクエスト本文のサンプルです。リクエストの本文には、コンタクトに関するメタ情報(連絡先情報、フォーム送信、リストメンバーシップなど)が記載されています。ウェブフックのワークフローアクションがトリガーされると、HubSpotがそのコンタクトのレコード全体をJSON形式に変換し、指定のURLに送信します。

ユーザーが追加したイメージ
ユーザーが追加したイメージ

レコードを受け取ったシステムは、そのJSONデータを解析し、システム固有のアプリケーションで使用します。

ウェブフックに関する詳しい情報は、ウェブフック リファレンス ドキュメント(英語)にてご参照いただけます。HubSpotにウェブフックを実装するうえでお困りのことがございましたら、ハブスポットの開発者向けフォーラム(英語)をご利用ください。