お客さまへの大切なお知らせ:膨大なサポート情報を少しでも早くお客さまにお届けするため、本コンテンツの日本語版は人間の翻訳者を介さない自動翻訳で提供されております。正確な最新情報については本コンテンツの英語版をご覧ください。
Webhookをカスタマイズする(BETA)
更新日時 2023年 6月 20日
以下の 製品でご利用いただけます(別途記載されている場合を除きます)。
Operations Hub Professional , Enterprise |
ワークフローでWebhookを使用している場合ワークフローからPOSTまたはGETリクエストを送信する場合 Webhookをカスタマイズして送受信するデータを制御することができます。
POSTリクエストでは、CRMなどの外部システムに送信されるプロパティーを指定することができます。同様に、GETリクエストでは、クエリーパラメーターで要求されるプロパティーを指定することができます。
開発者WebhookドキュメントでWebhookの詳細をご確認ください。HubSpotでのWebhookの具体的な実装についてご不明な点がございましたら、HubSpot開発者フォーラムをご利用ください。
注意:HubSpotは失敗したWebhookを、失敗の1分後から最大3日間再試行します。その後の失敗は、徐々に間隔を延ばして再試行されます。再試行の間隔は最大で8時間になります。HubSpot の開発者ドキュメントで、特定のエラーコード例外について確認する。
Webhookをセットアップする
Webhookの作成とカスタマイズを行うためです:
- HubSpotのアカウントにて、[自動化]>[ワークフロー]の順に進みます。
- ワークフローの名前をクリックします。
- +アイコンをクリックして、アクションを追加します。
- 右側のパネルで[Webhookを送信]を選択します。
- [メソッド]ドロップダウンメニューをクリックし、[POST]または[GET]を選択します。
- WebhookURLを入力します。WebhookURLには安全なプロトコルという制限があり、HTTPSで始まる必要があります。特定の情報を要求するには、Webhook URLに
?queryparameter=abc
のようなクエリーパラメーターを追加することができます。クエリーパラメーターが追加されなかった場合は、汎用のPOSTリクエストまたはGETリクエストが送信されます。 - Webhookへのリクエストを認証するための認証タイプを次のように設定します。
- Webhookヘッダーでリクエスト署名を使用するには:
- [認証タイプ]ドロップダウンメニューをクリックします。次に、[ヘッダーにリクエスト署名を含める]を選択します。
- 次に、[HubSpotアプリID]を入力します。リクエスト署名を確認する方法をご確認ください。
- Webhookヘッダーでリクエスト署名を使用するには:
-
- また、認証にAPIキーを使用することも可能です。認証にAPIキーを使用するとき、使用する「APIキー名」と「APIキーの場所」はWebhookの設定方法に応じて異なります。セキュリティー上の理由から、APIキーはいかなるテストリクエストにも表示されません。APIキーを使用するには:
- [認証タイプ]ドロップダウンメニューをクリックします。次に、[APIキー]を選択します。
- また、認証にAPIキーを使用することも可能です。認証にAPIキーを使用するとき、使用する「APIキー名」と「APIキーの場所」はWebhookの設定方法に応じて異なります。セキュリティー上の理由から、APIキーはいかなるテストリクエストにも表示されません。APIキーを使用するには:
-
-
- [APIキー名]を入力します。
- APIキーの場所 ドロップダウンメニューをクリックします。 次に、[クエリーパラメーター]または[リクエストヘッダー]のいずれかを選択します。HubSpot APIキーの使用方法について詳しくはこちら .
-
POSTリクエストをカスタマイズする
POSTリクエストを設定する場合、CRMレコードのすべてのプロパティーを含めるか、特定のプロパティーのみを送信するかを選択することができます:- すべてのプロパティーを含めるには、[リクエスト本文をカスタマイズ]セクションで[全てのプロパティーを含める]を選択します。
- 特定のプロパティーだけを含めるには:
- [リクエスト本文をカスタマイズ]セクションで、[特定のプロパティーを選択]を選択します。
- [プロパティーの選択]ドロップダウンメニューをクリックします。次に、[このワークフローの[オブジェクト]]をクリックし、プロパティーを1つ選択します。
- Webhookでプロパティーの名前を変更するには、[プロパティー名]テキストフィールドを編集します。ここではPOSTリクエストのプロパティー名のみが更新されます。HubSpotのプロパティー名や内部名は更新されません。
- 別のプロパティーを追加するには、[プロパティーを追加]をクリックします。
- プロパティーを削除するには、deleteゴミ箱アイコンをクリックします。
GETリクエストをカスタマイズする
GETリクエストを設定する場合、プロパティーをクエリーパラメーターとして使用することで、特定のデータを取得することができます:- [クエリーパラメーター]セクションで、[プロパティーの選択]ドロップダウンメニューをクリックします。次に、[このワークフローの[オブジェクト]]をクリックし、プロパティーを1つ選択します。
- クエリーパラメーターでプロパティーの名前を変更するには、[プロパティー名]テキストフィールドを編集します。ここではGETリクエストのプロパティー名のみが更新されます。HubSpotのプロパティー名や内部名は更新されません。
- 別のプロパティーを追加するには、[クエリーパラメーターを追加]をクリックします。
- プロパティーを削除するには、deleteゴミ箱アイコンをクリックします。
- [保存]をクリックします。
Workflows
貴重なご意見をありがとうございました。
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。