メインコンテンツへスキップ
POST
/
webhooks
/
v3
/
{appId}
/
subscriptions
イベント配信登録を作成
curl --request POST \
  --url 'https://api.hubapi.com/webhooks/v3/{appId}/subscriptions?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "eventType": "contact.propertyChange",
  "propertyName": "email"
}
'
{
  "active": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "eventType": "company.associationChange",
  "id": "<string>",
  "eventTypeName": "<string>",
  "objectTypeId": "<string>",
  "propertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent HubStarter

承認

​
hapikey
string
query
必須

パスパラメータ

​
appId
integer<int32>
必須

アプリのID。

ボディ

application/json

Request to create a new webhook subscription for monitoring specific events. Each subscription defines which event type to listen for and whether to monitor all events of that type or specific property changes.

​
eventType
enum<string>
必須

待機するイベントのタイプ。許容される値には、contact.creation、contact.deletion、contact.propertyChangeのほか、その他のCRMオブジェクトやカスタムオブジェクトの同様のイベントタイプが含まれます。

利用可能なオプション:
company.associationChange,
company.creation,
company.deletion,
company.merge,
company.propertyChange,
company.restore,
contact.associationChange,
contact.creation,
contact.deletion,
contact.merge,
contact.privacyDeletion,
contact.propertyChange,
contact.restore,
conversation.creation,
conversation.deletion,
conversation.newMessage,
conversation.privacyDeletion,
conversation.propertyChange,
deal.associationChange,
deal.creation,
deal.deletion,
deal.merge,
deal.propertyChange,
deal.restore,
event.completed,
line_item.associationChange,
line_item.creation,
line_item.deletion,
line_item.merge,
line_item.propertyChange,
line_item.restore,
object.associationChange,
object.creation,
object.deletion,
object.merge,
object.propertyChange,
object.restore,
product.creation,
product.deletion,
product.merge,
product.propertyChange,
product.restore,
ticket.associationChange,
ticket.creation,
ticket.deletion,
ticket.merge,
ticket.propertyChange,
ticket.restore
​
active
boolean

Webhook配信登録を有効化するか一時停止するか。trueの場合、配信登録でWebhook通知が送信されます。falseの場合、配信登録は一時停止され、通知は送信されません。

​
eventTypeName
string

待機するイベントの名前。標準のeventType列挙値以外のカスタムイベントタイプを指定するためにカスタムオブジェクトで使用されます。

​
objectTypeId
string

サブスクリプションのオブジェクトタイプのID。標準のCRMオブジェクト（例：「コンタクト」、「会社」、「取引」）のほか、カスタムオブジェクトサブスクリプションの場合はカスタムオブジェクトIDを指定できます。

​
propertyName
string

変更をモニタリングするプロパティーの内部名。eventTypeがpropertyChangeの場合のみ適用されます。

レスポンス

successful operation

Complete details for an event subscription.

​
active
boolean
必須

Webhook配信登録を有効化するか一時停止するか。trueの場合、配信登録でWebhook通知が送信されます。falseの場合、配信登録は一時停止され、通知は送信されません。

​
createdAt
string<date-time>
必須

この配信登録が作成された日時。［Unixエポック］（#）からのミリ秒数の形式になります。

​
eventType
enum<string>
必須

待機するイベントのタイプ。許容される値には、contact.creation、contact.deletion、contact.propertyChangeのほか、その他のCRMオブジェクトやカスタムオブジェクトの同様のイベントタイプが含まれます。

利用可能なオプション:
company.associationChange,
company.creation,
company.deletion,
company.merge,
company.propertyChange,
company.restore,
contact.associationChange,
contact.creation,
contact.deletion,
contact.merge,
contact.privacyDeletion,
contact.propertyChange,
contact.restore,
conversation.creation,
conversation.deletion,
conversation.newMessage,
conversation.privacyDeletion,
conversation.propertyChange,
deal.associationChange,
deal.creation,
deal.deletion,
deal.merge,
deal.propertyChange,
deal.restore,
event.completed,
line_item.associationChange,
line_item.creation,
line_item.deletion,
line_item.merge,
line_item.propertyChange,
line_item.restore,
object.associationChange,
object.creation,
object.deletion,
object.merge,
object.propertyChange,
object.restore,
product.creation,
product.deletion,
product.merge,
product.propertyChange,
product.restore,
ticket.associationChange,
ticket.creation,
ticket.deletion,
ticket.merge,
ticket.propertyChange,
ticket.restore
​
id
string
必須

配信登録の固有ID。

​
eventTypeName
string

待機するイベントの名前。標準のeventType列挙値以外のカスタムイベントタイプを指定するためにカスタムオブジェクトで使用されます。

​
objectTypeId
string

サブスクリプションのオブジェクトタイプのID。標準のCRMオブジェクト（例：「コンタクト」、「会社」、「取引」）のほか、カスタムオブジェクトサブスクリプションの場合はカスタムオブジェクトIDを指定できます。

​
propertyName
string

変更をモニタリングするプロパティーの内部名。eventTypeがpropertyChangeの場合のみ適用されます。

​
updatedAt
string<date-time>

この配信登録が最後に更新された日時。［Unixエポック］（#）からのミリ秒数の形式になります。

Last modified on January 23, 2026