RoomBoss - Apps Documentation

Requirements

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

Get your RoomBoss credentials

UsernametextRequired
Enter the API username provided for your account. Contact your administrator or RoomBoss support to obtain API credentials.
[1]
PasswordpasswordRequired
Enter the API password associated with your API username.
[1]

Connect RoomBoss in WEXTL

Log in to your WEXTL account, add the RoomBoss node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your RoomBoss account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
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 →

RoomBoss node modules

The list below is a reference of every RoomBoss node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Browse every RoomBoss node module below — each one opens to show its input parameters, outputs, and connection requirements.

Watch BookingsTrigger

Output fields[3]

Field	Type
Package ID	text
EID	number
Custom ID	text
Segment	text
Booking ID	text
Active	boolean
Extent	text
Room status	text
Items	array
Created date	text
Created user	text
Last modified date	text
Last modified user	text
Booking type	text
Booking source	text
Notes	text
Discount code	text
Lead guest	object
Title	text
Guest ID	text
Given name	text
Family name	text
Email	text
Additional email	text
Gender	text
Nationality	text
Age	number
Phone number	text
Guest intranet URL	text
Hotel	object
URL	text
Vendor type	text
Country code	text
Location code	text
Latitude	number
Longitude	number
Currency code	text
Hotel ID	text
Hotel name	text
Hotel URL	text

Watch Bookings by ResourceTrigger

Output fields[3]

Field	Type
Package ID	text
EID	number
Custom ID	text
Segment	text
Booking ID	text
Active	boolean
Extent	text
Room status	text
Items	array
Created date	text
Created user	text
Last modified date	text
Last modified user	text
Booking type	text
Booking source	text
Notes	text
Discount code	text
Guest intranet URL	text
Hotel	object
URL	text
Vendor type	text
Country code	text
Location code	text
Latitude	number
Longitude	number
Currency code	text
Hotel ID	text
Hotel name	text
Hotel URL	text

Watch PaymentsTrigger

Output fields[3]

Field	Type
Package ID	text
Invoice number	text
Invoice ID	text
Invoice date	text
Invoice amount	number
Invoice due date	text
Invoice created by	text
Invoice created date	text
Invoice modified by	text
Invoice modified date	text
Invoice notes	text
Payment ID	text
Payment date	text
Payment amount	number
Payment method	text
Payment created by	text
Payment created date	text
Payment modified by	text
Payment modified date	text
Payment notes	text

Get a BookingAction

Input fields[3]

Field	Type
Booking ID	text
Booking EID	text

Output fields[3]

Field	Type
Pos ID	text
Lead guest	object
Title	text
Guest ID	text
Given name	text
Family name	text
Email	text
Additional email	text
Gender	text
Nationality	text
Age	number
Phone number	text
Bookings	array
Invoice payments	array

Get a PackageAction

Input fields[3]

Field	Type
Package ID	text
Booking ID	text

Output fields[3]

Field	Type
Package ID	text
Company name	text
Company email	email
Company phone	text
Currency code	text
Bookings	array
Guests	array
Invoice payments	array

Get SKIDATA Booking Sync StatusAction

Input fields[3]

Field	Type
Booking IDRequired	text

Output fields[3]

Field	Type
Booking ID	text
Status	text
Items	array

List Available StaysSearch

Input fields[3]

Field	Type
Hotel ID	choice
Check-in DateRequired	date
Check-out DateRequired	date
Number of GuestsRequired	number
Exclude Unavailable Room Types	boolean
Discount Code	text
Rate Type	text
Vendor Set Code	text
Alternative Currency	text
Return All Hotels	boolean
Country Code	text
Location Code	text
Limit	number

Output fields[3]

Field	Type
Hotel ID	text
Hotel name	text
Country code	text
Location code	text
Latitude	number
Longitude	number
Currency code	text
URL	text
Internal inventory	boolean
Booking permission	text
Record guest type	boolean
Max age children	number
Max age infants	number
Room types	array
Available room types	array

List Bookings by ResourceSearch

Input fields[3]

Field	Type
Resource IDRequired	text
Limit	number

Output fields[3]

Field	Type
Package ID	text
EID	number
Custom ID	text
Segment	text
Booking ID	text
Active	boolean
Extent	text
Room status	text
Items	array
Created date	text
Created user	text
Last modified date	text
Last modified user	text
Booking type	text
Booking source	text
Notes	text
Discount code	text
Guest intranet URL	text
Hotel	object
URL	text
Vendor type	text
Country code	text
Location code	text
Latitude	number
Longitude	number
Currency code	text
Hotel ID	text
Hotel name	text
Hotel URL	text

List Bookings Changed on DateSearch

Input fields[3]

