Skip to main content
The Bright Data Partner connector lets you retrieve data from Bright Data’s scraping and data collection APIs directly within a Boomi process. You can integrate with the SERP, Dataset, Scraper, and Unlocker APIs to build end-to-end public web data workflows without leaving the Boomi platform.
The Bright Data Partner connector is developed and maintained by Bright Data. Customer support is handled through the Boomi Support Portal, where tickets are triaged to Bright Data.

​
Supported objects

The connector supports the following object types, each accessed via the Execute action:
ObjectDescription
DatasetAccess marketplace datasets with filtering and snapshot retrieval
ScraperSubmit web scraping jobs and retrieve results asynchronously
UnlockerAccess protected web content via proxy and unblocking services
SERPRetrieve search engine results pages from Google, Bing, and others

​
Prerequisites

Before you begin, ensure you have:
  • A valid Bright Data account
  • An API token generated from the Bright Data Control Panel with permissions for the services you intend to use

​
Connect your Bright Data account

1

Open the Connection configuration

In your Boomi process, add a new Bright Data Partner connector component and navigate to the Connection tab.
2

Set the Base URL

Enter the Bright Data API base URL:
https://api.brightdata.com
Customize this value only if you need to point to a different endpoint, such as for testing or regional deployments.
3

Enter your API Token

Paste your Bright Data API token into the API Token field. The connector uses this token for Bearer authentication.
4

Test the connection

Click Test Connection to verify your settings. If the test succeeds, save the connection. If it fails, review your Base URL and API token, then test again.

​
Configure an operation

Each operation defines how the connector interacts with a specific Bright Data object. Create a separate operation component for each action/object combination your integration requires. All object types use the Execute action.

​
Options tab fields

FieldDescription
Connector actionSet to Execute for all Bright Data operations
ObjectImport using the Import button. Choose Dataset, Scraper, Unlocker, or SERP
Request profileA flexible XML/XSD schema that accepts dynamic content structures
Response profileA JSON profile returned by the connector
Tracking directionSelect Input Documents or Output Documents
Error behaviorEnable to handle failed operations in your process rather than only reporting them
Request PayloadOptional document-level override for the request. Accepts JSON, URL query style, or newline-separated key=value pairs

​
Object-specific behavior

​
Dataset

The connector operates in one of two modes depending on whether a snapshot_id is present:
  • Mode A (Filter): No snapshot_id provided. Filters marketplace datasets based on your query parameters.
  • Mode B (Snapshot): A snapshot_id starting with snap_ is provided. The connector polls every 10 seconds, up to 25 retries, until the snapshot is ready.
{
  "dataset_id": "gd_l1viktl72bvl7bjuj0",
  "filter": {
    "name": "name",
    "operator": "=",
    "value": "Kyle Lacy"
  }
}

​
Scraper

  • Mode A (Trigger): No snapshot_id provided. Submits a new scraping job and returns a snapshot_id.
  • Mode B (Snapshot): A snapshot_id starting with s_ is provided. The connector polls for completion and downloads results.
{
  "dataset_id": "gd_l1viktl72bvl7bjuj0",
  "url": "https://www.linkedin.com/in/kylelacy",
  "discover_by": "profile_url"
}

​
Unlocker

Requires a url parameter to bypass website restrictions. Supports method, country, and body parameters. 
{
  "zone": "web_unlocker1",
  "url": "https://geo.brdtest.com/welcome.txt",
  "format": "json",
  "method": "GET",
  "country": "us",
  "data_format": "markdown"
}

​
SERP

Requires engine and query parameters. Supports multiple engines in a single request using a comma-separated list. 
{
  "zone": "serp_api1",
  "url": "https://www.google.com/search?q=BrightData",
  "format": "json",
  "method": "GET",
  "country": "us",
  "data_format": "markdown"
}
The connector returns all data in JSON format. If the underlying API returns non-JSON content such as HTML or CSV, the connector wraps the raw content in a JSON structure for consistent processing in Boomi.

​
Release notes

Version 1.0.0 Initial release. Supports Dataset, Scraper, Unlocker, and SERP object types via the Execute action.