Skip to docs navigation

VBOUT integration guide

Verified

How to connect VBOUT to WEXTL and use its 82 actions in your workflows. About VBOUT: Email marketing, contacts, social posts, website goals and ecommerce tracking for your marketing team.

  • 33 searches
  • 49 actions
  • Polling
  • Auth: API key

AI-assisted documentation18 min read

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

Open VBOUT on WEXTL →
  • VBOUT
  • WEXTL
  • Bouncer
  • Ahrefs
  • Buk Capacitaciones
  • Action Network
  • Clipdrop
  • Bitly
  • Bumpups
  • Brandfetch
  • APITemplate.io
  • Bannerbear
  • Claid AI
  • Castmagic
  • ActiveCampaign
  • ActiveTrail
  • Birdeye
  • Bloomreach
  • Beamer
  • Cardly
  • Ablefy
  • Basin
  • CertSeal
  • Captions
  • Auphonic
  • Campaign Monitor
  • Clearout
  • Akeneo
  • AWeber
  • Brandwatch
  • beehiiv
  • Bettermode
  • API KeypasswordRequired

    In VBOUT open Settings, then the API area, and copy your user key. An application key made through VBOUT Connect also works but may reach less of your account.[1]

  1. Log in to your WEXTL account, add the VBOUT node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your VBOUT 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 →

Get a Contact

SearchOne email contact record with its signup date.
Input fields[3]
FieldType
Contact IDRequired
text
Output fields[3]
FieldType
IDtext
Emailtext
Statustext
Registration Datetext

Get a Contact by Email

SearchContact lookup using only an address.
Input fields[3]
FieldType
EmailRequired
text
Listchoice
Output fields[3]
FieldType
IDtext
Emailtext
Statustext
Registration Datetext

Get a Contact Timeline

SearchEverything a contact has done, in order.
Input fields[3]
FieldType
Contact IDRequired
text
Includechoice
Output fields[3]
FieldType
IDnumber
Emailtext
Timelineobject
Dataarray
Countnumber
Totalnumber
Utmobject
Dataarray
Countnumber
Automatedobject
Dataarray
Countnumber

Get a Contact Timeline by Email

SearchContact history when you know only the address.
Input fields[3]
FieldType
EmailRequired
text
Includechoice
Output fields[3]
FieldType
IDnumber
Emailtext
Timelineobject
Dataarray
Countnumber
Totalnumber
Utmobject
Dataarray
Countnumber
Automatedobject
Dataarray
Countnumber

Get a Coupon

SearchCoupons issued to a single recipient.
Input fields[3]
FieldType
EmailRequired
text
LimitRequired
number
Campaign IDtext
Output fields[3]
FieldType
IDtext
Emailtext
Couponcodetext
Couponredeemedtext
Couponredeemedontext

Get a Goal

SearchSetup of one conversion goal.
Input fields[3]
FieldType
GoalRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Goal Valueobject
Typetext
Valuetext
Typetext
Event Typetext
Event Link Ruletext
Linksarray
Has Actiontext
Actionobject
IDtext
Nametext

Get a List

SearchSettings and sender of a single list.
Input fields[3]
FieldType
ListRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Form Titletext
Email Subjecttext
Reply Totext
From Emailtext
From Nametext
Confimation Emailtext
Success Emailtext
Confimation Messagetext
Success Messagetext
Error Messagetext
Double Optintext
Notify Emailtext
Creation Datetext

1other output field

Get a Popup

SearchEvery setting of a single popup, from triggers to actions.
Input fields[3]
FieldType
PopupRequired
choice

Get a Social Post

SearchDetails and schedule of one social post.
Input fields[3]
FieldType
Post IDRequired
text
ChannelRequired
choice
Output fields[3]
FieldType
IDtext
Titletext
Datetimetext
Itemobject
Uidtext
Typetext
Imagetext
Profiletext

Get a Sub-Account Auto Login

SearchSingle sign-in link into a client account.
Input fields[3]
FieldType
Sub-Account IDRequired
text
Expires After (Seconds)number
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Login URLtext

Get an Email Campaign

