API: Organize custom (DIY) integration flows using groups

If you have a custom integration tile with many flows, you can use either the integrator.io UI or the integrator.io API, as described in this article, to create groups and assign flows to groups. Each group will act as a filter within the integration console. When you click the group name, only flows assigned to that group will be displayed.

Contents

• A. Plan your flow groups
• B. Create flow groups
• C. Assign a flow to a group

A. Plan your flow groups

• Determine the groups that are needed and a logical order. Identify clear, distinct names for each group that align with your business processes.
• Determine which flows should be assigned to each group. Each flow can be assigned to only one group. It may be helpful to retrieve the ID of each flow from its URL while you are viewing it in integrator.io and record it in a reference table for each group you will create.
  
  Reference table template

  Group Name: ID Returned from API:
  Flow Name	Flow ID

• Keep in mind that once you start assigning flows to groups, any flows not assigned to a group will appear under a Miscellaneous group in the UI. The Miscellaneous group will be listed last under all other groups.
  

B. Create flow groups

1. Make a GET call on your /integrations resource.
2. Copy the response from the GET call. Then, make a PUT call to your /integrations resource with the named groups added as shown at the end of the example below.

Note: Groups will appear in the integration console in the order in which they are created in the PUT call.

Request body:

  {
    "_id": "5fe••••••••••••••••••054",
    "lastModified": "2021-02-23T04:33:52.961Z",
    "name": "Test Integration",
    "install": [],
    "mode": "settings",
    "_registeredConnectionIds": [
        "5ef••••••••••••••••••759"
    ],
    "installSteps": [
        {
            "name": "[sfnsiodemo] integrator.io Connection",
            "completed": true,
            "type": "connection",
            "sourceConnection": {
                "type": "rest",
                "name": "[sfnsiodemo] integrator.io Connection",
                "assistant": "integratorio"
            }
        },
        {
            "name": "Copy resources now from template zip",
            "completed": true,
            "type": "template_zip",
            "templateZip": true
        }
    ],
    "uninstallSteps": [],
    "flowGroupings":  [
       {
            "name": "Flow Group 1"
        },
        {
            "name": "Flow Group 2"
        }
    ]
}

3. In the response, you will receive a unique ID for each flow group. Make note of each ID and the flows you will assign to it for the next steps.

C. Assign a flow to a flow group

1. Make a GET call on your /flows resource for the first flow ID you want to assign to a group.
2. Copy the response from the GET call. Then, make a PATCH call to your /flows resource to assign a flowGroupingId as shown at the end of the example below.

Request body:

{
  "_id": "5fe••••••••••••••••••bef",
  "_flowGroupingId": "ID_FROM_PREVIOUS_STEP"
}

3. Repeat the previous steps for each flow ID you want to assign to a group.

Note: If you clone an integration that includes flow groups, the flow groups are cloned but the cloned flows are not assigned to them. To assign flows to flow groups for a cloned integration, repeat the previous steps.