Bloomreach icon

Bloomreach

Ecommerce customer data and personalization platform for experiences, content, and engagement.

1 trigger12 searches8 actionsInstant (webhooks)Auth: API key

AI-assisted documentation9 min read

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

Open Bloomreach on WEXTL →

To use Bloomreach on WEXTL you need an active account and an API access token from your account settings.[3]

  • EnvironmentselectRequired
  • API KeypasswordRequired

    You can create API Key via Setup > Discovery API keys > Add new API key button

    [1]
  1. Log in to your WEXTL account, add the Bloomreach 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 Bloomreach 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 →
Connecting Bloomreach to WEXTL®
Video slide demonstrates how to integrate Bloomreach in the WEXTL visual workflow builder.[4]

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 EventsTrigger

No fields documented.

Auto SuggestSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Attribute suggestionsarray
Catalog nametext
Product suggest querytext
Query suggestionsarray
Search suggestionsarray
Viewtext
Create a Keyword-based WidgetSearch
Input fields[3]
FieldType
Widget IDRequired
text
Account IDRequired
number
Bloomreach UIDRequired
text
Domain KeyRequired
text
Search QueryRequired
text
Request IDRequired
text
Request URLRequired
url
Referrer URLurl
Fieldsarray
Filtertext
Enable Facetsboolean
Filter Facettext
View IDtext
User IDtext
Limitnumber
Output fields[3]
FieldType
Pidtext
Create a Personalized WidgetSearch
Input fields[3]
FieldType
Widget IDRequired
text
Account IDRequired
number
_br_uid_2Required
text
Domain KeyRequired
text
QueryRequired
text
User IDRequired
text
Request IDRequired
text
URLRequired
url
Ref URLurl
Fieldstext
Filtertext
View IDtext
Limitnumber
Output fields[3]
FieldType
Pidtext
Create an Item-Based WidgetSearch
Input fields[3]
FieldType
Widget IDRequired
text
Account IDRequired
number
_br_uid_2Required
text
Domain KeyRequired
text
Item IDsRequired
text
Request IDRequired
text
URLRequired
text
Referrer URLtext
Fieldstext
Filtertext
View IDtext
Context PIDstext
User IDtext
Limitnumber
Output fields[3]
FieldType
Pidtext
Get a Category Based WidgetSearch
Input fields[3]
FieldType
Widget IDRequired
text
Account IDRequired
number
BR UID 2Required
text
Domain KeyRequired
text
Category IDRequired
text
Request IDRequired
text
URLRequired
url
Referrer URLurl
View IDtext
Fieldstext
Filtertext
Facetboolean
Filter Facettext
Startnumber
Rowsnumber
User IDtext
Limitnumber
Output fields[3]
FieldType
Pidtext
Get a Global WidgetSearch
Input fields[3]
FieldType
Widget IDRequired
text
Account IDRequired
number
Bloomreach UIDRequired
text
Domain KeyRequired
text
Request IDRequired
text
URLRequired
url
Referer URLurl
Fieldstext
Filtertext
Rowsnumber
View IDtext
Limitnumber
Output fields[3]
FieldType
Pidtext
Get ChannelsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Branchtext
Branch oftext
Project nametext
Content root pathtext
Localetext
Devicesarray
Default devicetext
Response headerstext
Linkurl prefixtext
Cdn hosttext
Remote host protectionboolean
Update component content on page syncboolean
Parametersobject
Graphql baseurltext
Graphql tenant nametext
Sm domain keytext
Sm account IDtext
Sm endpointtext
Spa URLtext
Get Documents by ID or PathAction
Input fields[3]
FieldType
User IDRequired
number
Output fields[3]
FieldType
IDtext
Pathtext
Nametext
Localetext
Namespacetext
Content typetext
Last modifieddate
Linksobject
Selfobject
Fieldsobject
Contentobject
Datenumber
Introductiontext
Imageobject
Titletext
Get Documents by QuerySearch
Input fields[3]
FieldType
Namespacetext
Content Typetext
IDtext
Pathtext
Querytext
Query on Titletext
Localetext
Last Modifieddate
Foldertext
Last Modified Greater Thandate
Last Modified Less Thandate
Last Modified Less Than or Equal todate
Last Modified Greater Than or Equal todate
Limitnumber
Output fields[3]
FieldType
IDtext
Pathtext
Nametext
Localetext
Namespacetext
Content typetext
Last modifieddate
Linksobject
Selfobject
Fieldsobject
Contentobject
Datenumber
Introductiontext
Imageobject
Titletext
Get Products by CategorySearch
Input fields[3]
FieldType
Account IDRequired
text
Auth KeyRequired
text
Domain KeyRequired
text
Request IDRequired
text
BR UID 2Required
text
Referral URLurl
URLurl
Field Listarray
Querytext
Limitnumber
Output fields[3]
FieldType
Sale pricenumber
Pricenumber
Descriptiontext
Titletext
URLtext
Brandtext
Pidtext
Thumb imagetext
Sale price rangearray
Price rangearray
Variantsarray
Promotionsarray
Scorenumber
Get Products by KeywordSearch
Input fields[3]
FieldType
Account IDRequired
text
Auth KeyRequired
text
Domain KeyRequired
text
Request IDRequired
text
BR UID 2Required
text
Referral URLurl
URLurl
Field Listarray
Querytext
Limitnumber
Output fields[3]
FieldType
Sale pricenumber
Pricenumber
Descriptiontext
Titletext
URLtext
Brandtext
Pidtext
Thumb imagetext
Sale price rangearray
Price rangearray
Variantsarray
Promotionsarray
Scorenumber
Search VisualsSearch
Input fields[3]
FieldType
Widget IDRequired
text
Account IDRequired
number
BR UID 2Required
text
Domain KeyRequired
text
URLRequired
url
Image IDtext
Item IDstext
Limitnumber
Output fields[3]
FieldType
Brandtext
Skuidtext
Pidtext
Thumb imagetext
Variantsarray
Pricenumber
Create a Channel Developer BranchAction
Input fields[3]
FieldType
Branch OfRequired
text
BranchRequired
text
Delete a ChannelAction
Input fields[3]
FieldType
Channel IDRequired
choice
Export a CustomerAction
Input fields[3]
FieldType
Project TokenRequired
text
Customer IDsobject
Registered IDtext
Output fields[3]
FieldType
Successboolean
Idsobject
Cookiearray
Registeredarray
Propertiesobject
First nametext
Last nametext
Emailtext
Eventsarray
Export CustomersAction
Input fields[3]
FieldType
Project TokenRequired
text
FormatRequired
choice
Attributesobject
Typechoice
Listarray
Filterobject
Typechoice
Segmentation IDtext
Segment Indexnumber
Execution Timenumber
Timezonetime
Output fields[3]
FieldType
Attributesobject
Typetext
Listarray
Filterobject
Typetext
Segmentation IDtext
Segment indexnumber
Execution timenumber
Timezonetext
Formattext
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
Send a Transactional EmailAction
Input fields[3]
FieldType
Project TokenRequired
text
Email ContentRequired
object
Template IDtext
HTMLtext
Subjecttext
Sender Addressemail
Sender Nametext
Attachmentsobject
Campaign NameRequired
text
RecipientRequired
object
Customer IDstext
Emailemail
Languagetext
Integration IDtext
Integrationsarray
Transfer Identitychoice
Settingsobject
Custom Event Propertiestext
Custom Headerstext
URL Paramstext
Transfer User Identitychoice
Consent Categorytext
Consent Category Trackingtext
Send a Transactional SMSAction
Input fields[3]
FieldType
Project TokenRequired
text
ContentRequired
object
Template IDtext
Parametersobject
Messagetext
Sendertext
Max Message Partsnumber
Campaign NameRequired
text
RecipientRequired
object
Customer IDsRequired
text
Phonetext
Languagetext
Integration IDtext
Settingsobject
Update a ChannelAction
Input fields[3]
FieldType
Channel IDRequired
choice
NameRequired
text
Content Root PathRequired
text
IDtext
Branchtext
Branch Oftext
External Preview Enabledboolean
External Preview Tokentext
Update Component Content On Page Syncboolean
Icontext
Localetext
Devicesarray
Default Devicetext
Response Headersarray
Link URL Prefixtext
CDN Hosttext
Remote Host Protectionboolean

Look for Bloomreach templates in the WEXTL template library.

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

Last updated: Jul 23, 2026 22:38