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

ワークフローでWebhookを使用して、ワークフローからPOSTリクエストまたはGETリクエストを送信できます。Webhookにはさまざまな用途がありますが、一般的なWebhookの使用例としては次のようなものがあります。

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

• 取引データを外部出荷処理システムに送信して注文書を作成する。

• 外部システムから社内のチャットストリームにチャットアラートを送信し、重要なことが起こったことを従業員に通知する。

• 別のシステムからデータを取得してHubSpotのレコードを更新する。 

HubSpotは、ウェブフックトラフィックを他のワークフロープロセスから切り離して制御します。これは、ワークフローとウェブフックのパフォーマンスを向上させるために行います。ウェブフックが遅い場合やタイムアウトした場合は、ワークフローアクションの実行に予想より長い時間がかかります。

注：HubSpotは、失敗したウェブフックについて、失敗の1分後から最大3日間に渡って再試行します。その後の失敗は、徐々に間隔を延ばして再試行されます。再試行の間隔は最大で8時間になります。HubSpot の開発者ドキュメントで、特定のエラーコード例外について確認する。

開発者ウェブフックドキュメントでウェブフックの詳細をご確認ください。HubSpotでのウェブフックの具体的な実装についてご不明な点がございましたら、HubSpot開発者フォーラムをご利用ください。

 ワークフローでウェブフックをセットアップする

• HubSpotアカウントにて、［自動化］ > ［ワークフロー］の順に進みます。
• ワークフローの名前をクリックします。
• +アイコンをクリックして、アクションを追加します。
• 右側のパネルで［Webhookを送信］を選択します。
• ［メソッド］ドロップダウンメニューをクリックし、［POST］または［GET］を選択します。 
• ウェブフックURLを入力します。ウェブフックURLには安全なプロトコルという制限があり、HTTPSで始まる必要があります。特定の情報をリクエストするには、「Webhook URL」にクエリーパラメーターを追加します。クエリーパラメーターが追加されなかった場合は、汎用のPOSTリクエストまたはGETリクエストが送信されます。  
• Webhookへのすべてのリクエストを認証するには、次の手順に従います。
  • ［認証タイプ］ドロップダウンメニューをクリックし、［ヘッダーにリクエスト署名を含める］を選択します。
  • HubSpotアプリIDを入力します。リクエスト署名を確認する方法をご確認ください。
• ［保存］をクリックします。
  
  

HubSpot内でWebhookをテストする

「POST」または「GET」Webhookをセットアップする際に、Webhookレスポンスを確認するためのテストを実行できます。テスト中は第三者へのデータの送信と第三者からのデータの取得が行われますが、HubSpot内の既存のレコードには影響しません。 

Webhookのテスト後に、その後のワークフローで入力として使用するために出力するフィールドを選択できます。すべてのレスポンスで使用可能な出力のみを選択します。出力がその後のアクションで使用されるものの、レスポンスで使用できない場合、そのアクションは失敗します。

• サイドパネルで［テストアクション］をクリックし、セクションを展開します。 
• ［オブジェクト］ドロップダウンメニューをクリックし、テストするレコードを選択します。
• ［テスト］をクリックします。 
• Webhookの詳細を確認するには、［レスポンス］タブまたは［リクエスト］タブを選択します。各タブでは、［すべてを開く］をクリックするとすべてのセクションが展開され、［すべて折りたたむ］をクリックするとすべてのセクションが折りたたまれます。
  
  • ［レスポンス］タブでは、［headers:］または［body:］をクリックすると、それぞれのセクションが展開されます。 
  • ［リクエスト］タブでは、［httpHeaders:］をクリックすると、そのセクションが展開されます。
    
    

外部でWebhookをテストする

Webhookアクションを含むワークフローを作成したら、ダミーのWebhook URLを使用して、簡単なテストを実行できます。

• ブラウザーでhttps://webhook.siteに移動し、一意のURLをコピーします。
• Webhookアクションの［Webhook URL］フィールドに、コピーしたURLを貼り付けます。
  
  

• ワークフローがオンになると、テストコンタクトを手動で登録できます。

POSTリクエストを含むWebhookアクションがトリガーされた場合は、コンタクトに関するすべての情報（フォーム送信、リストのメンバーシップ、すべてのコンタクトプロパティー値など）を格納したJSONレスポンス本文がWebhookに送信されます。レコードを受け取ったシステムは、そのJSONデータを解析し、システム固有のアプリケーションで使用します。

GETリクエストを含むWebhookアクションがトリガーされた場合は、追加のクエリーパラメーターが適用されていない限り、汎用のGETリクエストが送信されます。   

注：履歴プロパティー値はコンタクトベースのワークフローでのみ返されます。他のすべてのワークフロータイプで使用されるウェブフックは最新の値のみを返します。

ワークフローウェブフックでリクエスト署名を確認する

［ウェブフックの実行］アクションの［認証］セクションで、［リクエスト署名］を選択した場合、HubSpotはウェブフックのX-HubSpot-Signatureヘッダーに、アプリケーションのアプリシークレット、HTTPメソッド、URI、未解析の本文をつなげたSHA-256ハッシュを取り込みます。開発者ドキュメントで詳細をご確認ください。

URLで受信したリクエストの送信元がHubSpotであることを確認するには、次のようにします。

• 開発者アカウントを所有します。所有していない場合は、開発者アカウントを登録します。
• アプリを所有します。所有していない場合は、アプリを作成する方法をご確認ください。
• 署名のハッシュ値を確認します。