Workflows
Manages and retrieves workflows configured in HubSpot to automate marketing, sales, and service processes.
Table Specific Information
Workflows are automated tasks in HubSpot. You can perform automated tasks with contacts by enrolling contacts in workflows.
SELECT
When selecting workflows, data may be filtered by the WorkflowId. For example:
SELECT * FROM Workflows WHERE WorkflowId = '123456789'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
Unique identifier assigned to the workflow. | |
| Name | String | False |
The user-friendly name assigned to the workflow, displayed in HubSpot. | |
| Description | String | False |
Detailed explanation of the workflow's purpose or objective. | |
| IsEnabled | Boolean | False |
Boolean indicating whether the workflow is currently active and can execute. | |
| CreatedAt | Datetime | True |
Timestamp indicating when the workflow was initially created. | |
| UpdatedAt | Datetime | True |
Timestamp indicating the most recent update made to the workflow. | |
| AllowContactToTriggerMultipleTimes | Boolean | False |
Boolean specifying whether the same contact can trigger and be enrolled in this workflow multiple times. | |
| CanEnrollFromSalesforce | Boolean | False |
Boolean indicating whether contacts can be enrolled into this workflow via Salesforce integration. | |
| IsInternal | Boolean | False |
Boolean flag showing whether the workflow is internal and not user-facing. | |
| LegacyCampaignId | Long | False |
Identifier for any legacy campaign associated with the workflow, if applicable. | |
| LegacyMigration | Boolean | False |
Boolean indicating whether this workflow was migrated from HubSpot's legacy lead nurturing tool. | |
| IsListening | Boolean | False |
Boolean specifying whether the workflow is actively monitoring for trigger conditions. | |
| ContactListIdsCompleted | Long | True |
ID referencing the list of contacts who have completed the workflow. | |
| ContactListIdsEnrolled | Long | True |
ID referencing the list of contacts currently enrolled in the workflow. | |
| ContactListIdsSucceeded | Long | True |
ID referencing the list of contacts who successfully completed all steps in the workflow. | |
| ContactListIdsActive | Long | True |
ID referencing the list of contacts currently active within the workflow. | |
| StepsAggregate | String | False |
Aggregate containing the ordered steps and actions defined within the workflow. | |
| SupresssionSettingsAggregate | String | False |
Aggregate defining suppression settings used to prevent specific contacts from entering the workflow. | |
| TriggersAggregate | String | False |
Aggregate listing the trigger conditions that enroll contacts into the workflow. | |
| UnenrollmentSettingType | String | False |
Defines how unenrollment is handled when a contact meets specific conditions. | |
| UnenrollmentSettingExcludedWorkflowsAggregate | String | False |
Aggregate listing workflows from which a contact should be removed upon enrolling in this workflow. | |
| GoalListAggregate | String | False |
Aggregate listing the goal IDs associated with this workflow, used to measure its success. | |
| ExtraUrlParameters | String | True |
Optional input-only property for adding additional query parameters when querying workflow data. Format parameters as name=value pairs separated by commas (for example: 'param1=value1, param2=value2, param3=value3'). |