SearchContent and sender of one campaign.
Input fields[3]
FieldType
Campaign IDRequired
text
Typechoice
Output fields[3]
FieldType
IDtext
Subjecttext
Messagetext
Replytotext
From Emailtext
From Nametext
Creation Datetext

Get Email Campaign Stats

SearchResults of one sent campaign.
Input fields[3]
FieldType
Campaign IDRequired
text
Typechoice
Output fields[3]
FieldType
Statsobject
Opentext
Unopenedtext
Bouncedtext
Unsubscribedtext
Clicksarray
Itemobject

Get Social Stats

SearchPerformance of your social accounts.
Input fields[3]
FieldType
LimitRequired
number
Channelschoice
Sortchoice
Output fields[3]
FieldType
IDtext
Titletext

Get the Business Info

SearchAccount profile of the signed-in business.
Output fields[3]
FieldType
Businessnametext
Contactnametext
Phone Numbertext
Vbout Nametext
Packagetext

List Audiences

SearchAudiences available for email sending.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext

List Contacts

SearchPeople subscribed to one list.
Input fields[3]
FieldType
ListRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Emailtext
Statustext
Registration Datetext

List Contacts by Phone Number

SearchSubscribers matched through phone numbers.
Input fields[3]
FieldType
ListRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Emailtext
Statustext
Registration Datetext

List Custom Short Codes

SearchYour saved email snippets.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Titletext
Contenttext

List Domains

SearchWebsites connected for tracking.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Domaintext

List Email Campaigns

SearchCampaigns grouped by their state.
Input fields[3]
FieldType
StatusRequired
choice
LimitRequired
number
Fromdate
Todate
Output fields[3]
FieldType
Statustext
IDtext
Subjecttext
Messagetext
Replytotext
From Emailtext
From Nametext
Creation Datetext

List Email Templates

SearchDesigns ready for new campaigns.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Preview Linktext

List Forms

SearchYour VBOUT signup forms.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext

List Goals

SearchAll goals across your domains.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Goal Valueobject
Typetext
Valuetext
Typetext
Event Typetext
Event Link Ruletext
Linksarray
Has Actiontext
Actionobject
IDtext
Nametext

List Goals by Domain

SearchGoals that belong to a single website.
Input fields[3]
FieldType
DomainRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Goal Valueobject
Typetext
Valuetext
Typetext
Event Typetext
Event Link Ruletext
Linksarray
Has Actiontext
Actionobject
IDtext
Nametext

List Lists

SearchEvery email list in the account.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Form Titletext
Email Subjecttext
Reply Totext
From Emailtext
From Nametext
Confimation Emailtext
Success Emailtext
Confimation Messagetext
Success Messagetext
Error Messagetext
Double Optintext
Notify Emailtext
Creation Datetext

List Managers

SearchPeople who manage the account.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Full Nametext
Emailtext
Statustext

List Pipeline Board Guide Categories

SearchGroups of ready-made pipeline board guides.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Ordernumber
Statustext

List Pipeline Board Guides

SearchTemplates for starting new pipeline boards.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Categorytext
Statustext

List Popups

SearchPopups configured for your sites.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Typetext
Domain IDtext
URLtext
Action Typetext
Action Rulestext
Action Styletext

List Social Calendar Posts

SearchScheduled and past social posts in a date range.
Input fields[3]
FieldType
FromRequired
date
ToRequired
date
LimitRequired
number
Channelschoice
Include Postedboolean
Sortchoice
Output fields[3]
FieldType
Grouptext
IDtext
Titletext
Datetext

List Social Channels

SearchNetworks linked to your account.
Output fields[3]
FieldType
Channelsobject
Facebookobject
Twitterobject
Linkedinobject

List User Groups

SearchGroups that organize your VBOUT users.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Statustext

List Users

SearchEveryone with a login to the account.
Input fields[3]
FieldType
LimitRequired
number
Sub-Account IDtext
Output fields[3]
FieldType
IDtext
Full Nametext
Emailtext
Statustext

Add a Cart Item

