Navigation: Catalog: ManageEventDefinitions > Schemas

EventDefinitioPropertiesByEventName

Retrieve a custom event definitionFetch a single custom event definition by name.

Catalog: ManageEventDefinitions

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 EventDefinitioPropertiesByEventName. 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
eventName		☑

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
archived_2	char		☐
archived	char	Archived	☐	Whether the property is archived.
archivedAt	datetime	Archived at	☐	The timestamp when the property was archived, in ISO 8601 format.
calculated	char	Calculated	☐	Whether the property is a calculated field.
calculationFormula	varchar2	Calculation Formula	☐	The formula used for calculated properties.
comboEventRules_operationType	varchar2		☐
createdAt_2	datetime		☐
createdAt	datetime	Created at	☐	The timestamp when the property was created, in ISO 8601 format.
createdUserId_2	int32		☐
createdUserId	varchar2	Created User ID	☐	The ID of the user who created the property.
currencyPropertyName	varchar2		☐	The name of the related currency property.
customMatchingId_primaryObjectRule_eventPropertyName	varchar2		☐
customMatchingId_primaryObjectRule_targetObjectPropertyName	varchar2		☐
dataSensitivity	varchar2		☐	Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
dateDisplayHint	varchar2		☐
description_2	varchar2		☐
description	varchar2	Description	☐	A summary of the property's purpose.
detailTemplate	varchar2	Detail Template	☐
displayOrder	int32	Display Order	☐	The position of the item relative to others in the list.
externalOptions	char	External Options	☐	Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.
fieldType	varchar2	Field Type	☐	Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.
formField	char	Form Field	☐	Whether the property can appear on forms.
fullyQualifiedName	varchar2	Fully Qualified Name	☐
groupName	varchar2	Group Name	☐	The name of the group to which the property is assigned.
hasUniqueValue	char	Has Unique Value	☐	Whether the property is a unique identifier property.
headerTemplate	varchar2	Header Template	☐
hidden	char	Hidden	☐	Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.
hubspotDefined	char	HubSpot Defined	☐	A boolean value set to true for HubSpot default properties.
id	varchar2	ID	☐
label	varchar2	Label	☐	The display label for the property.
labels_plural	varchar2	Labels Plural	☐
labels_singular	varchar2	Labels Singular	☐
modificationMetadata_archivable	char		☐
modificationMetadata_readOnlyDefinition	char		☐
modificationMetadata_readOnlyOptions	char		☐
modificationMetadata_readOnlyValue	char		☐
name_2	varchar2	Name (Alternate 2)	☐
name	varchar2	Name	☐	The internal name for the property.
numberDisplayHint	varchar2		☐	Hint for how a number property is displayed and validated in HubSpot's UI. Can be: "unformatted", "formatted", "currency", "percentage", "duration", or "probability".
objectTypeId	varchar2	Ojbect Type ID	☐
primaryObject	varchar2		☐
primaryObjectId	varchar2		☐
referencedObjectType	varchar2	Referenced Object Type	☐	Deprecated. Use externalOptionsReferenceType instead.
showCurrencySymbol	char	Show Currency Symbol	☐	Whether to show the currency symbol in HubSpot's UI.
trackingType	varchar2		☐
type	varchar2	Type	☐	The data type of the property, such as string or number.
updatedAt_2	datetime		☐
updatedAt	datetime	Updated at	☐	The timestamp when the property was last updated, in ISO 8601 format.
updatedUserId_2	int32		☐
updatedUserId	varchar2	Updated User ID	☐

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

EventDefinitioPropertiesByEventName

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information