Zum Hauptinhalt springen
POST
/
events
/
v3
/
send
カスタムイベント完了を送信
curl --request POST \
  --url https://api.hubapi.com/events/v3/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "occurredAt": "2023-11-07T05:31:56Z",
  "eventName": "pe123456_account_login",
  "utk": "<string>",
  "uuid": "<string>",
  "email": "mark.s@lumon.industries",
  "properties": "{\"hs_page_id\":\"1234567890\",\"hs_element_id\":\"login-button\",\"hs_page_title\":\"homepage\"}",
  "objectId": "089274502"
}'
This response has no body data.
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise
この API には、次のいずれかのスコープが必要です。
analytics.behavioral_events.send

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
eventName
string
required

イベントの内部名（「pe<portalID>_eventName」）。[イベント定義API]（https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#get-%2Fevents%2Fv3%2Fevent-definitions）を使用するか、[HubSpotのUI]（https://knowledge.hubspot.com/reports/create-custom-behavioral-events-with-the-code-wizard#find-internal-name）で取得できます。

Example:

"pe123456_account_login"

​
occurredAt
string<date-time>

このイベントが発生した時刻。これが設定されていない場合、現在の時刻が使用されます。

​
utk
string

訪問者のユーザートークン。イベントデータをCRMレコードに関連付けるために使用されます。

​
uuid
string

固有IDをイベント完了に割り当てるには汎用一意識別子を含めます。HubSpotと他の外部システム間でデータを照合する場合に有用です。

​
email
string

訪問者のEメールアドレス。イベントデータをCRMレコードに関連付けるために使用されます。

Example:

"mark.s@lumon.industries"

​
properties
object

更新するイベントプロパティー。キーと値ペアの形式になります（プロパティーの内部名とプロパティー値）。[HubSpotのデフォルトのイベントプロパティー]（https://developers.hubspot.com/docs/guides/api/analytics-and-events/custom-events/custom-event-definitions#hubspot-s-default-event-properties）についてもっと詳しく。

Example:

"{\"hs_page_id\":\"1234567890\",\"hs_element_id\":\"login-button\",\"hs_page_title\":\"homepage\"}"

​
objectId
string

イベントを完了したオブジェクトのID（例えば、コンタクトIDや訪問者ID）。

Example:

"089274502"

⌘I