Field	Type
Change DateRequired	date
Booking Type	choice
From Date	date
To Date	date
Vendor IDs	text
Limit	number

Output fields[3]

Field	Type
Package ID	text
EID	number
Custom ID	text
Segment	text
Booking ID	text
Active	boolean
Extent	text
Room status	text
Items	array
Created date	text
Created user	text
Last modified date	text
Last modified user	text
Booking type	text
Booking source	text
Notes	text
Discount code	text
Lead guest	object
Title	text
Guest ID	text
Given name	text
Family name	text
Email	text
Additional email	text
Gender	text
Nationality	text
Age	number
Phone number	text
Guest intranet URL	text
Hotel	object
URL	text
Vendor type	text
Country code	text
Location code	text
Latitude	number
Longitude	number
Currency code	text
Hotel ID	text
Hotel name	text
Hotel URL	text

Field	Type
Category ID	text
Name	text
Image	text
Description	text
Sequence	number
Active	boolean
Has offers	boolean
Children	array

List GuestsSearch

Input fields[3]

Field	Type
Guest ID	text
Guest Email	email
Limit	number

Output fields[3]

Field	Type
Guest ID	text
Title	text
First name	text
Last name	text
Additional first name	text
Additional last name	text
Email	text
Phone number	text
Gender	text
Date of birth	text
Height	text
Weight	text
Nationality	text
Address 1	text
Address 2	text
City	text
State	text
Post code	text
Language	text
Dietary restrictions	text

5other output fields

List HotelsSearch

Input fields[3]

Field	Type
Country CodeRequired	text
Location CodeRequired	text
Limit	number

Output fields[3]

Field	Type
Hotel ID	text
Hotel name	text
Country code	text
Location code	text
Latitude	number
Longitude	number
Currency code	text
URL	text
Internal inventory	boolean
Record guest type	boolean
Max age children	number
Max age infants	number
Room types	array

List ImagesSearch

Input fields[3]

Field	Type
Hotel ID	choice
Limit	number

Output fields[3]

Field	Type
Hotel ID	text
Hotel images	object
Hero 01	text
Room types	array

List Payments Changed on a DateSearch

Input fields[3]

Field	Type
DateRequired	date
Booking Type Filter	choice
Limit	number

Output fields[3]

Field	Type
Package ID	text
Invoice number	text
Invoice ID	text
Invoice date	text
Invoice amount	number
Invoice due date	text
Invoice created by	text
Invoice created date	text
Invoice modified by	text
Invoice modified date	text
Invoice notes	text
Payment ID	text
Payment date	text
Payment amount	number
Payment method	text
Payment created by	text
Payment created date	text
Payment modified by	text
Payment modified date	text
Payment notes	text

List Product OptionsSearch

Input fields[3]

Field	Type
Vendor IDRequired	text
Language	choice
Limit	number

Output fields[3]

Field	Type
Product ID	text
Product options	array

List ProductsSearch

Input fields[3]

Field	Type
Category IDRequired	text
Language	text
Limit	number

Output fields[3]

Field	Type
Product ID	text
Name	text
Description	text
Image	text
Sequence	number
Has offers	boolean
Guest image required	boolean
Product options	array
Unbookable dates	array

List Rate Plan DescriptionsSearch

Input fields[3]

Field	Type
Hotel ID	choice
Limit	number

Output fields[3]

Field	Type
Rate plan ID	number
Names	object
En	text
Ja	text
Descriptions	object
En	text
Ja	text
Long descriptions	object
En	text
Ja	text

List TextSearch

Input fields[3]

Field	Type
Hotel ID	choice
locale	text
Limit	number

Output fields[3]

Field	Type
Hotel ID	text
Hotel name	text
Hotel description	text
Room types	array

List VendorsSearch

Input fields[3]

Field	Type
Country CodeRequired	text
Location CodeRequired	text
Language	text
Vendor Set Code	text
Limit	number

Output fields[3]

Field	Type
Vendor ID	text
Name	text
Image	text
Description	text
URL	text
Country code	text
Location code	text
Latitude	number
Longitude	number
Currency code	text
Vendor type	text
Booking permission	text
Book and pay enabled	boolean
Hide request if book and pay enabled	boolean

Cancel a BookingAction

Input fields[3]

Field	Type
Booking ID	text
Booking EID	text

Output fields[3]

Field	Type
API version	text
Success	boolean
Failure message	text

Create a BookingAction

Input fields[3]

Field	Type
Hotel IDRequired	choice
State / Region	text
Booking Segment	text
Address Line 1	text
Address Line 2	text
Booking Extent	choice
City	text
Booking Comment	text
Company	text
Contact Number	text
Country	text
Custom Booking ID	text
Dietary Restrictions	text
Discount Code	text
Date of Birth	date
Emergency Contact Name	text
Emergency Contact Phone	text
Gender	choice
Guest Email	text
Guest Last NameRequired	text

