HubSpot: Events schemas

← Events operations · All schemas

Retrieve event types — response body

Field	Type	Presence	Description and constraints
$	object	Root
eventTypes	array	Required within parent	List of event type names.
eventTypes[]	string	Each item

Retrieve events — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve events — response body — paging
results	array	Required within parent	An array of ExternalUnifiedEvent objects, each representing an individual event with its associated details.
results[]	Model	Each item	Expand Retrieve events — response body — results item

Referenced models: Retrieve events — response body — paging, Retrieve events — response body — results item

Retrieve events — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Retrieve events — response body — paging next
prev	Model	Optional	Expand Retrieve events — response body — paging prev

Referenced models: Retrieve events — response body — paging next, Retrieve events — response body — paging prev

Retrieve events — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	The cursor token to pass as the after query parameter to retrieve the next page of results.
link	string	Optional	The full URL of the next page of results, with the after cursor token included as a query parameter.

Retrieve events — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	The cursor token to pass as the before query parameter to retrieve the previous page of results.
link	string	Optional	The full URL of the previous page of results, with the before cursor token included as a query parameter.

Retrieve events — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
eventType	string	Required within parent	The format of the `eventType` string is `ae{appId}_{eventTypeLabel}`, `pe{portalId}_{eventTypeLabel}`, or just `e_{eventTypeLabel}` for HubSpot events.
id	string	Required within parent	A unique identifier for the event.
objectId	string	Required within parent	The objectId of the object which did the event.
objectType	string	Required within parent	The objectType for the object which did the event.
occurredAt	string	Required within parent	An ISO 8601 timestamp when the event occurred. Format: date-time
properties	object	Required within parent	A key-value map of event-specific properties. The available properties depend on the event type definition. Additional keys: see wildcard field
properties.*	string	Additional keys