ActionRecords one product line on a shopper cart.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Cart IDRequired
text
Product IDRequired
text
NameRequired
text
PriceRequired
number
QuantityRequired
number
Customer Emailtext
Unique IDtext
IP Addresstext
Descriptiontext
Variationarray
Variationobject
Discount Pricenumber
Currencytext
SKUtext
Category IDtext

7other input fields

Add a Contact

ActionNew email marketing contact on a list.
Input fields[3]
FieldType
ListRequired
choice
StatusRequired
choice
Emailtext
IP Addresstext
Custom Fieldsarray
Fieldobject

Add a Contact Activity

ActionCustom timeline entry for one contact.
Input fields[3]
FieldType
Contact IDRequired
text
DescriptionRequired
text
Date and TimeRequired
date

Add a Contact Tag

ActionAttaches tags to an email contact.
Input fields[3]
FieldType
EmailRequired
text
TagsRequired
text
Contact IDtext

Add a Custom Short Code

ActionReusable text snippet for emails.
Input fields[3]
FieldType
NameRequired
text
TitleRequired
text
ContentRequired
text

Add a Goal

ActionConversion goal measured on one of your domains.
Input fields[3]
FieldType
DomainRequired
choice
NameRequired
text
TypeRequired
choice
Value Typechoice
Valuetext
Destination URLtext
Duration Hoursnumber
Duration Minutesnumber
Duration Secondsnumber
Pagesnumber
Referral Networkchoice
Event Typechoice
Goal Is Met Ifchoice
Event Linkstext
Event Videostext

2other input fields

Add a List

ActionFresh list for collecting contacts.
Input fields[3]
FieldType
NameRequired
text
Confirmation Email Subjecttext
Reply Totext
From Emailtext
From Nametext
Double Opt-Inboolean
Notifyboolean
Notification Emailtext
Success Emailtext
Success Messagetext
Error Messagetext
Confirmation Emailtext
Confirmation Messagetext
Turn Off Communicationsboolean

Add a Popup

ActionNew on-site popup with targeting options.
Input fields[3]
FieldType
NameRequired
text
TypeRequired
choice
Domainchoice
Action URLtext
Action Typechoice
Redirection URLtext
Listchoice
Poll Questiontext
Poll Choicesarray
Valuetext
JavaScripttext
Start Datedate
End Datedate
Target Userschoice
Deviceschoice
Referral Networkchoice

7other input fields

Add a Social Post

ActionPublishes or schedules a post on a social profile.
Input fields[3]
FieldType
MessageRequired
text
ChannelRequired
choice
ProfileRequired
choice
Photo URLtext
Scheduleboolean
Scheduled Datedate
Scheduled Timetext
AM or PMchoice
Trackable Linksboolean

Add a User

ActionAdds a login to your VBOUT account.
Input fields[3]
FieldType
Full NameRequired
text
EmailRequired
text
PasswordRequired
secret
TypeRequired
choice
User Groupchoice
Permissionstext

Add an Email Campaign

ActionBuilds a VBOUT email campaign, draft or scheduled.
Input fields[3]
FieldType
NameRequired
text
SubjectRequired
text
From EmailRequired
text
From NameRequired
text
Reply ToRequired
text
BodyRequired
text
Typechoice
Save as Draftboolean
Scheduleboolean
Scheduled Atdate
Audienceschoice
Listschoice

Create a Cart

ActionStarts tracking a shopper cart.
Input fields[3]
FieldType
Customer EmailRequired
text
Cart IDRequired
text
Store Domain Keytext
Unique IDtext
IP Addresstext
Currencytext
Store Nametext
Abandoned Cart URLtext
Customer Infoobject
Firstnametext
Lastnametext
Phonetext
Companytext
Countrytext

Create a Pipeline Board from a Guide

ActionBoard built from a template guide.
Input fields[3]
FieldType
GuideRequired
choice
TitleRequired
text
Output fields[3]
FieldType
Itemtext
Record IDtext

Create an Account

ActionSets up a client account on your agency plan.
Input fields[3]
FieldType
Contact NameRequired
text
Business NameRequired
text
Business EmailRequired
text
Business PhoneRequired
text
VBOUT NameRequired
text
Plan IDRequired
number
Passwordsecret
VAT Numbertext
Time Zonetext
Commission Structurechoice
Disable Billing Accessboolean
Disable Settings Accessboolean
Charge on Sign-Upboolean

