Navigation: Catalog: MarketingEvents > Schemas > Schema: Basic > Tables

MarketingEventCustomPropertiesByExternalEventId

Get Marketing Event by External IDsReturns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists.Only Marketing Events created by the same app making the request can be retrieved.

Catalog: MarketingEvents

Schema: Basic

This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function MarketingEventCustomPropertiesByExternalEventId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Default Value	Documentation
externalAccountId		☑
externalEventId		☑

Columns of Table Function

The columns of the table function MarketingEventCustomPropertiesByExternalEventId are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
attendees	int32	Attendees	☐	The number of HubSpot contacts that attended this marketing event.
cancellations	int32	Cancellations	☐	The number of HubSpot contacts that registered for this marketing event, but later cancelled their registration.
createdAt	datetime	Created at	☐	The creation date and time of the marketing event.
dataSensitivity	varchar2		☐	Level of data sensitivity
endDateTime	datetime	End Date Time	☐	The end date and time of the marketing event.
eventCancelled	char	Event Cancelled	☐	Indicates if the marketing event has been cancelled.
eventCompleted	char		☐	Indicates if the marketing event has been completed.
eventDescription	varchar2	Event Description	☐	The description of the marketing event.
eventName	varchar2	Event Name	☐	The name of the marketing event.
eventOrganizer	varchar2	Event Organizer	☐	The name of the organizer of the marketing event.
eventType	varchar2	Event Type	☐	The type of the marketing event.
eventUrl	varchar2	Event (URL)	☐	A URL in the external event application where the marketing event can be managed.
externalEventId	varchar2	External Event ID	☐	The id of the marketing event in the external event application.
id	varchar2	ID	☐	The ID of the marketing event CRM object.
isEncrypted	char		☐	Indicates whether the property is encrypted
isLargeValue	char		☐	Indicates whether the property value is stored as a large value in the storage
name	varchar2	Name	☐	Name of custom property
noShows	int32	No Shows	☐	The number of HubSpot contacts that registered for this marketing event, but did not attend. This field only had a value when the event is over.
objectId	varchar2	Object ID	☐	The ID of the marketing event CRM object.
persistenceTimestamp	int64	Persistence Timestamp	☐	The timestamp that indicates when the value being written is persisted in storage
registrants	int32	Registrants	☐	The number of HubSpot contacts that registered for this marketing event.
requestId	varchar2	Request ID	☐	The ID of the request
selectedByUser	char	Selected by User	☐	Indicates whether the property is selected
selectedByUserTimestamp	int64	Selected by User Timestamp	☐	Timestamp of when the property was selected by the user
source	varchar2	Source	☐	Source of the property
sourceId	varchar2	Source ID	☐	ID of the source of the property
sourceLabel	varchar2	Source Label	☐	Label of the source of the property
sourceMetadata	varchar2	Source Metadata	☐	Source metadata encoded as a base64 string
sourceUpstreamDeployable	varchar2		☐	Indicates which upstream service made the property change
sourceVid	varchar2	Source VID	☐	The unique identifier associated with the source.
startDateTime	datetime	Start Date Time	☐	The start date and time of the marketing event.
timestamp	int64	Timestamp	☐	Timestamp of the request
unit	varchar2		☐	The unit
updatedAt	datetime	Updated at	☐	The update date and time of the marketing event.
updatedByUserId	int32	Updated by User ID	☐	The ID of the user who last updated the property
useTimestampAsPersistenceTimestamp	char	Use Timestamp as Persistence Timestamp	☐	Indicates if the persistence timestamp is the same as storage version timestamp
value	varchar2	Value	☐	Custom property value

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

MarketingEventCustomPropertiesByExternalEventId

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information