Navigation: Catalog: ManageEventDefinitions > Schemas

EventDefinitionAssociationsByEventName

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 EventDefinitionAssociationsByEventName. 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 EventDefinitionAssociationsByEventName are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
allowsCustomLabels	char		☐	Whether custom labels can be used in the association.
archived	char	Archived	☐
cardinality	varchar2		☐	The cardinality from the source object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
category	varchar2	Category	☐	The error category
comboEventRules_operationType	varchar2		☐
createdAt	datetime	Created at	☐
createdUserId	int32	Created User ID	☐
customMatchingId_primaryObjectRule_eventPropertyName	varchar2		☐
customMatchingId_primaryObjectRule_targetObjectPropertyName	varchar2		☐
description	varchar2	Description	☐
detailTemplate	varchar2	Detail Template	☐
fromObjectType	varchar2		☐	The name of the source object type (e.g,. "DEAL" or "QUOTE").
fromObjectTypeId	varchar2	From Object Type ID	☐	The ID of the source object type (e.g., 0-1 for contacts).
fullyQualifiedName	varchar2	Fully Qualified Name	☐
hasAllAssociatedObjects	char		☐	Whether all potential linked objects are included in the association
hasCascadingDeletes	char		☐	Whether deletions in the association should cause cascading deletes to linked objects.
hasUserEnforcedMaxFromObjectIds	char		☐	Whether a user has set a limit for the number of source objects.
hasUserEnforcedMaxToObjectIds	char		☐	Whether a user has set a limit for the number of destination objects.
headerTemplate	varchar2	Header Template	☐
hidden	char	Hidden	☐	Whether the association is hidden or not.
hiddenReason	varchar2		☐
id_2	varchar2	ID (Alternate 2)	☐
id	int32	ID	☐	The unique ID of the associated object (e.g., a contact ID).
inverseAllowsCustomLabels	char		☐	Whether the reverse association can also support custom labels.
inverseCardinality	varchar2		☐	The cardinality from the destination object's perspective, either "ONE_TO_ONE" or "ONE_TO_MANY".
inverseHasAllAssociatedObjects	char		☐	Whether all potential reverse linked objects are included in the association.
inverseId	int32		☐	The unique ID for the inverse side of the association.
inverseLabel	varchar2		☐	The label used to describe the reverse relationship in an association.
inverseName	varchar2		☐	The name used to describe the inverse relationship in this association
isDefault	char	Is Default	☐
isInversePrimary	char		☐	Whether the inverse association is considered primary.
isPrimary	char		☐	Whether the association is the primary link between the entities involved.
label	varchar2	Label	☐	The label given to an association.
labels_plural	varchar2	Labels Plural	☐
labels_singular	varchar2	Labels Singular	☐
maxFromObjectIds	int32		☐	The maximum number of source object IDs allowed in the association.
maxToObjectIds	int32		☐	The maximum number of destination object IDs allowed in the association.
name_2	varchar2	Name (Alternate 2)	☐
name	varchar2	Name	☐	For labeled association types, the internal name of the association.
objectTypeId	varchar2	Ojbect Type ID	☐
portalUniqueIdentifier	varchar2		☐	A unique across-portal ID applied to the association.
primaryObject	varchar2		☐
primaryObjectId	varchar2		☐
readOnly	char		☐
toObjectType	varchar2		☐	The name of the destination object type (e.g,. "DEAL" or "QUOTE").
toObjectTypeId	varchar2	To Object Type ID	☐	The ID of the destination object type (e.g., 0-3 for deals).
trackingType	varchar2		☐
updatedAt	datetime	Updated at	☐
updatedUserId	int32	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

EventDefinitionAssociationsByEventName

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information