HubSpot: Event completions schemas
2 HubSpot schemas with complete fields and constraints.
← Event completions operations · All schemas
Send a batch of event occurrences — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | An array of BehavioralEventHttpCompletionRequest objects, each representing a single behavioral event to be completed. This property is required. |
inputs[] | Model | Each item | Expand Send a custom event occurrence — request body — body |
Referenced models: Send a custom event occurrence — request body — body
Send a custom event occurrence — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The visitor's email address. Used for associating the event data with a CRM record. |
eventName | string | Required within parent | The event's fully qualified name. This value (formatted as `pe{HubID}_{name}`) can be retrieved through the [event definitions API](https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#get-%2Fevents%2Fv3%2Fevent-definitions) or in [HubSpot's UI](https://knowledge.hubspot.com/reports/create-custom-behavioral-events-with-the-code-wizard#find-internal-name). |
objectId | string | Optional | The ID of the record for which the event occurred (e.g., contact ID or visitor ID). |
occurredAt | string | Optional | The time when this event occurred. If this isn't set, the current time will be used. Format: date-time |
properties | object | Required within parent | The event properties to update. Takes the format of key-value pairs (property internal name and property value). Learn more about [HubSpot's default event properties](https://developers.hubspot.com/docs/guides/api/analytics-and-events/custom-events/custom-event-definitions#hubspot-s-default-event-properties). Additional keys: see wildcard field |
properties.* | string | Additional keys | |
utk | string | Optional | The visitor's usertoken. Used for associating the event data with a CRM record. |
uuid | string | Optional | A unique identifier for the event occurrence. Must be unique within the event type. If not provided, HubSpot will generate a random UUID. When multiple events have the same ID within a year, the first will be accepted and all others will be rejected. Can be useful for matching data between HubSpot and other external systems. |