Create an Order

ActionRegisters a store order in VBOUT.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Cart IDRequired
text
Order IDRequired
text
Payment MethodRequired
text
Grand TotalRequired
number
Customer InfoRequired
object
Firstnametext
Lastnametext
Emailtext
Phonetext
Companytext
Countrytext
Unique IDtext
IP Addresstext
Order Numbertext
Order Datedate
Shipping Methodtext
Shipping Costnumber
Store Nametext
Subtotalnumber
Promo Codetext

12other input fields

Create an Order Transaction

ActionPayment entry attached to an order.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Order IDRequired
text
Payment IDRequired
text
StatusRequired
text
AmountRequired
number
CurrencyRequired
text
GatewayRequired
text
Payment DetailsRequired
object
Credit Card Companytext
Credit Card Numbertext
Credit Card Nametext
Messagetext
Product IDtext
Timedate

Delete a Contact

ActionGets one person off a list.
Input fields[3]
FieldType
Contact IDRequired
text
ListRequired
choice

Delete a Custom Short Code

ActionDeletes a saved email snippet.
Input fields[3]
FieldType
Short Code IDRequired
text

Delete a Goal

ActionStops tracking a conversion goal.
Input fields[3]
FieldType
GoalRequired
choice

Delete a List

ActionEmail list gone, contacts included.
Input fields[3]
FieldType
ListRequired
choice

Delete a Popup

ActionDeletes an on-site message box.
Input fields[3]
FieldType
PopupRequired
choice

Delete a Social Post

ActionRetracts one published post from a network.
Input fields[3]
FieldType
Post IDRequired
text
ChannelRequired
choice

Delete a User

ActionDeletes a login from the account.
Input fields[3]
FieldType
User IDRequired
text
TypeRequired
choice

Delete a User Group

ActionRemoves a team group.
Input fields[3]
FieldType
User GroupRequired
choice

Delete an Email Campaign

ActionCampaign deletion in VBOUT.
Input fields[3]
FieldType
Campaign IDRequired
text
Typechoice

Edit a Contact

ActionUpdates details of an email contact.
Input fields[3]
FieldType
Contact IDRequired
text
Emailtext
IP Addresstext
Statuschoice
Custom Fieldsarray
Fieldobject
Clear Fieldschoice

Edit a Custom Short Code

ActionRewrites a saved email snippet.
Input fields[3]
FieldType
Short Code IDRequired
text
NameRequired
text
TitleRequired
text
ContentRequired
text

Edit a Goal

ActionAdjusts how a conversion goal is measured.
Input fields[3]
FieldType
GoalRequired
choice
NameRequired
text
TypeRequired
choice
Value Typechoice
Valuetext
Destination URLtext
Duration Hoursnumber
Duration Minutesnumber
Duration Secondsnumber
Pagesnumber
Referral Networkchoice
Event Typechoice
Goal Is Met Ifchoice
Event Linkstext
Event Videostext

2other input fields

Edit a List

ActionChanges settings of an email list.
Input fields[3]
FieldType
ListRequired
choice
NameRequired
text
Confirmation Email Subjecttext
Reply Totext
From Emailtext
From Nametext
Double Opt-Inchoice
Notifychoice
Notification Emailtext
Success Emailtext
Success Messagetext
Error Messagetext
Confirmation Emailtext
Confirmation Messagetext
Turn Off Communicationschoice

1other input field

Edit a Popup

ActionAdjusts a popup and who sees it.
Input fields[3]
FieldType
PopupRequired
choice
NameRequired
text
TypeRequired
choice
Action URLtext
Action Typechoice
Redirection URLtext
Listchoice
Poll Questiontext
Poll Choicesarray
Valuetext
JavaScripttext
Start Datedate
End Datedate
Target Userschoice
Deviceschoice
Referral Networkchoice

7other input fields

Edit a Social Post

