topic Contact Workflow API: Missing Required Details? in APIs & Integrations

Contact Workflow API: Missing Required Details?

Tim_Munro — Mon, 23 Mar 2020 01:13:24 GMT

Using the HubSpot workflow API to query the definition of a contact workflow from one HubSpot portal, and replicate the workflow configuration into another HubSpot portal. Have foud that some of the workflow configuration detail is not available via the HubSpot API. Consider the fragment below - part of a "Get Workflow" response:

{
    "actions": [{
            "acceptActions": [{
                    "acceptActions": [{
                            "actionId": 27,
                            "emailCampaignGroupId": 71927769,
                            "emailCampaignId": 84131493,
                            "emailContentId": 8830681622,
                            "goalListCount": 0,
                            "stepId": 1,
                            "type": "EMAIL"
                        }, {
                            "actionId": 28,
                            "propertyName": "some_property",
                            "stepId": 1,
                            "type": "SET_CONTACT_PROPERTY"
                        }
                    ],
                    "actionId": 2,
                    "filters": [],
                    "filtersListId": 1195,

Notice the property filtersListId = 1195. This is an "If/Then" branch step and the "filtersListId" represents filter logic that is to be applied to determine which branch is to be followed. For example, the logic could be "IF Contact Property X=Test THEN follow accept branch".

Unfortunately there seems to be no way to retrieve, via the HubSpot API, details of what the logic of filtersListId = 1195 actually is. For example, calling the "Contact Lists API" with to retrieve the list with id 1195 returns a 404 not found error.

Has anyone successfully retrieved this detail via the HubSpot API?

Re: Contact Workflow API: Missing Required Details?

IsaacTakushi — Mon, 23 Mar 2020 19:12:48 GMT

Hi, @Tim_Munro.

Thanks for reaching out.

I'm seeing this behavior as well. (If I recall correctly, the v2 Workflows API previously displayed all filter conditions.)

Can you confirm the first four digits of the Hub ID you are querying and share the request URL (without any authentication details) so that I can share another example with my team?

Re: Contact Workflow API: Missing Required Details?

Tim_Munro — Mon, 23 Mar 2020 19:39:42 GMT

Thanks Isaac - that is interesting.

The Hub ID starts with: 4505 and we are calling the endpoint described here https://developers.hubspot.com/docs/methods/workflows/v3/get_workflow with workflowId set to 1043307.

Re: Contact Workflow API: Missing Required Details?

IsaacTakushi — Tue, 24 Mar 2020 13:14:09 GMT

Hi, @Tim_Munro.

Thanks, however I'm having trouble locating that workflow. Could you direct message me a link to it?

I'll be bringing this up to the team to get insight into whether anything changed and what can be done to surface this information for integrators like you.

I appreciate your understanding!

Re: Contact Workflow API: Missing Required Details?

IsaacTakushi — Tue, 24 Mar 2020 14:23:49 GMT

Hi, @Tim_Munro.

The team is investigating. No need to send me the link at this point!

Re: Contact Workflow API: Missing Required Details?

Tim_Munro — Tue, 24 Mar 2020 19:29:50 GMT

Thanks Isaac, much appreciated!

Re: Contact Workflow API: Missing Required Details?

IsaacTakushi — Tue, 31 Mar 2020 13:58:04 GMT

Hi, @Tim_Munro.

Thank you again for your patience.

This issue should now be resolved and the if/then branch's filters should be returned.

Please let me know if you are not seeing this behavior.

Re: Contact Workflow API: Missing Required Details?

Tim_Munro — Tue, 31 Mar 2020 19:37:48 GMT

Brilliant, yes I can see those filters again now & so can successfully clone the workflow if/then branches between portals. Thanks for the assistance @IsaacTakushi.

Re: Contact Workflow API: Missing Required Details?

dnfdrmn — Tue, 10 Oct 2023 05:11:52 GMT

Not to throw a wrench in the works @IsaacTakushi (and obviously it's 3-and-a-half years later), but when querying a workflow with multiple branches, only the first branch data is being returned….

E.g., this endpoint

https://api.hubapi.com/automation/v3/workflows/49279319
returns only the first branch filters, not the second branch as well.

Am I missing something?