Workflows are a central feature behind the platform, allowing you to quickly pull bulk data from APIs without needing to write custom code. To get started, just head to the Workflows Section and you'll see previous workflow's you've already added to your account or be asked to import new workflows from the Formulas library.

Click on your workflow to get started, and we'll review the steps you need to follow to run the workflow.

But First - Read the Workflow Instructions!

When you click on the workflow you want to run, you'll find instructions that the workflow author specifically wrote on what you need to do to run the workflow. These instructions are specific to the app & API you're trying to access, so make sure to read them as they will contain a lot of common answers.

1 - Enter Input Collections

Many workflows will ask you for inputs in the form of collections, which can be lists (one value per line) or more advanced JSON lists where each item can have multiple properties. You'll first see the input collections and will be prompted to enter values if the input collection is empty:

Just follow the instructions and click on the pencil icon to add values (one per line), and then save your changes:

Always be sure to read the input instructions in blue! If you enter faulty input, then you can be sure your workflow will fail and will waste your usage credits.

Edit Input Collections

If you've already ran a workflow in the past and want to change the inputs, you won't see the yellow warning any more and will instead see the item count in your input collection(s):

Just click on the pencil icon to open up the editor again and make changes for your next execution.

2 - Enter Execution Parameters

While input collections allow you to process multiple inputs in a collection, execution parameters are used when the workflow requires a single value to be used, e.g. an authentication token which will be used for all requests across all collection inputs:

Be sure to carefully read the instructions below each field! If you enter faulty input, then you can be sure your workflow will fail and will waste your usage credits.

3 - Review Optional Inputs

Depending on the workflow, you may see a section allowing you to enter optional inputs specific to the endpoint. These work just like execution parameters and will apply to all requests made in the execution.

Because these are optional, you can usually just skip this step when you're getting started.

4 - Review Rate Limiting Settings

Optional>This step is also optional, as wise defaults are chosen based on the endpoint the workflow is accessing. However, you can review and tweak these settings if you'd like or if you've experienced trouble in the past.

5 - Review Extractors

You can usually skip this step - as workflow authors typically pick wise extractors. Each extractor will result in a CSV file aggregating all of the data. If you ran the workflow before and want to remove unneeded files you get back, you can remove them here.

Note that in this example, the "Downstream" line indicates that it will trigger a followup "downstream" workflow using the output of the extractor as the input to the next workflow.

You can also click through to an existing extractor and review its settings, allowing you to filter the rows or columns you get back.

6 - Review Extraction Format

We strongly suggest leaving this alone and sticking with CSV files, as they are much smaller & manageable since they don't recreate the field names each time. If you must use a JSON file, you can select that here.

7 - Review Proxy Settings

If you're running a workflow and expect it to run more than 75 requests (including downstream workflow executions), then you'll typically just want to stick with using a dedicated proxy.

The default setting will launch a new dedicated proxy for you (at the selected location), and then terminate it when the workflow is finished. If it's a chained workflow with multiple steps, it will re-use the same proxy for all steps and then automatically terminate the proxy when it's done.

You may want to use a shared proxy if you're doing a small job or just testing it out. This will be faster (you don't need to wait for the proxy to launch), and you'll be charged less if you run under 75 requests in the workflow.

8 - Review Maximum Requests

You'll typically want to leave this alone at its default of 20,000 requests.

If you're just doing a test run or don't want to wait forever, you may want to change this to a small value like 10 to force the workflow execution to stop after making 10 requests. Note that this value is passed between chained workflows, so if you have a 2-step workflow and set this to 10, then each of the 2 steps will only perform up to 10 requests, totaling in 20 requests.

9 - Pick an Execution Name

This is also optional, but very helpful when you're running a lot of workflows. If you select a name for this run (usually you'll want to name this after your inputs, such as the list of YouTube channels in this example), then the email will use this name as a subject when it sends you back results. You'll also be able to quickly see the results on the web interface with that name.

10 - Execute It!

Once you've reviewed everything, just un-check the box below if you don't want an email and hit Execute! If you mess something up, you can always cancel it while it's running.

Did this answer your question?