HubSpotワークフローでWebhookを使用する
更新日時 2025年7月9日
以下の 製品でご利用いただけます(別途記載されている場合を除きます)。
|
ワークフローでWebhookを使用することにより、HubSpotと他の外部ツールの間で情報を送信したり取得したりします。Webhookにはさまざまな用途があります。Webhookには一般的に次の用途があります。
-
コンタクトがサイト内のフォームから情報を送信したときに、HubSpotのコンタクトデータをCRMなどの外部システムに送信する。
-
取引データを外部出荷処理システムに送信して注文書を作成する。
- 別のシステムからデータを取得してHubSpotのレコードを更新する。
ワークフローを使用して、POSTとGETの両方のリクエストを送信できます。HubSpotは、Webhookトラフィックを他のワークフロープロセスから切り離して制御します。これは、ワークフローとWebhookのパフォーマンスを向上させるために行います。Webhookが遅い場合やタイムアウトした場合は、ワークフローアクションの実行に予想より長い時間がかかります。
注:HubSpotは、失敗したWebhookについて、失敗の1分後から最大3日間に渡って再試行します。その後の失敗は、徐々に間隔を延ばして再試行されます。再試行の間隔は最大で8時間になります。
このルールの1つの例外は、429レート制限エラーである。ワークフローは、429 応答を受け取った後、自動的に再試行し、Retry-Afterヘッダーが存在すれ ば、それを尊重する。Retry-Afterはミリ秒単位で記録されます。 HubSpot の開発者ドキュメントで特定のエラーコード例外について確認する。
開発者WebhookドキュメントでWebhookの詳細をご確認ください。HubSpotでのWebhookの具体的な実装についてご質問がある場合、 HubSpot開発者フォーラムでお問い合わせください。
POSTリクエストの設定
- HubSpotアカウントにて、[自動化]>[ワークフロー]の順に進みます。
- 既存のワークフローを編集するには、ワークフロー の名前 をクリックします。または、 新しいワークフローを作成します。
- ワークフローエディターで[+]プラスアイコンをクリックしてアクションを追加します。
- 左パネルのData opsセクションで、Send a Webhookを選択する。
- Methodドロップダウンメニューをクリックし、POSTを選択する。
- WebhookURLを入力します。
- WebhookURLには安全なプロトコルという制限があり、HTTPSで始まる必要があります。
- 特定の情報を求めるには、 Webhook URL に
?queryparameter=abc
などのクエリーパラメーターを追加できます。 - クエリーパラメーターが追加されなかった場合は、汎用のPOSTリクエストまたはGETリクエストが送信されます。
- Webhookへのリクエストを認証するための認証タイプを設定します。リクエストシグネチャをWebhookヘッダーで使用するか、APIキーを使用します:
- Webhookヘッダーでリクエスト署名を使用するには:
- [認証タイプ]ドロップダウンメニューをクリックします。次に、[ ヘッダーにリクエスト署名を含める]を選択します。
- 次に、[ HubSpotアプリID]を入力します。リクエスト署名を確認する方法をご確認ください。
- APIキーまたは開発者アカウントで作成した公開アプリを認証に使用する場合:
- 認証にAPIキーを使用するとき、使用する「APIキー名」と「APIキーの場所」はWebhookの設定方法に応じて異なります。セキュリティー上の理由から、APIキーはいかなるテストリクエストにも表示されません。APIキーを使用するには:
- [認証タイプ]ドロップダウンメニューをクリックします。次に、[APIキー]を選択します。
- [ APIキー名]を入力します。
- [ APIキーの場所 ]ドロップダウンメニューをクリックします。次に、[ クエリーパラメーター ]または [リクエストヘッダー]のいずれかを選択します。HubSpot でのAPIキーの使用について詳細をご確認ください。
- HubSpot APIにリクエストを送る場合:
- [APIキー]ドロップダウンメニューをクリックし、シークレットを1つ選択します。シークレット 値は 、Bearer [YOUR_TOKEN] の形式でなければなりません。
- APIキー名の値を[Authorization]に設定します。
- 「APIキーの場所」の値を [リクエストヘッダー]に設定します。
- 認証にAPIキーを使用するとき、使用する「APIキー名」と「APIキーの場所」はWebhookの設定方法に応じて異なります。セキュリティー上の理由から、APIキーはいかなるテストリクエストにも表示されません。APIキーを使用するには:
- Webhookヘッダーでリクエスト署名を使用するには:
- 全てのプロパティーを含めるには、Include all [object] propertiesを選択します。
- 特定のプロパティーだけを含めるには:
- リクエスト本文をカスタマイズを選択する。
- HubSpotプロパティーを使ってリクエスト本文をカスタマイズするには、キーを入力し、プロパティーを選択します。別のプロパティーを追加するには、[プロパティーを追加]をクリックします。
- 静的フィールドを使ってリクエスト本文をカスタマイズするには、キーと値を入力します。プロパティーを追加するには、静的値を追加をクリックする。
- プロパティーまたは静的値を削除するには、deleteごみ箱アイコンをクリックします。
- [保存]をクリックします。
注:複数の出力を選択するには、レスポンスがJSONオブジェクトとして構造化されている必要があります。
GETリクエストの設定
- HubSpotアカウントにて、[自動化]>[ワークフロー]の順に進みます。
- 既存のワークフローを編集するには、ワークフロー の名前 をクリックします。または、 新しいワークフローを作成します。
- ワークフローエディターで[+]プラスアイコンをクリックしてアクションを追加します。
- 左パネルのData opsセクションで、Send a Webhookを選択する。
- Methodドロップダウンメニューをクリックし、GETを選択する。
- WebhookURLを入力します。
- WebhookURLには安全なプロトコルという制限があり、HTTPSで始まる必要があります。
- 特定の情報を求めるには、 Webhook URL に
?queryparameter=abc
などのクエリーパラメーターを追加できます。 - クエリーパラメーターが追加されなかった場合は、汎用のPOSTリクエストまたはGETリクエストが送信されます。
- Webhookへのリクエストを認証するための認証タイプを設定します。リクエストシグネチャをWebhookヘッダーで使用するか、APIキーを使用します:
- Webhookヘッダーでリクエスト署名を使用するには:
- [認証タイプ]ドロップダウンメニューをクリックします。次に、[ ヘッダーにリクエスト署名を含める]を選択します。
- 次に、[ HubSpotアプリID]を入力します。リクエスト署名を確認する方法をご確認ください。
- APIキーまたは開発者アカウントで作成した公開アプリを認証に使用する場合:
- 認証にAPIキーを使用するとき、使用する「APIキー名」と「APIキーの場所」はWebhookの設定方法に応じて異なります。セキュリティー上の理由から、APIキーはいかなるテストリクエストにも表示されません。APIキーを使用するには:
- [認証タイプ]ドロップダウンメニューをクリックします。次に、[APIキー]を選択します。
- [ APIキー名]を入力します。
- [ APIキーの場所 ]ドロップダウンメニューをクリックします。次に、[ クエリーパラメーター ]または [リクエストヘッダー]のいずれかを選択します。HubSpot でのAPIキーの使用について詳細をご確認ください。
- HubSpot APIにリクエストを送る場合:
- [APIキー]ドロップダウンメニューをクリックし、シークレットを1つ選択します。シークレット 値は 、Bearer [YOUR_TOKEN] の形式でなければなりません。
- APIキー名の値を[Authorization]に設定します。
- 「APIキーの場所」の値を [リクエストヘッダー]に設定します。
- 認証にAPIキーを使用するとき、使用する「APIキー名」と「APIキーの場所」はWebhookの設定方法に応じて異なります。セキュリティー上の理由から、APIキーはいかなるテストリクエストにも表示されません。APIキーを使用するには:
- Webhookヘッダーでリクエスト署名を使用するには:
- GETリクエストを設定する場合は、HubSpotプロパティーを使用するか、静的値をクエリーパラメーターとして追加することができます。
- HubSpotプロパティーをクエリーパラメーターとして使用するには:
- [クエリーパラメーター]セクションで キーを入力し、 プロパティーを1つ選択します。
- 別のプロパティーを追加するには、[プロパティーを追加]をクリックします。
- プロパティーを削除するには、 delete 削除アイコンをクリックします。
- 静的値をクエリーパラメーター値として使用する場合:
- クエリーパラメーターセクションで、キーを入力し、次に値を入力する。
- プロパティーを追加するには、静的値を追加をクリックする。
- プロパティーを削除するには、 delete 削除アイコンをクリックします。
- [保存]をクリックします。
Webhookのレート制限を設定(ベータ版)
レート制限を設定して、Webhookアクションを実行する速度を決定します。レート制限は、ワークフロー内の後続の全てのアクションにも影響します。
- HubSpotアカウントにて、[自動化]>[ワークフロー]の順に進みます。
- ワークフローの名前をクリックします。
- ワークフローエディターで、Webhook を送信アクションをクリックします。
- 左側のパネルで、[ レート制限を設定]をクリックしてセクションを展開します。
- [ レート制限をオンにする ]スイッチをクリックしてオンに切り替えます。デフォルトでは、この設定はオフになっています。
- レート制限を設定します。
- アクションの実行: 1期間あたりの最大実行回数を設定します。
- 期間: レート制限の期間を設定します。この期間は、[ 秒]、[ 分]、[ 時間]で設定できます。
[日時]に再開されます
HubSpotでWebhookをテストします。
「POST」または「GET」Webhookをセットアップする際に、Webhookレスポンスを確認するためのテストを実行できます。テスト中は第三者へのデータの送信と第三者からのデータの取得が行われますが、HubSpot内の既存のレコードには影響しません。認証にAPIキーを使用している場合、APIキーはいかなるテストリクエストにも表示されません。
Webhookのテスト後に、その後のワークフローで入力として使用するために出力するフィールドを選択できます。すべてのレスポンスで使用可能な出力のみを選択します。出力がその後のアクションで使用されるものの、レスポンスで使用できない場合、そのアクションは失敗します。
- HubSpotアカウントにて、[自動化]>[ワークフロー]の順に進みます。
- ワークフローの名前をクリックします。
- ワークフローエディターで、Webhook を送信アクションをクリックします。
- 左パネルで、テストアクションをクリックし、セクションを展開する。
- POSTリクエストをテストする場合、Webhookテストのセットアップは、[ リクエスト本文をカスタマイズ ]と[全ての [オブジェクト]のプロパティーを Webhookアクションに含める]のどちらを選択したかによって異なります。
- [リクエスト本文をカスタマイズ]を選択した場合は、テストの プロパティーテスト値 を入力します。
- [すべての[オブジェクト]プロパティーを含める]を選択した場合は、[ [オブジェクト] ]ドロップダウンメニューをクリックして、テストする レコード を選択します。
- [テスト]をクリックします。
- Webhookの詳細を確認するには、[レスポンス]タブまたは[リクエスト]タブを選択します。各タブでは、[ すべてを開く] をクリックするとすべてのセクションが展開され、[ すべて折りたたむ ]をクリックするとすべてのセクションが折りたたまれます。
- [レスポンス]タブでは、[headers:]または[body:]をクリックすると、それぞれのセクションが展開されます。
- [リクエスト]タブでは、[httpHeaders:]をクリックすると、そのセクションが展開されます。
外部でWebhookをテストする
Webhookアクションを含むワークフローを作成したら、ダミーのWebhook URLを使用して、簡単なテストを実行できます。
- ブラウザーで https://Webhook.site に移動し、 固有のURLをコピーします。
- Webhookアクションの[WebhookURL]フィールドに、コピーしたURLを貼り付けます。
- ワークフローがオンになると、 テストコンタクトを手動で登録できます。
- Webhookを外部でテストする場合:
- POSTリクエストを含むWebhookアクションがトリガーされた場合は、コンタクトに関するすべての情報(フォーム送信、リストのメンバーシップ、すべてのコンタクトプロパティー値など)を格納したJSONレスポンス本文がWebhookに送信されます。レコードを受け取ったシステムは、そのJSONデータを解析し、システム固有のアプリケーションで使用します。
- GETリクエストを含むWebhookアクションがトリガーされた場合は、追加のクエリーパラメーターが適用されていない限り、汎用のGETリクエストが送信されます。
注:履歴プロパティー値はコンタクトベースのワークフローでのみ返されます。他のすべてのワークフロータイプで使用されるWebhookは最新の値のみを返します。
ワークフローWebhookでリクエスト署名を確認する
Webhookを実行 アクションの [認証 ]セクションで[ リクエスト署名 ]を選択した場合、HubSpotはWebhookにX-HubSpot-Signatureヘッダーと、アプリのアプリシークレット、HTTPメソッド、URI、未解析の本文を連結したSHA-256ハッシュを取り込みます。開発者ドキュメントで詳細をご確認ください。
URLで受信したリクエストの送信元がHubSpotであることを確認するには、次のようにします。
- 開発者アカウントを所有します。所有していない場合は、開発者アカウントを登録します。
- アプリを所有します。所有していない場合は、 アプリを作成する方法をご確認ください。
- 署名のハッシュ値を確認します。
Webhookからワークフローをトリガーする
Webhookは、ワークフローをトリガーするために使用できます。サードパーティーアプリでデータが変更されると、ワークフローがトリガーされる可能性があります。Webhookからワークフローをトリガーする方法について詳細をご確認ください。
データパネルでWebhookデータを使用する
アカウントに接続済みのWebhookからのデータは、データパネルの特定のアクションに使用できます。
に接続された Webhookからのデータを使用する:
- HubSpotアカウントにて、[自動化]>[ワークフロー]の順に進みます。
- ワークフローの名前をクリックします。
- [+]プラスアイコンをクリックしてアクションを追加します。
- 左側のパネルで、 データパネルを使用する アクションを選択します。
- データパネルで、View properties or action outputs fromドロップダウンメニューをクリックし、Webhook triggerを選択する。その後、接続されたWebhookからプロパティーを使用することができます。