Zum Hauptinhalt springen
最終更新日: 2025年10月8日
新しい開発者プラットフォームでアプリ用に一連のWebhook配信登録を定義するには、プロジェクトに、*-hsmeta.json構成ファイルを格納したwebhooksディレクトリーを含めます。

​
ディレクトリー構造

├──src
│   ├── app/
│   │   └── app-hsmeta.json
│   │   └── ...
│   │   └── webhooks/
│   │     └── webhooks-hsmeta.json
└──

​
Webhookの設定

*-hsmeta.jsonファイルで使用できる設定オプションを以下に示します。 
{
  "uid": "webhooks",
  "type": "webhooks",
  "config": {
    "settings": {
      "targetUrl": "https://example.com/webhook",
      "maxConcurrentRequests": 10
    },
    "subscriptions": {
      "crmObjects": [
        {
          "subscriptionType": "object.creation",
          "objectType": "contact",
          "active": true
        }
      ],
      "legacyCrmObjects": [
        {
          "subscriptionType": "contact.propertyChange",
          "propertyName": "lastname",
          "active": true
        },
        {
          "subscriptionType": "contact.deletion",
          "active": true
        }
      ],
      "hubEvents": [
        {
          "subscriptionType": "contact.privacyDeletion",
          "active": true
        }
      ]
    }
  }
}

*でマークされたフィールドは必須です。

フィールド型説明
uid*文字列Webhookコンポーネントの内部固有ID。
type*文字列コンポーネントのタイプ。この場合はwebhooksにする必要があります。
settings*オブジェクト2つのフィールドを指定するオブジェクト。一方のtargetUrlフィールドで、HubSpotがイベントペイロードを配信するために呼び出す、一般公開されたURLを指定します。もう一方のmaxConcurrentRequestsフィールドでは、HubSpotが所定の時間枠内に送信するHTTPリクエスト数の上限しきい値を指定します。
subscriptions*オブジェクトアプリで配信登録する配信カテゴリーを指定するオブジェクト。
crmObjects配列

イベント配信登録の定義からなる配列。これは標準で組み込まれる配列であり、新しい形式（object.*）の全てのイベントにはこの配列を使用する必要があります。

イベントによっては、代わりにlegacyCrmObjects配列とhubEvents配列に、従来のWebhook配信カテゴリーを含める必要があります。

legacyCrmObjects配列従来の配信カテゴリー（contact.creation、deal.deletionなど）からなる配列。
hubEvents配列従来の配信カテゴリーcontact.privacyDeletionおよびconversation.*からなる配列。
subscriptionオブジェクトごとに、対象とする配信登録定義のタイプ（crmObjects、legacyCrmObjects、hubEvents）や、特定のプロパティーの変更（contact.propertyChangeなど）に配信登録するかどうかに応じて、以下のフィールドを指定できます。
フィールド型説明
subscriptionType文字列配信登録する対象のイベントのタイプ。
objectType文字列crmObjects配列内で指定されている配信登録の場合、このフィールドで、アプリの配信登録先のCRMオブジェクトを指定します。
propertyName文字列プロパティー変更に対する配信登録の場合、このフィールドで、Webhookイベントをトリガーするプロパティーを指定します。
activeブール値この配信登録に対してWebhookイベントをトリガーするかどうかを示します。