Please enable JavaScript to view this site.

Made in EU
HubSpot Forums

HubSpot API Data Model

Navigation: Catalog: AutomationV44 > Schemas

AutomationFlowById

Fetch all details for a single flow.

Catalog: AutomationV44

Schema: Flows

Label: {res:itgen_hubspot_automationflowbyid_plural}

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

☑

 

The flowId of the flow to fetch.

 

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

{res:itgen_hubspot_canenrollfromsalesforce}

☐

Whether or not this flow is visible is HubSpot's Salesforce integration.

createdAt

datetime

Created at

☐

The timestamp this flow was created.

crmObjectCreationStatus

string

{res:itgen_hubspot_crmobjectcreationstatus}

☐

This can be either `PENDING` or `COMPLETE`. This indicates if the CRM Object properties for this flow have been persisted. (The `description` and `customProperties`.) When creating a new flow, there is a delay between when the flow is created and when the associated CRM Object is updated. If this status is `PENDING` the CRM Object has not yet been updated with the most recent values from the flow. If this is `COMPLETE` then the most recent values have been persisted to the CRM Object. This API always returns the most recent values for `description` and `customProperties`.

customProperties

string

{res:itgen_hubspot_customproperties}

☐

Any custom properties set up for this flow.

description

string

Description

☐

The user-provided long-from description of this flow.

enrollmentCriteria_listFilterBranch_filterBranchOperator

string

{res:itgen_hubspot_enrollmentcriteria_listfilterbranch_filterbranchoperator}

☐

 

enrollmentCriteria_listFilterBranch_filterBranchType

string

{res:itgen_hubspot_enrollmentcriteria_listfilterbranch_filterbranchtype}

☐

 

enrollmentCriteria_shouldReEnroll

boolean

{res:itgen_hubspot_enrollmentcriteria_shouldreenroll}

☐

Whether or not the same object can enroll in this workflow twice.

enrollmentCriteria_type

string

{res:itgen_hubspot_enrollmentcriteria_type}

☐

The type of enrollment criteria this is, this can be "LIST_BASED", "EVENT_BASED", or "MANUAL".

enrollmentCriteria_unEnrollObjectsNotMeetingCriteria

boolean

{res:itgen_hubspot_enrollmentcriteria_unenrollobjectsnotmeetingcriteria}

☐

Whether or not to remove objects from this workflow if they stop meeting the enrollment criteria.

enrollmentSchedule_timeOfDay_hour

int32

{res:itgen_hubspot_enrollmentschedule_timeofday_hour}

☐

 

enrollmentSchedule_timeOfDay_minute

int32

{res:itgen_hubspot_enrollmentschedule_timeofday_minute}

☐

 

enrollmentSchedule_type

string

{res:itgen_hubspot_enrollmentschedule_type}

☐

The type of enrollment schedule this is, can be: "DAILY", "WEEKLY", "MONTHLY_SPECIFIC_DAYS", "MONTHLY_RELATIVE_DAYS", "YEARLY"

eventAnchor_contactProperty

string

{res:itgen_hubspot_eventanchor_contactproperty}

☐

A date property on the contact to use as the anchor point of this workflow.

eventAnchor_type

string

{res:itgen_hubspot_eventanchor_type}

☐

The type of event anchor this is, can be: "CONTACT_PROPERTY_ANCHOR" or "STATIC_DATE_ANCHOR"

flowType

string

{res:itgen_hubspot_flowtype}

☐

Deprecated. Will be removed.

goalFilterBranch_filterBranchOperator

string

{res:itgen_hubspot_goalfilterbranch_filterbranchoperator}

☐

 

goalFilterBranch_filterBranchType

string

{res:itgen_hubspot_goalfilterbranch_filterbranchtype}

☐

 

id

string

ID

☐

The unique ID for this flow. This is auto-generated when creating the flow.

isEnabled

boolean

{res:itgen_hubspot_isenabled}

☐

This controls whether or not the flow is "enabled" if it's actively listening for enrollment triggers and executing actions. If this is `false` the flow is not accepting any enrollments or executing any actions.

name

string

Name

☐

The user-provided name for this flow. Names get auto-created for workflows that are created without a name.

nextAvailableActionId

string

{res:itgen_hubspot_nextavailableactionid}

☐

The next available action ID to use when creating a new action for this flow.

objectTypeId

string

Ojbect Type ID

☐

The CRM object type for objects that can be enrolled into this flow. For `CONTACT_FLOW` flows, this will always be "0-1", the ID for the Contact object type.

revisionId

string

Revision ID

☐

Deprecated. Will be removed.

startActionId

string

{res:itgen_hubspot_startactionid}

☐

The ID for the starting action to execute.

suppressionFilterBranch_filterBranchOperator

string

{res:itgen_hubspot_suppressionfilterbranch_filterbranchoperator}

☐

 

suppressionFilterBranch_filterBranchType

string

{res:itgen_hubspot_suppressionfilterbranch_filterbranchtype}

☐

 

suppressionListIds

string

{res:itgen_hubspot_suppressionlistids}

☐

The listIds of any associated suppression lists. If an object is a member of a suppression list, then it will not be enrolled in this flow, even if it meets this flow's enrollment criteria.

type

string

Type

☐

The type of flow this is, this can be `CONTACT_FLOW` or `PLATFORM_FLOW`

unEnrollmentSetting_type

string

{res:itgen_hubspot_unenrollmentsetting_type}

☐

The type of unenrollment to perform:"ALL" - unenroll the object from all other flows"SELECTIVE" - only unenroll the object from the flows specified in `flowIds`

updatedAt

datetime

Updated at

☐

The timestamp this flow was last updated.

uuid

string

{res:itgen_hubspot_uuid}

☐

An optional unique key for this flow. This is only unique per-portal.

 

18-12-2024 20:09 Version 24.1.33-BETA+5180

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