ワークフローでウェブフックを使用して、HubSpot から別のウェブアプリケーションに情報を渡すことができます。
データの送信や通知のプッシュなど、ウェブフックにはさまざまな用途があります。
ウェブフックには一般的に次の用途があります。
-
コンタクトがサイト内のフォームから情報を送信したときに、HubSpotのコンタクトデータをCRMなどの外部システムに送信する。
-
取引データを外部出荷処理システムに送信して注文書を作成する。
-
外部システムから会社のチャットストリームにチャットアラートを送信して、従業員に何か重要な問題が発生したことを知らせる。
HubSpotは、ウェブフックトラフィックを他のワークフロープロセスから切り離して制御します。これは、ワークフローとウェブフックのパフォーマンスを向上させるために行います。ウェブフックが遅い場合やタイムアウトした場合は、ワークフローアクションの実行に予想より長い時間がかかります。
ウェブフックの技術面の詳細については、開発者向けのドキュメントを確認してください。
ワークフローでウェブフックをセットアップする
- HubSpotアカウントにて、［自動化］ > ［ワークフロー］の順に進みます。
- ワークフローの名前をクリックします。
- + アイコンをクリックして、アクションを追加します。
- 右側のパネルで、［ウェブフックを実行］をクリックします。
- ウェブフック URL を入力します。
注：ウェブフック URL は安全なプロトコルに制限されており、HTTPS で始まる必要があります。
- ウェブフックへのリクエストを認証するために ［リクエスト署名を使用］チェックボックスをオンにして、アプリ ID を入力します。リクエスト署名を確認する方法をご確認ください。
- ［保存］をクリックします。
注：［ウェブフックを実行］アクションでは POST メソッドのみがサポートされています。
ウェブフックをテストする
ウェブフックアクションを含むワークフローを作成したら、ダミーのウェブフック URL を使用して、簡単なテストを実行できます。ブラウザーで https://webhook.site に移動し、自動的に作成された一意の URL をコピーします。ウェブフックアクションの［ウェブフック URL］フィールドに、コピーした URL を貼り付けます。
下の例は、上記のウェブフックのリクエスト本文を示しています。これには、コンタクト情報、フォーム送信、リストメンバーシップなど、特定のコンタクトに関するメタ情報が表示されています。このワークフローアクションがトリガーされると、HubSpot は指定された URL に、そのコンタクトのレコードすべてを JSON 形式で送信します。
レコードを受け取ったシステムは、その JSON データを解析し、システム固有のアプリケーションで使用します。
注：履歴プロパティー値はコンタクトベースのワークフローでのみ返されます。他のすべてのワークフロータイプで使用されるウェブフックは最新の値のみを返します。
開発者ウェブフックドキュメントでウェブフックの詳細をご確認ください。HubSpot でのウェブフックの具体的な実装についてご不明な点がございましたら、HubSpot 開発者フォーラムをご利用ください。
ワークフローウェブフックでリクエスト署名を確認する
［ウェブフックの実行］アクションの［Authentication (認証)］セクションで、［Request signature (リクエスト署名)］を選択した場合、HubSpot はウェブフックの X-HubSpot-Signature ヘッダーに、アプリケーションのアプリシークレット、HTTP メソッド、URI、未解析の本文をつなげた SHA-256 ハッシュを取り込みます。開発者ドキュメントで詳細をご確認ください。
URL で受信したリクエストの送信元が HubSpot であることを確認するには：
- 開発者アカウントを所有します。所有していない場合は、開発者アカウントを登録します。
- アプリを所有します。所有していない場合は、アプリを作成する方法をご確認ください。
- 署名のハッシュ値を確認します。