ActionRevises a social post text or time.
Input fields[3]
FieldType
Post IDRequired
text
ChannelRequired
choice
Messagetext
Scheduled Atdate

Edit a User

ActionChanges the profile of a team member.
Input fields[3]
FieldType
User IDRequired
text
Full NameRequired
text
EmailRequired
text
Passwordsecret
Typechoice
User Groupchoice
Permissionstext

Edit an Email Campaign

ActionRewrites the content and recipients of a campaign.
Input fields[3]
FieldType
Campaign IDRequired
text
NameRequired
text
SubjectRequired
text
From EmailRequired
text
From NameRequired
text
Reply ToRequired
text
BodyRequired
text
Typechoice
Draftchoice
Scheduledchoice
Scheduled Atdate
Audienceschoice
Listschoice

Empty a Cart

ActionRemoves all products from one cart.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Cart IDRequired
text

Make an API Call

universalDirect VBOUT REST API access for uncovered endpoints.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Keytext
Valuetext
Status codenumber

Move a Contact

ActionRelocates one contact between lists.
Input fields[3]
FieldType
Contact IDRequired
text
From ListRequired
choice
To ListRequired
choice

Remove a Cart

ActionDeletes a cart from ecommerce tracking.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Cart IDRequired
text

Remove a Cart Item

ActionClears a product line from a cart.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Cart IDRequired
text
Product IDRequired
text
Variationarray
Variationobject

Remove a Contact Tag

ActionUnlabels a contact by tag name.
Input fields[3]
FieldType
EmailRequired
text
TagsRequired
text
Contact IDtext

Set a User Group Status

ActionActivates or deactivates a team group.
Input fields[3]
FieldType
User GroupRequired
choice
StatusRequired
choice

Set a User Status

ActionActivates or deactivates one login.
Input fields[3]
FieldType
User IDRequired
text
TypeRequired
choice
StatusRequired
choice

Sync a Contact

ActionCreate-or-update for one email contact.
Input fields[3]
FieldType
EmailRequired
text
Listchoice
IP Addresstext
Statuschoice
Custom Fieldsarray
Fieldobject

Track a Category View

ActionReports a category page visit to ecommerce tracking.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Customer EmailRequired
text
Category IDRequired
text
NameRequired
text
Unique IDtext
IP Addresstext
Linktext
Image URLtext
Descriptiontext

Track a Product Search

ActionReports an on-site search term to ecommerce tracking.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Search TextRequired
text
Customer Emailtext
Unique IDtext
IP Addresstext

Track a Product View

ActionReports a product page open to ecommerce tracking.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Product IDRequired
text
NameRequired
text
PriceRequired
number
Customer Emailtext
Unique IDtext
IP Addresstext
Discount Pricenumber
Currencytext
SKUtext
Category IDtext
Categorytext
Linktext
Image URLtext
Descriptiontext

Update a Cart

ActionAmends cart tracking data.
Input fields[3]
FieldType
Customer EmailRequired
text
Cart IDRequired
text
Store Domain Keytext
Unique IDtext
IP Addresstext
Currencytext
Store Nametext
Abandoned Cart URLtext
Customer Infoobject
Firstnametext
Lastnametext
Phonetext
Companytext
Countrytext

Update an Order

ActionRevises a store order already recorded.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Order IDRequired
text
Payment MethodRequired
text
Grand TotalRequired
number
Customer InfoRequired
object
Firstnametext
Lastnametext
Emailtext
Phonetext
Companytext
Countrytext
Cart IDtext
Order Numbertext
Shipping Methodtext
Shipping Costnumber
Store Nametext
Subtotalnumber
Promo Codetext
Promo Valuenumber
Discount Codetext
Discount Valuenumber

9other input fields

Update Customer Preferences

ActionShopper category interests saved.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Customer EmailRequired
text
Categoriesarray
Valuetext

Upsert a Customer

ActionCreate-or-update for an ecommerce customer.
Input fields[3]
FieldType
Store Domain KeyRequired
text
Emailtext
Unique IDtext
IP Addresstext
First Nametext
Last Nametext
Phonetext
Companytext
Countrytext

Look for VBOUT templates in the WEXTL template library.

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

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.