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

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

アプリのID。

Body

application/json

New webhook settings for an app.

​
eventType
enum<string>
required

待機するイベントのタイプ。「create」、「delete」、「deletedForPrivacy」、または「propertyChange」のいずれかになります。

Available options:
contact.propertyChange,
company.propertyChange,
deal.propertyChange,
ticket.propertyChange,
product.propertyChange,
line_item.propertyChange,
contact.creation,
contact.deletion,
contact.privacyDeletion,
company.creation,
company.deletion,
deal.creation,
deal.deletion,
ticket.creation,
ticket.deletion,
product.creation,
product.deletion,
line_item.creation,
line_item.deletion,
conversation.creation,
conversation.deletion,
conversation.newMessage,
conversation.privacyDeletion,
conversation.propertyChange,
contact.merge,
company.merge,
deal.merge,
ticket.merge,
product.merge,
line_item.merge,
contact.restore,
company.restore,
deal.restore,
ticket.restore,
product.restore,
line_item.restore,
contact.associationChange,
company.associationChange,
deal.associationChange,
ticket.associationChange,
line_item.associationChange,
object.propertyChange,
object.creation,
object.deletion,
object.merge,
object.restore,
object.associationChange
Example:

"contact.propertyChange"

​
objectTypeId
string
​
propertyName
string

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

Example:

"email"

​
active
boolean

配信登録が有効か停止されているかが判断されます。既定値はfalseです。

Example:

true

Response

successful operation

Complete details for an event subscription.

​
createdAt
string<date-time>
required

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

​
active
boolean
required

配信登録が有効か停止されているかが判断されます。

​
eventType
enum<string>
required

待機するイベントのタイプ。「create」、「delete」、「deletedForPrivacy」、または「propertyChange」のいずれかになります。

Available options:
contact.propertyChange,
company.propertyChange,
deal.propertyChange,
ticket.propertyChange,
product.propertyChange,
line_item.propertyChange,
contact.creation,
contact.deletion,
contact.privacyDeletion,
company.creation,
company.deletion,
deal.creation,
deal.deletion,
ticket.creation,
ticket.deletion,
product.creation,
product.deletion,
line_item.creation,
line_item.deletion,
conversation.creation,
conversation.deletion,
conversation.newMessage,
conversation.privacyDeletion,
conversation.propertyChange,
contact.merge,
company.merge,
deal.merge,
ticket.merge,
product.merge,
line_item.merge,
contact.restore,
company.restore,
deal.restore,
ticket.restore,
product.restore,
line_item.restore,
contact.associationChange,
company.associationChange,
deal.associationChange,
ticket.associationChange,
line_item.associationChange,
object.propertyChange,
object.creation,
object.deletion,
object.merge,
object.restore,
object.associationChange
​
id
string
required

配信登録の固有ID。

​
objectTypeId
string

配信登録に関連付けられているオブジェクトタイプのID。

​
propertyName
string

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

​
updatedAt
string<date-time>

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

⌘I