Please enable JavaScript to view this site.

Made in EU
HubSpot Forums

HubSpot API Data Model

Navigation: Catalog: Automation > Schemas

AutomationFlowById

Retrieve a workflowRetrieve the details of a specific automation flow using its unique flow ID.

Catalog: Automation

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 AutomationFlowById. 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

flowId

string

☑

 

 

 

Columns of Table Function

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

Name

Data Type

Label

Required

Documentation

canEnrollFromSalesforce

boolean

 

☐

 

createdAt

datetime

Created at

☐

 

crmObjectCreationStatus

string

 

☐

 

customProperties

string

 

☐

 

description

string

Description

☐

 

enrollmentCriteria_listFilterBranch_filterBranchOperator

string

 

☐

Defines the logical operator used to combine multiple filter branches.

enrollmentCriteria_listFilterBranch_filterBranchType

string

 

☐

Indicates the type of filter branch, defaulting to OR.

enrollmentCriteria_shouldReEnroll

boolean

 

☐

Determines if objects should be re-enrolled when they meet the criteria again.

enrollmentCriteria_type

string

 

☐

Specifies the type of enrollment criteria, which defaults to 'LIST_BASED'.

enrollmentCriteria_unEnrollObjectsNotMeetingCriteria

boolean

 

☐

Indicates whether objects not meeting the criteria should be unenrolled.

enrollmentSchedule_timeOfDay_hour

int32

 

☐

The hour component of the time, represented as an integer.

enrollmentSchedule_timeOfDay_minute

int32

 

☐

The minute component of the time, represented as an integer.

enrollmentSchedule_type

string

 

☐

Specifies the type of enrollment schedule, which is 'DAILY'.

eventAnchor_contactProperty

string

 

☐

Specifies the contact property associated with the anchor.

eventAnchor_type

string

 

☐

Indicates the type of the contact property anchor, which defaults to CONTACT_PROPERTY_ANCHOR.

flowType

string

 

☐

 

goalFilterBranch_filterBranchOperator

string

 

☐

Defines the logical operator used to combine multiple filter branches.

goalFilterBranch_filterBranchType

string

 

☐

Indicates the type of filter branch, defaulting to OR.

id

string

ID

☐

 

isEnabled

boolean

 

☐

 

name

string

Name

☐

 

nextAvailableActionId

string

 

☐

 

objectTypeId

string

Ojbect Type ID

☐

 

revisionId

string

Revision ID

☐

 

startActionId

string

 

☐

 

suppressionFilterBranch_filterBranchOperator

string

 

☐

Defines the logical operator used to combine multiple filter branches.

suppressionFilterBranch_filterBranchType

string

 

☐

Indicates the type of filter branch, defaulting to OR.

suppressionListIds

string

 

☐

 

type

string

Type

☐

 

unEnrollmentSetting_type

string

 

☐

Specifies the type of unenrollment setting, with possible values being ALL or SELECTIVE.

updatedAt

datetime

Updated at

☐

 

uuid

string

 

☐

 

 

X

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.
  
Disclaimer