Using Browse AI with Workflows

Overview

Browse AI is a service that allows you to automatically extract data from websites without writing code. Its core components are Robots, which are configured to scrape specific data, and Tasks, which are individual runs of a robot. This integration connects Browse AI to your CRM's Workflow Builder, enabling you to trigger automations based on completed web scraping tasks and to initiate new scraping tasks directly from your workflows.

About the Integration

The integration consists of two main parts: a trigger and several actions. The trigger allows your workflows to start automatically when a Browse AI task is finished. The actions let your workflows command Browse AI to perform new scraping tasks. Please note that using these workflow steps consumes premium automation credits. Any usage fees for Browse AI itself, such as robot or task credits, are billed separately through your Browse AI account.

How to Set Up the Browse AI Integration

Before you can use Browse AI triggers or actions, you must connect your Browse AI account using an API key.

Connect via the Workflow Builder (Recommended)

1. Navigate to Automation > Workflows and open an existing workflow or create a new one.
2. Add a new step and go to the Apps tab.
3. Search for and select Browse AI.
4. Choose any Browse AI trigger or action. On the configuration card that appears, click Connect your account.
5. In the pop-up window, paste your Browse AI API key. To get this key, log into your Browse AI dashboard, go to Settings > API Keys, create a new key, and copy it.
6. Click Save. The connection status will update to show 'Connected'.

Connect via Settings (Alternative Method)

1. Go to Settings > Integrations.
2. Find the Browse AI integration and click Connect.
3. Paste your API key and click Save.

Managing Multiple Browse AI Accounts

If you connect more than one Browse AI account, a Connected Account dropdown will appear in the configuration for every trigger and action. This allows you to specify which account the step should use. If only one account is connected, it will be selected by default.

Available Triggers

The integration currently offers one trigger.

• New Completed Task: This trigger activates a workflow when a task run by a Browse AI robot finishes. You can filter this trigger to only run for specific robots or based on other task criteria. It is an instant trigger.

Available Actions

The integration provides several actions for interacting with Browse AI.

• Run Task: Executes a single run of a specified Browse AI robot.
• Bulk Run Tasks: Queues multiple runs of the same robot at once, using a list of inputs.
• Get Task: Retrieves the data and status of a previously run task using its ID.
• Get Bulk Run: Fetches the results for an entire batch of tasks that were run together.

Example: Setting Up a Trigger for a New Completed Task

This example shows how to create a workflow that starts whenever a specific Browse AI robot finishes a task.

Step 1: Add the Trigger

Open your workflow and click Add Trigger. Navigate to the Apps tab, search for Browse AI, and select the New completed task trigger.

Step 2: Configure the Trigger

• Connected Account: Select the Browse AI account you want to monitor. This field is auto-filled if you only have one account connected.
• Workflow Trigger Name: Enter a descriptive name for the trigger.
• Filters > Robot: Choose the specific Browse AI robot you want to watch for completed tasks.
• Filters > Select Operator: Optionally, add conditions to further narrow down which tasks activate the workflow, such as based on the task's status or the data it captured.

Step 3: Test the Trigger

Click Find New Records in the testing panel. The system will search for recent completed tasks that match your criteria. Select one of the returned records from the dropdown to use its data structure for subsequent workflow steps. Finally, click Save Trigger.

Example: Setting Up a 'Run Task' Action

This example demonstrates how to add an action that runs a Browse AI robot and uses the results in the workflow.

Step 1: Add the Action

Within your workflow, click Add to insert a new step. Go to the Apps tab, select Browse AI, and choose the Run task action.

Step 2: Connect Your Account (First Time Only)

If you haven't connected Browse AI yet, click Connect your account on the action card. Paste your API key and click Save.

Step 3: Configure the Action

• Action Name: Give the action a clear name.
• Robot: Select the Browse AI robot you want to run.
• Input Parameters: Provide the necessary inputs for the robot. You can use dynamic variables from your workflow, such as a URL submitted through a form (e.g., {{form.submitted_url}}).

Step 4: Continue the Workflow

After the action is configured, you can add subsequent steps to your workflow. These steps can use the data captured by the Browse AI task, which will be available once the task is complete.