> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Webhooks journal API
export const postmanIcon =
;
# Webhook
連携機能がインストールされている場合、Webhook APIを使用して、HubSpotアカウント上で発生したイベントを受信できます。接続されたアカウントでイベントが発生したときにAPI呼び出しを実行する代わりに、設定したエンドポイントにHubSpotからHTTPリクエストを送信します。受信を登録するイベントは、アプリの設定、または以下で詳述するエンドポイントを使用して設定できます。場合によっては、定期的に変更をポーリングするよりも、Webhookを使用する方法のほうが拡張性に優れています（特にインストールベースが大規模なアプリの場合）。
Webhook APIの使用にあたり、次の要件を満たす必要があります。
* 通知を受ける対象のイベントに登録し、通知の送信先URLを指定することにより、Webhookを使用するHubSpotアプリを設定してあること。アプリの作成方法の詳細については、[前提条件に関するドキュメント](https://developers.hubspot.com/docs/faq/integration-platform-api-requirements)（英語）をご覧ください。
* このドキュメントに規定されたWebhookペイロードを処理できる、公開URLのセキュア（HTTPS）エンドポイントが展開されていること。
Webhookは、アカウント単位ではなく[HubSpotアプリ](/apps/legacy-apps/public-apps/overview)（英語）に対して設定されます。[OAuthフロー](https://developers.hubspot.jp/docs/reference/api/app-management/oauth/tokens#initiate-an-integration-with-oauth-2.0)（英語）に従ってアプリをインストールする全てのアカウントが、そのフローのWebhookサブスクリプションに配信登録されます。
CRMオブジェクト（コンタクト、会社、取引、チケット、製品、商品項目など）のイベントとコミュニケーションイベントに対して配信登録できます。
**注：**
* [非公開アプリでWebhookを管理する](/apps/legacy-apps/private-apps/create-and-edit-webhook-subscriptions-in-private-apps)こともできます。非公開アプリでは、非公開アプリのアプリ内設定でのみWebhookを編集できます。現在のところ、APIを介して編集することはできません。
* コミュニケーションWebhookに登録するには、現在ベータ版 となっている[コミュニケーション受信トレイおよびメッセージAPI](/api-reference/conversations-conversations-inbox-&-messages-v3/guide)にアクセスする必要があります
## スコープ
Webhookを使用してCRMイベントの配信登録を行うには、登録する対象のCRMオブジェクトタイプに対応する、イベントに関連付けられたスコープを求めるようにアプリを設定する必要があります。例えば、コンタクトイベントの配信登録を行う場合は、`crm.objects.contacts.read`スコープをリクエストする必要があります。
* 公開アプリの設定UIでサブスクリプションを作成する場合、サブスクリプションの作成を完了する前に、［新しいWebhook配信登録を作成］パネルで必要なスコープを追加するように求められます。
* `POST`リクエストを`/webhooks/v3/{appId}/subscriptions`エンドポイントに送信してサブスクリプションを作成する場合、レスポンスに含まれるエラーに、公開アプリの設定UIで設定する必要があるスコープの名前が示されます。
* アプリですでにWebhookを使用している場合、アクティブなWebhookサブスクリプションで必要とされているスコープを削除するには、その前に、該当するWebhookサブスクリプションを一時停止して削除する必要があります。
* Webhookサブスクリプションタイプごとに必要となるスコープは、[下にある表](#webhook-subscriptions)で確認できます。
[スコープの詳細](https://developers.hubspot.jp/docs/reference/api/app-management/oauth/tokens#initiate-an-integration-with-oauth-2.0#scopes)（英語）およびアプリの[認証認証URLの設定](https://developers.hubspot.jp/docs/reference/api/app-management/oauth/tokens#initiate-an-integration-with-oauth-2.0)（英語）については、OAuthのドキュメントをご覧ください。
## Webhookの設定
Webhookサブスクリプションを設定する前に、これらの通知の送信先URLを指定する必要があります。アプリのサブスクリプションを完全に設定する方法については、以下のセクションの手順に従ってください。
**注：**
* Webhook設定は最大5分までキャッシュできます。WebhookのURL、同時接続数上限、またはサブスクリプションの設定を変更すると、変更が適用されるまでに最大5分かかる場合があります。
* HubSpotは、アプリをインストールしたアカウントに関連付けられたサブスクリプション イベント データを送信するときに、10件のリクエストの同時実行制限を設定します。この同時実行制限は、HubSpotが一度に試行する実行中リクエストの最大数です。各リクエストには最大100件のイベントを含めることができます。
### 開発者アカウントでの設定の管理
開発者アカウントのアプリの設定ページでは、URLとスロットリング制限を管理できます。
* 開発者アカウントで、［アプリ］ダッシュボードに移動します。
* Webhookを設定する対象のアプリの**名前**をクリックします。
ベータ版 となっている[コミュニケーション受信トレイおよびメッセージAPI](/api-reference/conversations-conversations-inbox-&-messages-v3/guide)を使用している場合は、以下のコミュニケーション サブスクリプション タイプの配信登録を行うことができます。
| サブスクリプションタイプ | スコープ | 説明 |
| ------------------------------ | ---------------------------------------------- | -------------------------------- |
| `conversation.creation` | `conversations.read` | アカウントで新しいスレッドが作成された場合に通知を受け取ります。 |
| `conversation.deletion` | アカウントでスレッドがアーカイブされた場合、またはソフト削除された場合に通知を受け取ります。 | |
| `conversation.privacyDeletion` | アカウントからスレッドが完全に削除された場合に通知を受け取ります。 | |
| `conversation.propertyChange` | スレッドのプロパティーが変更された場合に通知を受け取ります。 | |
| `conversation.newMessage` | スレッドで新しいメッセージを受信した場合に通知を受け取ります。 | |
プロパティー変更サブスクリプションの場合、通知の対象とするプロパティーを指定する必要があります。複数のプロパティー変更サブスクリプションを指定できます。サブスクリプションで指定されているプロパティーが顧客のアカウントに存在しない場合、顧客からそのプロパティーに関するWebhookを受け取ることはありません。
一部のプロパティーは、CRMプロパティー変更サブスクリプションでは使用できません。該当するプロパティーは次の通りです。
* `num_unique_conversion_events`
* `hs_lastmodifieddate`
現在ベータ版 となっている[コミュニケーション受信トレイおよびメッセージAPI](/api-reference/conversations-conversations-inbox-&-messages-v3/guide)を使用している場合、以下のプロパティーを使用できます。
* `assignedTo`\*\*：\*\*スレッドが再割り当てまたは割り当て解除されたコミュニケーション。`propertyValue`は、スレッドが再割り当てされた場合はWebhookのペイロードに含まれるアクターIDとなり、スレッドが割り当て解除された場合は空白となります。
* `status`\*\*：\*\*スレッドによって変更されたコミュニケーションのステータス。Webhookペイロード内の`propertyValue`は、`OPEN`または`CLOSED`のいずれかになります。
* `isArchived`\*\*：\*\*スレッドが復元されたコミュニケーション。Webhookペイロード内の`propertyValue`は、常に`FALSE`となります。
### 開発者アカウントでのサブスクリプションの作成
HubSpot開発者アカウント内でWebhookサブスクリプションを作成できます。
* HubSpotの開発者アカウントで、［アプリ］ダッシュボードに移動します。
* アプリの**名前**をクリックします。
* 左のサイドバーメニューで［Webhook］に移動します。
* ［サブスクリプションを作成］をクリックします。
* 右側のパネルで［どのオブジェクトタイプを選びますか？］のドロップダウンメニューをクリックし、サブスクリプションを作成する対象の**オブジェクト**を選択します。
* ［どのイベントについて知りたいですか？］のドロップダウンメニューをクリックし、**イベントタイプ**を選択します。
`CONTACT_TO_COMPANY` `CONTACT_TO_DEAL` `CONTACT_TO_TICKET` `CONTACT_TO_CONTACT` `COMPANY_TO_CONTACT` `COMPANY_TO_DEAL` `COMPANY_TO_TICKET` `COMPANY_TO_COMPANY` `DEAL_TO_CONTACT` `DEAL_TO_COMPANY` `DEAL_TO_LINE_ITEM` `DEAL_TO_TICKET` `DEAL_TO_DEAL` `TICKET_TO_CONTACT` `TICKET_TO_COMPANY` `TICKET_TO_DEAL` `TICKET_TO_TICKET` `LINE_ITEM_TO_DEAL` `true`：関連付けの削除によってWebhookがトリガーされました。 `false`：関連付けの作成によってWebhookがトリガーされました。 `true`：セカンダリーレコードは、関連付けの変更を行ったレコードの[プライマリーの関連付け](https://knowledge.hubspot.com/records/associate-records#primary-company-information)です。 `false`：レコードは、関連付けの変更を行ったレコードのプライマリーの関連付けではありません 。 計上されません 。
1つのアプリあたり最大1,000件のサブスクリプションを作成できます。この制限を超えて作成しようとすると、以下の本文を含む400 bad requestが返されます。
```json theme={null}
//
{
"status": "error",
"message": "Couldn't create another subscription. You've reached the maximum number allowed per application (1000).",
"correlationId": "2c9beb86-387b-4ff6-96f7-dbb486c00a95",
"requestId": "919c4c84f66769e53b2c5713d192fca7"
}
```
* 左のサイドバーメニューで［Webhook］に移動します。
* ［ターゲットURL］フィールドに、イベントがトリガーされたときにHubSpotでPOSTリクエストを送信する宛先の**URL**を入力します。
* ［イベントの抑制］設定を使用して、HubSpotで送信を試みるイベントの最大数を調整します。
* ［保存］をクリックします。
### APIによる設定の管理
以下のエンドポイントと[開発者APIキー](https://developers.hubspot.com/docs/apps/developer-platform/build-apps/authentication/overview)を使用することで、アプリのWebhook設定をプログラムによって構成できます。
アプリに現在構成されているWebhookの設定を表示するには、`GET`リクエストを`webhooks/v3/{appId}/settings`に送信します。
リクエストには[アプリID](/apps/legacy-apps/public-apps/overview#find-an-app’s-id)（英語）を含める必要があります。アプリIDは、［アプリ］ダッシュボード内のアプリの名前の下、またはアプリの設定の［認証］タブで確認できます。
settingsオブジェクトは、以下のフィールドからなります。
| フィールド | Description |
| ----------------------- | ------------------------------------------------------- |
| `webhookUrl` | HubSpotがWebhook通知を送信する宛先のURL。このURLはHTTPS経由で提供する必要があります。 |
| `maxConcurrentRequests` | Webhook URLでの同時処理の制限。このフィールドには5より大きい値を設定する必要があります。 |
上記の設定を編集するには、`PUT`リクエストを`webhooks/v3/{appId}/settings`に送信します。このリクエスト本文には、以下のフィールドを含めます。
| フィールド | Description |
| ----------------------- | ---------------------------------------------------------------------------------------------------- |
| `targetUrl` | HubSpotがイベントペイロードを配信するために呼び出す、一般公開されたURL。 |
| `throttling` | このオブジェクトでWebhookスロットリングの詳細を構成します。throttlingオブジェクト内には`period`フィールドと`maxConcurrentRequests`フィールドがあります。 |
| `period` | この設定で使用する時間の単位。`SECONDLY`（1秒あたり）または`ROLLING_MINUTE`（1分あたり）のいずれかの値を指定できます。 |
| `maxConcurrentRequests` | `period`で指定された一定の期間にHubSpotがアプリへの送信を試行するHTTPリクエストの最大数。 |
以下に、リクエストの例を示します。
```json theme={null}
// PUT request to https://api.hubapi.com/webhooks/v3/{appId}/settings
{
"throttling": {
"period": "SECONDLY",
"maxConcurrentRequests": 10
},
"targetUrl": "https://www.example.com/hubspot/target"
}
```
## Webhookサブスクリプション
Webhook URLとイベントスロットリングを設定したら、1つ以上のサブスクリプションを作成する必要があります。WebhookサブスクリプションでHubSpotに対し、特定のアプリで受信するイベントを指示します。
サブスクリプションは、貴社の連携機能をインストールした全ての顧客に適用されます。つまり、必要なサブスクリプションを指定するのは一度だけでよいことになります。アプリケーションでサブスクリプションを有効にすると、そのアプリケーションをインストールした全ての顧客のWebhookの受信が自動的に開始されます。また、連携機能によって新しい顧客からのWebhookトリガーの受信も開始されます。
全ての`associationChange` Webhookサブスクリプションに共通して、Webhookは関連付けの両方の対象に対する2つのイベントをトリガーします。
* 2つのコンタクトが関連付けられると、`contact.associationChange`のサブスクリプションによって、それぞれ`contact 1 to contact 2`と`contact 2 to contact 1`を表す2つのイベントがトリガーされます。
* `contact.associationChange`と`company.associationChange`の2つのWebhookサブスクリプションを使用している場合、会社が関連付けられると、2つのイベントを受信します。これらのイベントは、それぞれ`contact 1 to company 1`、`company 1 to contact 1`を表します。
サポートされているサブスクリプションタイプは次のとおりです。API経由でサブスクリプションを作成する際に、これらのタイプを`eventType`フィールドの値として使用できます。
| サブスクリプションタイプ | 必要なスコープ | 説明 |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `contact.creation` | `crm.objects.contacts.read` | 顧客のアカウントでコンタクトが作成された場合に通知を受け取ります。 |
| `contact.deletion` | 顧客のアカウントからコンタクトが削除された場合に通知を受け取ります。 | |
| `contact.merge` | コンタクトが別のコンタクトとマージされた場合に通知を受け取ります。 | |
| `contact.associationChange` | コンタクトと他のサポート対象のWebhookオブジェクト（コンタクト、会社、取引、チケット、商品項目、または製品）との間の関連付けが追加または削除された場合に通知を受け取ります。 | |
| `contact.restore` | 削除されたコンタクトが復元された場合に通知を受け取ります。 | |
| `contact.privacyDeletion` | [プライバシー規則への順守](https://developers.hubspot.jp/docs/guides/api/app-management/webhooks/overview)を理由としてコンタクトが削除された場合に通知を受け取ります。 | |
| `contact.propertyChange` | アカウントの全てのコンタクトについて、指定したプロパティーが変更された場合に通知を受け取ります。 | |
| `company.creation` | `crm.objects.companies.read` | 顧客のアカウントで会社レコードが作成された場合に通知を受け取ります。 |
| `company.deletion` | 顧客のアカウントから会社レコードが削除された場合に通知を受け取ります。 | |
| `company.propertyChange` | 顧客のアカウントの全ての会社レコードについて、指定したプロパティーが変更された場合に通知を受け取ります。 | |
| `company.associationChange` | | 会社オブジェクトと他のサポート対象のWebhookオブジェクト（コンタクト、会社、取引、チケット、商品項目、または製品）との間の関連付けが追加または削除された場合に通知を受け取ります。 |
| `company.restore` | | 削除された会社レコードが復元された場合に通知を受け取ります。 |
| `company.merge` | | 会社レコードが別の会社レコードとマージされた場合に通知を受け取ります。 |
| `deal.creation` | `crm.objects.deals.read` | 顧客のアカウントで取引レコードが作成された場合に通知を受け取ります。 |
| `deal.deletion` | 顧客のアカウントから取引レコードが削除された場合に通知を受け取ります。 | |
| `deal.associationChange` | 取引と他のサポート対象のWebhookオブジェクト（コンタクト、会社、取引、チケット、商品項目、または製品）との間の関連付けが追加または削除された場合に通知を受け取ります。 | |
| `deal.restore` | 削除された取引レコードが復元された場合に通知を受け取ります。 | |
| `deal.merge` | 取引レコードが別の取引レコードとマージされた場合に通知を受け取ります。 | |
| `deal.propertyChange` | 顧客のアカウント上の全ての取引について、指定したプロパティーが変更された場合に通知を受け取ります。 | |
| `ticket.creation` | `tickets` | 顧客のアカウントでチケットが作成された場合に通知を受け取ります。 |
| `ticket.deletion` | 顧客のアカウントからチケットが削除された場合に通知を受け取ります。 | |
| `ticket.propertyChange` | 顧客のアカウント上のチケットのいずれかで、指定したプロパティーが変更された場合に通知を受け取ります。 | |
| `ticket.associationChange` | | チケットと他のサポート対象のWebhookオブジェクト（コンタクト、会社、取引、チケット、商品項目、または製品）との間の関連付けが追加または削除された場合に通知を受け取ります。 |
| `ticket.restore` | | 削除されたチケットが復元された場合に通知を受け取ります。 |
| `ticket.merge` | | チケットが別のチケットとマージされた場合に通知を受け取ります。 |
| `product.creation` | `e-commerce` | 顧客のアカウント上で製品レコードが作成された場合に通知を受け取ります。 |
| `product.deletion` | 顧客のアカウント上で製品レコードが削除された場合に通知を受け取ります。 | |
| `product.restore` | 削除された製品レコードが復元された場合に通知を受け取ります。 | |
| `product.merge` | 製品が別の製品とマージされた場合に通知を受け取ります。 | |
| `product.propertyChange` | 顧客のアカウント上の製品のいずれかで、指定したプロパティーが変更された場合に通知を受け取ります。 | |
| `line_item.creation` | 顧客のアカウントで商品項目が作成された場合に通知を受け取ります。 | |
| `line_item.deletion` | 顧客のアカウント上で商品項目が削除された場合に通知を受け取ります。 | |
| `line_item.associationChange` | 商品項目と他のサポート対象のWebhookオブジェクト（コンタクト、会社、取引、チケット、商品項目、または製品）との間の関連付けが追加または削除された場合に通知を受け取ります。 | |
| `line_item.restore` | 削除された商品項目が復元された場合に通知を受け取ります。 | |
| `line_item.merge` | 商品項目が別の商品項目とマージされた場合に通知を受け取ります。 | |
| `line_item.propertyChange` | 顧客のアカウント上の商品項目のいずれかで、指定したプロパティーが変更された場合に通知を受け取ります。 | |
現在ベータ版となっている[コミュニケーション受信トレイおよびメッセージAPI](/api-reference/conversations-conversations-inbox-&-messages-v3/guide)を使用している場合は、以下のコミュニケーション サブスクリプション タイプの配信登録を行うことができます。
| サブスクリプションタイプ | スコープ | 説明 |
| ------------------------------ | ---------------------------------------------- | -------------------------------- |
| `conversation.creation` | `conversations.read` | アカウントで新しいスレッドが作成された場合に通知を受け取ります。 |
| `conversation.deletion` | アカウントでスレッドがアーカイブされた場合、またはソフト削除された場合に通知を受け取ります。 | |
| `conversation.privacyDeletion` | アカウントからスレッドが完全に削除された場合に通知を受け取ります。 | |
| `conversation.propertyChange` | スレッドのプロパティーが変更された場合に通知を受け取ります。 | |
| `conversation.newMessage` | スレッドで新しいメッセージを受信した場合に通知を受け取ります。 | |
プロパティー変更サブスクリプションの場合、通知の対象とするプロパティーを指定する必要があります。複数のプロパティー変更サブスクリプションを指定できます。サブスクリプションで指定されているプロパティーが顧客のアカウントに存在しない場合、顧客からそのプロパティーに関するWebhookを受け取ることはありません。
一部のプロパティーは、CRMプロパティー変更サブスクリプションでは使用できません。該当するプロパティーは次の通りです。
* `num_unique_conversion_events`
* `hs_lastmodifieddate`
現在ベータ版となっている[コミュニケーション受信トレイおよびメッセージAPI](/api-reference/conversations-conversations-inbox-&-messages-v3/guide)を使用している場合、以下のプロパティーを使用できます。
* `assignedTo`\*\*：\*\*スレッドが再割り当てまたは割り当て解除されたコミュニケーション。`propertyValue`は、スレッドが再割り当てされた場合はWebhookのペイロードに含まれるアクターIDとなり、スレッドが割り当て解除された場合は空白となります。
* `status`\*\*：\*\*スレッドによって変更されたコミュニケーションのステータス。Webhookペイロード内の`propertyValue`は、`OPEN`または`CLOSED`のいずれかになります。
* `isArchived`\*\*：\*\*スレッドが復元されたコミュニケーション。Webhookペイロード内の`propertyValue`は、常に`FALSE`となります。
### 開発者アカウントでのサブスクリプションの作成
HubSpot開発者アカウント内でWebhookサブスクリプションを作成できます。
* HubSpotの開発者アカウントで、［アプリ］ダッシュボードに移動します。
* アプリの**名前**をクリックします。
* 左のサイドバーメニューで［Webhook］に移動します。
* ［サブスクリプションを作成］をクリックします。
* 右側のパネルで［どのオブジェクトタイプを選びますか？］のドロップダウンメニューをクリックし、サブスクリプションを作成する対象の**オブジェクト**を選択します。
* ［どのイベントについて知りたいですか？］のドロップダウンメニューをクリックし、**イベントタイプ**を選択します。
* プロパティー変更イベントのサブスクリプションを作成する場合は、［どのプロパティーを選びますか？］のドロップダウンメニューをクリックし、対象とする**プロパティー**を選択します。
* ［配信登録］をクリックします。
Webhook設定にサブスクリプションが表示されます。新しいサブスクリプションは一時停止状態で作成されるため、Webhookが送信されるようにするためにはサブスクリプションを有効にする必要があります。
* ［イベントのサブスクリプション］セクションで、オブジェクトタイプにカーソルを合わせ、［サブスクリプションを表示］をクリックします。
* イベントの横にある**チェックボックス**をオンにしてから、テーブルのヘッダーで［アクティベート］をクリックします。
### APIを使用したサブスクリプションの作成
以下のエンドポイントを使用すれば、プログラムに従ってサブスクリプションを作成できます。これらのエンドポイントにリクエストを送信する際は、開発者APIキーを使用する必要があります。
subscriptionオブジェクトには、以下のフィールドを格納できます。
| フィールド | Description |
| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | サブスクリプションごとのIDを表す数値。 |
| `createdAt` | サブスクリプションが作成された時間（ミリ秒単位）。 |
| `createdBy` | サブスクリプションを作成したユーザーに関連付けられているユーザーID。 |
| `active` | サブスクリプションが有効になっており、アクティブに通知をトリガーしているかどうかを示します。値には`true`または`false`を指定できます。 |
| `eventType` | サブスクリプションのタイプ。このセクションの冒頭の[表](https://developers.hubspot.jp/docs/guides/api/app-management/webhooks/overview#webhook-subscriptions)に、利用可能なサブスクリプションタイプが記載されています。 |
| `propertyName` | サブスクリプションで変更をリッスンする対象のプロパティーの名前。これはプロパティー変更サブスクリプションタイプにのみ必要です。 |
### サブスクリプションの取得
サブスクリプションのリストを取得するには、`GET`リクエストを`webhooks/v3/{appId}/subscriptions`に送信します。
レスポンスとして、サブスクリプションを表すオブジェクトの配列が返されます。各オブジェクトには、サブスクリプションに関する情報（ID、作成日、タイプ、現在有効になっているかどうかなど）が格納されています。レスポンスの例を次に示します。
```json theme={null}
// Example GET request to https://api.hubapi.com/webhooks/v3/{appId}/subscriptions
[
{
"id": 25,
"createdAt": 1461704185000,
"createdBy": 529872,
"eventType": "contact.propertyChange",
"propertyName": "lifecyclestage",
"active": false
},
{
"id": 59,
"createdAt": 1462388498000,
"createdBy": 529872,
"eventType": "company.creation",
"active": false
},
{
"id": 108,
"createdAt": 1463423132000,
"createdBy": 529872,
"eventType": "deal.creation",
"active": true
}
]
```
### 新規サブスクリプションの作成
新しいサブスクリプションを作成するには、`POST`リクエストを`webhooks/v3/{appId}/subscriptions`に送信します。
リクエスト本文には、以下のフィールドを含めることができます。
| フィールド | Description |
| -------------- | ------------------------------------------------------------------------- |
| `eventType` | サブスクリプションのタイプ。 |
| `propertyName` | サブスクリプションで変更をリッスンする対象のプロパティーの名前。これはプロパティー変更サブスクリプションタイプにのみ必要です。 |
| `active` | サブスクリプションが有効になっており、アクティブに通知をトリガーしているかどうかを示します。値には`true`または`false`を指定できます。 |
`id`、`createdAt`、`createdByの`各フィールドは自動的に設定されるため、リクエスト本文に含める必要はありません。
以下のリクエスト本文の例をご参照ください。
```json theme={null}
// Example POST request to https://api.hubapi.com/webhooks/v3/{appId}/subscriptions
{
"eventType": "company.propertyChange",
"propertyName": "companyname",
"active": false
}
```
`eventType`には、前のセクションで定義されている有効なサブスクリプションタイプを指定する必要があります。また、`propertyName`は有効なプロパティー名でなければなりません。顧客がこの値に一致するプロパティーを定義していない場合、このサブスクリプションによる通知は行われません。
### サブスクリプションの更新
サブスクリプションを有効化または一時停止するには、`PUT`リクエストを`webhooks/v3/{appId}/subscriptions/{subscriptionId}`に送信します。
リクエスト本文には、以下のフィールドを含めます。
| フィールド | Description |
| -------- | ------------------------------------------------------------------------- |
| `active` | サブスクリプションが有効になっており、アクティブに通知をトリガーしているかどうかを示します。値には`true`または`false`を指定できます。 |
### サブスクリプションの削除
サブスクリプションを削除するには、`DELETE`リクエストを`webhooks/v3/{appId}/subscriptions/{subscriptionId}`に送信します。
## Webhookペイロード
アプリのWebhook設定で指定したターゲットURLにあるエンドポイントでは、HubSpotから送信される、JSON形式のデータを含む`POST`リクエストを受信します。
Webhookエンドポイントで取得しているリクエストが実際にHubSpotから送信されたものであることを保証するために、HubSpotは、`X-HubSpot-Signature`ヘッダーを、貴社のアプリのクライアントシークレットとリクエスト詳細の組み合わせに基づくSHA-256ハッシュにします。詳しくは[リクエスト署名の検証方法](/apps/legacy-apps/authentication/validating-requests)をご覧ください。
以下の表を使用して、ペイロードに含まれる可能性のあるフィールドの詳細を確認してください。
| フィールド | Description |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objectId` | 作成／変更／削除されたオブジェクトのID。コンタクトの場合はコンタクトID、会社の場合は会社ID、取引の場合は取引ID、コミュニケーションの場合は[スレッドID](/api-reference/conversations-conversations-inbox-&-messages-v3/guide)になります。 |
| `propertyName` | プロパティー変更サブスクリプションの場合にのみ送信される、変更されたプロパティーの名前。 |
| `propertyValue` | プロパティー変更サブスクリプションの場合にのみ送信される、通知をトリガーしたプロパティーに新しく設定された値。 |
| `changeSource` | 変更のソース。コンタクトプロパティー履歴に表示される変更ソースのいずれかを指定できます。 |
| `eventId` | この通知をトリガーしたイベントのID。この値が一意であることは保証されません。 |
| `subscriptionId` | イベントに関する通知をトリガーしたサブスクリプションのID。 |
| `portalId` | イベントが発生した顧客の[HubSpotアカウントID](https://knowledge.hubspot.com/account-management/manage-multiple-hubspot-accounts#check-your-current-account)。 |
| `appId` | アプリケーションのID。複数のアプリが同じWebhook URLを示している場合に使用されます。 |
| `occurredAt` | このイベントが発生した時点のミリ秒単位のタイムスタンプ。 |
| `eventType` | この通知の対象となっているイベントタイプ。「Webhookサブスクリプション」のセクションに記載されている、サポートされているサブスクリプションタイプのリストを確認してください。 |
| `attemptNumber` | 0で始まる、貴社のサービスに通知するイベントの試行番号。サービスがタイムアウトした場合や、以下の「再試行」の項目に記載されているエラーが発生した場合、HubSpotは通知の再送信を試みます。 |
| `messageId` | Webhookでスレッドへの新しいメッセージをリッスンしている場合にのみ送信されます。新しいメッセージのIDです。 |
| `messageType` | Webhookでスレッドへの新しいメッセージをリッスンしている場合にのみ送信されます。送信するメッセージのタイプです。この値には、`MESSAGE`または`COMMENT`のいずれかを指定できます。 |
| フィールド | Description |
| ------------------------- | ----------------------------------------------------------------------------------------- |
| `primaryObjectId` | マージ先のID。このIDに該当するレコードが、マージ後に残されます。これは、HubSpotのマージUIでは右側に表示されるレコードに該当します。 |
| `mergedObjectIds` | マージ先にマージされるレコードを表すIDの配列。これは、HubSpotのマージUIでは左側に表示されるレコードに該当します。 |
| `newObjectId` | マージの結果として作成されたレコードのID。場合によっては、マージの結果として新しいレコードが作成されることがあるため、これは`primaryObjectId`とは別のものです。 |
| `numberOfPropertiesMoved` | マージ中に転送されたプロパティーの数を表す整数。 |
| フィールド | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `associationType` | 関連付けは、次のいずれかのタイプになります。