18other input fields

Output fields[3]

Field	Type
Pos ID	text
Lead guest	object
Title	text
Guest ID	text
Given name	text
Family name	text
Email	email
Additional email	email
Gender	text
Nationality	text
Age	number
Phone number	text
Bookings	array
Invoice payments	array

Create a Booking PaymentAction

Input fields[3]

Field	Type
Booking IDRequired	text
Invoice IDRequired	text
Payment ID	text
Payment AmountRequired	number

Output fields[3]

Field	Type
API version	text
Success	boolean
Failure message	text

Create a Booking Pre-RegistrationAction

Input fields[3]

Field	Type
Booking IDRequired	text
Pre-RegisteredRequired	boolean

Output fields[3]

Field	Type
API version	text
Success	boolean
Failure message	text

Create a PackageAction

Input fields[3]

Field	Type
Booking ItemsRequired	array
GuestsRequired	array
Booking Segment	text
Discount Code	text
Notes	text
Multi Vendor	boolean

Output fields[3]

Field	Type
Package ID	text
Company name	text
Company email	email
Company phone	text
Currency code	text
Bookings	array
Guests	array
Invoice payments	array

Create a PaymentAction

Input fields[3]

Field	Type
Booking IDRequired	text
Invoice IDRequired	text
Payment AmountRequired	number
Payment MethodRequired	choice
Payment ID	text

Output fields[3]

Field	Type
API version	text
Failure message	text

Create an OfferAction

Input fields[3]

Field	Type
Product IDRequired	text
Start DateRequired	date
Product Options	object
Option PositionRequired	number
Selected ValueRequired	text
Discount Code	text

Output fields[3]

Field	Type
API version	text
Failure message	text
Pos ID	text
Vendor ID	text
Category ID	text
Product ID	text
Start date	date
Booking permission	text
Number guests	number
Min associated guests	number
Price rack	number
Price gross	number
Currency code	text
Product options	array
Discount code	text
Quantity available	number

Create Guest FieldsAction

Input fields[3]

Field	Type
Vendor IDsRequired	array

Output fields[3]

Field	Type
API version	text
Failure message	text
Pos ID	text
Vendor ids	array
Req name format	text
Req additional name format	text
Guest fields	object
Title	text
First name	text
Last name	text
Additional first name	text
Additional last name	text
Email	email
Phone number	text
Gender	text
Date of birth	text
Height	text

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Push AvailabilityAction

Input fields[3]

Field	Type
Availability XMLRequired	text

Output fields[3]

Field	Type
Ota hotel avail notif rs	object
attributes	object
Success	array

Push RestrictionsAction

Input fields[3]

Field	Type
Restrictions XMLRequired	text

Output fields[3]

Field	Type
Ota hotel avail notif rs	object
attributes	object
Success	array

Send RatesAction

Input fields[3]

Field	Type
Rates XML PayloadRequired	text

Output fields[3]

Field	Type
Ota hotel rate amount notif rs	object
attributes	object
Success	array

Update a Lead GuestAction

Input fields[3]

Field	Type
Booking IDRequired	text
Additional First Name	text
Additional Last Name	text
Estimated Arrival Time	text
Email	text
Contact Number	text
Date of Birth	date
Nationality	text
Special Requests	text
Notes	text
Address	object
Address Line 1	text
City	text
State / Region	text
Post Code	text
Identification Details	object
ID Number	text
Date of Issue	date
Date of Expiry	date
Place of Issue	text
Country of Issue	text
Credit Card Details	object
Card Expiry Date	text
Token Expiry Date	date
Last Four Digits	text
Payment Token	text
Card Brand	text
Card Holder Name	text
Payment Account Type	text
Payment Account ID	text

Output fields[3]

Field	Type
API version	text
Success	boolean
Failure message	text

Update Room Status and Housekeeping TasksAction

Input fields[3]

Field	Type
Booking IDRequired	text
Room IDRequired	text
Room StatusRequired	choice
Booking Item ID	text
Update Mode	choice
Housekeeping Tasks	array

Output fields[3]

Field	Type
API version	text
Success	boolean
Failure message	text
Booking ID	text
Room ID	text
Item ID	text
Tasks	array

Upload a Guest ImageAction

Input fields[3]

Field	Type
Guest ImageRequired	text

Output fields[3]

Field	Type
API version	text
Failure message	text
Image	text

Templates

Look for RoomBoss templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Scheduling category →

References

WEXTL® RoomBoss Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for RoomBoss.
WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:12

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.