{scope}
Remember to sync up with new lead!
", "associations": [ { "target": { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 10 }, "value": { "type": "ENROLLED_OBJECT" } } ], "use_explicit_associations": "true", "priority": "NONE" } } ``` ### Create a new record The action definition below creates a new deal and associates it with the contact enrolled in the workflow: ```json theme={null} { "type": "SINGLE_CONNECTION", "actionId": "2", "actionTypeVersion": 0, "actionTypeId": "0-14", "connection": { "edgeType": "STANDARD", "nextActionId": "3" }, "fields": { "object_type_id": "0-3", "properties": [ { "targetProperty": "dealstage", "value": { "type": "STATIC_VALUE", "staticValue": "appointmentscheduled" } }, { "targetProperty": "dealname", "value": { "type": "STATIC_VALUE", "staticValue": "New deal" } }, { "targetProperty": "amount", "value": { "type": "STATIC_VALUE", "staticValue": "1000" } } ], "associations": [ { "target": { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 3 }, "value": { "type": "ENROLLED_OBJECT" } } ], "use_explicit_associations": "true" } } ``` ### Add an enrolled object to a static list The action definition below adds an enrolled contact to a static list, specified as the `listId`. ```json theme={null} { "actionId": "3", "actionTypeVersion": 0, "actionTypeId": "0-63809083", "fields": { "listId": "123" }, "type": "SINGLE_CONNECTION" } ``` ### Remove an enrolled object from a static list The action definition below removes an enrolled contact from a static list, specified as the `listId`. ```json theme={null} { "actionId": "3", "actionTypeVersion": 0, "actionTypeId": "0-63863438", "fields": { "listId": "123" }, "type": "SINGLE_CONNECTION" } ``` ### Branching actions Branching actions differ from other actions in that they don't follow the standard action structure. Branching action definitions don't have `fields` or `connection` properties. There are two types of branching actions: list branch actions and static branch actions. Both types must also define a default branch using the `defaultBranchName` and `defaultBranch` properties. #### List branch actions List branch actions include a `listBranches` property that specifies a set of filter branches to segment enrolled objects. Each `filterBranch` is configured using the syntax and formatting outlined in the [list filters documentation](/api-reference/legacy/crm/lists/list-filters). ```json theme={null} { "actionId": "6", "listBranches": [ { "filterBranch": {}, "connection": { "edgeType": "STANDARD", "nextActionId": "7" } }, { "filterBranch": {}, "branchName": "Some branch name", "connection": { "edgeType": "GOTO", "nextActionId": "4" } } ], "defaultBranchName": "Fall-through branch", "defaultBranch": { "edgeType": "STANDARD", "nextActionId": "8" } } ``` #### Static branch actions Static branch actions include an `inputValue` definition, which supports different shapes for the input values of the branch. It also includes a list of `staticBranches`, which defines which actions come next in the branch. ```json theme={null} { "actionId": "1", "inputValue": { "propertyName": "example_property" }, "staticBranches": [ { "branchValue": "example_value_1", "connection": { "edgeType": "STANDARD", "nextActionId": "2" } }, { "branchValue": "example_value_1", "connection": { "edgeType": "STANDARD", "nextActionId": "3" } } ], "defaultBranchName": "Fall-through branch", "defaultBranch": { "edgeType": "STANDARD", "nextActionId": "4" } } ``` ## Enrollment criteria You can configure the conditions for objects to be enrolled in your workflow within the `enrollmentCriteria` property of your workflow specification. * The data you specify varies based on whether your enrollment is event-based or list-based. You can specify the enrollment type by setting the `type` of `enrollmentCriteria` to either `EVENT_BASED` or `LIST_BASED`. * You can specify the re-enrollment settings for objects enrolled in your workflow by setting the `shouldReEnroll` field to `true` or `false`. Learn more about [workflow enrollment triggers](https://knowledge.hubspot.com/workflows/set-your-workflow-enrollment-triggers). ### Event-based enrollment Event-based workflows will enroll objects when specific events occur, such as when a form is submitted. * You can configure the criteria for which events will trigger enrollment by defining a list of `eventFilterBranches`. Each `eventFilterBranch` definition specifies a qualifying event (e.g., a form submission) using an `eventTypeId` that corresponds to that event. * Most events will have the same values for the following fields: * `operator`: `"HAS_COMPLETED"` * `filterBranchType`: `"UNIFIED_EVENTS"` * `filterBranchOperator`: `"AND"` The table below defines each `eventTypeId` that corresponds to the event you can configure for your workflow.