Bright Data icon

Bright Data

Web scraping, data collection, and proxy infrastructure for accessing blocked websites and curated marketplace datasets.

1 trigger29 searches21 actionsInstant (webhooks)Auth: API key

AI-assisted documentation10 min read

This documentation is compiled from our integration source code, internal specs for Bright Data, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Bright Data on WEXTL →

Bright Data requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]

  • API KeypasswordRequired

    Your API key. Generate one at https://brightdata.com/cp/setting/users (Account Settings → Add API key). Shown only once at creation — save it in a secure store.

    [1]
  1. Log in to your WEXTL account, add the Bright Data node module to your workflow, and click Create new credential.
    Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Bright Data account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch Collection CompletionTrigger

No fields documented.

Download Marketplace SnapshotSearch
Input fields[3]
FieldType
Snapshot IDRequired
text
Formatchoice
Compressboolean
Batch Sizenumber
Partnumber
Download SnapshotSearch
Input fields[3]
FieldType
SnapshotRequired
choice
Formatchoice
Compressboolean
Batch Sizenumber
Partnumber
Get Customer BalanceSearch
Output fields[3]
FieldType
Balancenumber
Get Dataset MetadataSearch
Input fields[3]
FieldType
DatasetRequired
choice
Output fields[3]
FieldType
Dataset IDtext
Fieldsobject
Get Delivery Destination SchemaSearch
Input fields[3]
FieldType
Destination TypeRequired
choice
Get Marketplace Snapshot MetadataSearch
Input fields[3]
FieldType
Snapshot IDRequired
text
Output fields[3]
FieldType
Statustext
Dataset Size (records)number
File Size (bytes)number
Get Marketplace Snapshot PartsSearch
Input fields[3]
FieldType
Snapshot IDRequired
text
Output fields[3]
FieldType
Partsnumber
Get Snapshot InputSearch
Input fields[3]
FieldType
SnapshotRequired
choice
Output fields[3]
FieldType
URLurl
Get Snapshot LogSearch
Input fields[3]
FieldType
SnapshotRequired
choice
Get Snapshot PartsSearch
Input fields[3]
FieldType
SnapshotRequired
choice
Output fields[3]
FieldType
Partsnumber
Get Studio DatasetSearch
Input fields[3]
FieldType
Collection IDRequired
text
Output fields[3]
FieldType
Statustext
Messagetext
Get Studio Job ErrorsSearch
Input fields[3]
FieldType
Job IDRequired
text
Skip Normalizeboolean
Limitnumber
Output fields[3]
FieldType
Input URLurl
Error Codetext
Error Messagetext
Get Studio Job LogSearch
Input fields[3]
FieldType
Job IDRequired
text
Output fields[3]
FieldType
Job IDtext
Statustext
Scraper IDtext
Templatetext
Inputsnumber
Duplicate Inputsnumber
Output Linesnumber
Failsnumber
Pagesnumber
Pages Leftnumber
Successnumber
Navigationsnumber
Createddate
Starteddate
Finisheddate
Triggered Bytext
Success Ratenumber
Job Time (ms)number
Queue Time (ms)number
Get Studio Job ResultSearch
Input fields[3]
FieldType
Response IDRequired
text
Timeoutnumber
Get View Delivery SettingsSearch
Input fields[3]
FieldType
ViewRequired
choice
Output fields[3]
FieldType
Delivery Destinationobject
Filenameobject
Bundle as TARboolean
Gzip Each Fileboolean
Batch Sizenumber
Get Zone ConfigSearch
Input fields[3]
FieldType
ZoneRequired
choice
Output fields[3]
FieldType
Nametext
Typetext
List Active ZonesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Nametext
Typetext
List All ZonesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Nametext
Typetext
List CountriesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Codetext
Nametext
List Delivery Destination TypesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Valuetext
Labeltext
List Marketplace DatasetsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Dataset IDtext
Nametext
Size (records)number
List ScrapersSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Domaintext
List SnapshotsSearch
Input fields[3]
FieldType
Datasetchoice
Statuschoice
Fromdate
Todate
Skipnumber
Limitnumber
Output fields[3]
FieldType
Snapshot IDtext
Dataset IDtext
Statustext
Createddate
List Studio JobsSearch
Input fields[3]
FieldType
From DateRequired
date
To DateRequired
date
Scraperchoice
Offsetnumber
Sortchoice
Limitnumber
Output fields[3]
FieldType
Job IDtext
Statustext
Scraper IDtext
Inputsnumber
Data Linesnumber
Failed Pagesnumber
Createddate
Starteddate
Finisheddate
List Studio ScrapersSearch
Input fields[3]
FieldType
Searchtext
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Activeboolean
Last Rundate
Deliverobject
Typetext
Output Schemaobject
Typetext
List ViewsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
View IDtext
Nametext
Dataset IDtext
Monitor DeliverySearch
Input fields[3]
FieldType
Delivery IDRequired
text
Output fields[3]
FieldType
Statustext
Monitor Job ProgressSearch
Input fields[3]
FieldType
SnapshotRequired
choice
Output fields[3]
FieldType
Statustext
Snapshot IDtext
Dataset IDtext
Recordsnumber
Errorsnumber
Collection Durationnumber
Search Marketplace DatasetAction
Input fields[3]
FieldType
DatasetRequired
choice
FilterRequired
object
Field Nametext
Operatorchoice
Valuetext
AND Conditionsarray
OR Conditionsarray
Combine Nested Fieldsboolean
Sizenumber
Sorttext
Search After Cursortext
Output fields[3]
FieldType
Hitsarray
Total Hitsnumber
Took (ms)number
Search After Cursorarray
Add ZoneAction
Input fields[3]
FieldType
Zone NameRequired
text
PlanRequired
object
Plan TypeRequired
choice
SERPboolean
Mobileboolean
Countrychoice
Disable CAPTCHA Solvingboolean
Allow Custom Headersboolean
Enable City Targetingboolean
Enable ASN Targetingboolean
Allocate gIPboolean
gIP Countnumber
Zone Type (label)text
Output fields[3]
FieldType
Zone Nametext
Zone Typetext
Cancel SnapshotAction
Input fields[3]
FieldType
SnapshotRequired
choice
Output fields[3]
FieldType
Resulttext
Cancel Studio JobAction
Input fields[3]
FieldType
Job IDRequired
text
Output fields[3]
FieldType
Resulttext
Crawl (Studio)Action
Input fields[3]
FieldType
ScraperRequired
choice
InputRequired
object
URLurl
Timeout (seconds)number
Output fields[3]
FieldType
Statustext
Response IDtext
Delete ZoneAction
Input fields[3]
FieldType
ZoneRequired
choice
Deliver Marketplace SnapshotAction
Input fields[3]
FieldType
Snapshot IDRequired
text
Delivery ConfigurationRequired
object
DestinationRequired
choice
Filenameobject
Buckettext
Regiontext
Pathtext
Containertext
Endpointurl
Auth Headersecret
Compress Payloadboolean
Toarray
Output fields[3]
FieldType
Delivery IDtext
Deliver SnapshotAction
Input fields[3]
FieldType
SnapshotRequired
choice
Delivery ConfigurationRequired
object
DestinationRequired
choice
Filename Templatetext
Filename Extensiontext
Amazon S3 Configobject
Google Cloud Storage Configobject
Azure Blob Storage Configobject
Alibaba Cloud OSS Configobject
SFTP Configobject
Webhook Configobject
Email Configobject
Output fields[3]
FieldType
Delivery IDtext
Filter Marketplace DatasetAction
Input fields[3]
FieldType
DatasetRequired
choice
Records Limitnumber
FilterRequired
object
Field Nametext
Operatorchoice
Valuetext
AND Conditionsarray
OR Conditionsarray
Combine Nested Fieldsboolean
Output fields[3]
FieldType
Snapshot IDtext
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Pause SnapshotAction
Input fields[3]
FieldType
SnapshotRequired
choice
Output fields[3]
FieldType
Resulttext
Pause Studio JobAction
Input fields[3]
FieldType
Job IDRequired
text
Output fields[3]
FieldType
Resulttext
Rerun SnapshotAction
Input fields[3]
FieldType
SnapshotRequired
choice
Output fields[3]
FieldType
New Snapshot IDtext
Rerun Studio JobAction
Input fields[3]
FieldType
Job IDRequired
text
Failed Inputs Onlyboolean
Output fields[3]
FieldType
New Collection IDtext
Start ETAdate
Resume SnapshotAction
Input fields[3]
FieldType
SnapshotRequired
choice
Output fields[3]
FieldType
Resulttext
Scrape URL (Sync)Action
Input fields[3]
FieldType
DatasetRequired
choice
InputRequired
array
Custom Output Fieldstext
Include Errorsboolean
Formatchoice
Output fields[3]
FieldType
Statustext
Snapshot IDtext
Messagetext
Send SERP SearchAction
Input fields[3]
FieldType
ZoneRequired
choice
URLRequired
url
FormatRequired
choice
Methodtext
Countrychoice
Data Formatchoice
Output fields[3]
FieldType
Generalobject
Search Enginetext
Querytext
Results Countnumber
Search Timenumber
Languagetext
Locationtext
Mobileboolean
Inputobject
Original URLurl
Organic Resultsarray
Send Web RequestAction
Input fields[3]
FieldType
ZoneRequired
choice
URLRequired
url
FormatRequired
choice
Methodtext
Countrychoice
Data Formatchoice
Render with Browserboolean
Debugboolean
Output fields[3]
FieldType
Status Codenumber
Headersobject
Bodytext
Trigger Collection (Async)Action
Input fields[3]
FieldType
DatasetRequired
choice
InputRequired
array
Custom Output Fieldstext
Discovery Typechoice
Discover Bychoice
Include Errorsboolean
Limit Per Inputnumber
Limit Multiple Resultsnumber
Notifyboolean
Webhook Endpointurl
Formatchoice
Webhook Auth Headersecret
Uncompressed Webhookboolean
Output fields[3]
FieldType
Snapshot IDtext
Trigger Studio Scraper (Batch)Action
Input fields[3]
FieldType
ScraperRequired
choice
InputRequired
array
Queue Nextboolean
Notify on Completionobject
Typechoice
Endpointurl
Output fields[3]
FieldType
Collection IDtext
Start ETAdate
Trigger Studio Scraper (Real-time)Action
Input fields[3]
FieldType
ScraperRequired
choice
InputRequired
object
URLurl
Output fields[3]
FieldType
Response IDtext
Update View Delivery SettingsAction
Input fields[3]
FieldType
ViewRequired
choice
Delivery ConfigurationRequired
object
DestinationRequired
choice
Buckettext
Regiontext
Pathtext
Containertext
Endpointurl
Auth Headersecret
Compress Payloadboolean
Toarray
Credentialsobject
Filenameobject
Templatetext
Extensiontext
Bundle as TARboolean
Gzip Each Fileboolean
Batch Sizenumber
Output fields[3]
FieldType
View IDtext

Look for Bright Data templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Bright Data Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Bright Data.
  4. WEXTL® visual workflow builder data.

Last updated: Sep 5, 2026 10:00