Requirements
Before you set up the credential, make sure you have an active Planyo account and an API access token from your account settings ready.[3]
Get your Planyo credentials
- Base URLtextRequired
The base URL of the REST API, without protocol (e.g. www.planyo.com/rest).
[1] - API KeypasswordRequired
Your API key. Find it in your backend under Settings / API access (or similar).
[1] - Hash Key Secret (optional)passwordRequired
Only required if 'hash key' security is enabled for your API key. Leave empty otherwise. When set, every request automatically includes a computed hash_timestamp and hash_key (MD5 of hash_key_secret + hash_timestamp + method).
[1] - Default Language (optional)select
2-letter ISO 639-1 language code used to localize text values returned by Planyo. Can be overridden per module.
[1]
Connect Planyo in WEXTL
- Log in to your WEXTL account, add the Planyo 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 Planyo 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 →
Planyo node modules
The list below is a reference of every Planyo node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Planyo node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch ReservationsTrigger
Output fields[3]
| Field | Type |
|---|---|
| Reservation ID | number |
| Start Time | date |
| End Time | date |
| Creation Time | date |
| Quantity | number |
| User Notes | text |
| Admin Notes | text |
| Unit Assignment | text |
| Custom Color | text |
| Night Reservation | boolean |
| First Name | text |
| Last Name | text |
| Login | text |
| User ID | number |
12other output fields
Get Cart ItemsSearch
Get Event TimesAction
Get Invoice ItemsAction
Get Promotable ReservationsSearch
Get Rental PriceAction
Input fields[3]
| Field | Type |
|---|---|
ResourceRequired | choice |
Start TimeRequired | date |
End TimeRequired | date |
QuantityRequired | number |
| Admin Mode | boolean |
| Reservation Property | text |
| Shopping Cart Position | number |
| Shopping Cart Resource Quantity | number |
| Shopping Cart Resource Hours | number |
| Shopping Cart Total Price | number |
| Sharing Mode | text |
| User | choice |
| User Email | |
| Extra Periods (Advanced) | text |
Output fields[3]
| Field | Type |
|---|---|
| Currency | text |
| Total | number |
| Pricing Log Applied Rules | array |
| Pricing Log Products | array |
Get Reservation ActionsSearch
Get Reservation DataAction
Input fields[3]
| Field | Type |
|---|---|
ReservationRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Resource ID | number |
| Name | text |
| User ID | number |
| Site ID | number |
| Start Time | date |
| End Time | date |
| Status | number |
| Quantity | number |
| Creation Time | date |
| Unit Assignment | text |
| Custom Color | text |
| User Text | text |
| User Notes | text |
| Admin Notes | text |
| Total Price | number |
20other output fields
Get Reservation Payment AmountAction
Get Resource InfoAction
Input fields[3]
| Field | Type |
|---|---|
ResourceRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Name | text |
| Translated Name | text |
| Quantity | number |
| Site ID | number |
| Confirmation Type | number |
| Category | number |
| Sharing Mode | number |
| Start Hour | number |
| End Hour | number |
| Start Quarters | number |
| Time Unit | number |
| Unit Price | text |
| Unit Names | text |
| Predefined Durations | object |
| Currency | text |
18other output fields
Get Resource PricingAction
Get Resource SeasonsAction
Get Simplified Daily PricingAction
Get Site InfoAction
Get Unit PropertyAction
Get User DataAction
Input fields[3]
| Field | Type |
|---|---|
| User | choice |
| Site | choice |
| Detail Level | number |
Output fields[3]
| Field | Type |
|---|---|
| Login | text |
| ID | number |
| Registration Time | date |
| Is Email Verified | boolean |
| First Name | text |
| Last Name | text |
| Address | text |
| City | text |
| ZIP | text |
| State | text |
| Country | text |
| Language | text |
| Phone Number | text |
| Reservation Count | number |
2other output fields
List Additional ProductsSearch
List Cart PaymentsAction
List CartsSearch
List CouponsSearch
Input fields[3]
| Field | Type |
|---|---|
| Resource | choice |
| Site ID | text |
| Coupon Code | text |
| Only Valid Coupons | boolean |
| Include Reservations | boolean |
| Include Usage Data | boolean |
| Rental Time | date |
| Type | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Type | number |
| ID | number |
| Resource ID | text |
| Personal Usage | number |
| Coupon Code | text |
| Is Personal | boolean |
| Amount Left | number |
| Amount Used | number |
| Purchase Date | date |
| Latest Usage Time | date |
| Latest Reservation Start Time | date |
| Latest Coupon Type ID | number |
| Entry Per Person | boolean |
| Reservations | array |
3other output fields
List InvoicesSearch
List PaymentsSearch
Input fields[3]
| Field | Type |
|---|---|
Start DateRequired | date |
End DateRequired | date |
| Resource | choice |
| Site | choice |
| Payment Mode ID Filter | number |
| Status | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Payment ID | number |
| Payment Date | date |
| Site ID | number |
| Payment Mode ID | number |
| Payment Mode | text |
| Payment Amount | number |
| Payment Currency | text |
| Payment Comment | text |
| Extra Info | text |
| Custom ID | text |
| Status Code | number |
| Status | text |
| Reservation ID | number |
| Resource ID | number |
| User ID | number |
3other output fields
List Reservation PaymentsAction
List ReservationsSearch
Input fields[3]
| Field | Type |
|---|---|
Start TimeRequired | date |
End TimeRequired | date |
| Resource | choice |
| Resource IDs (comma-separated) | text |
| Site | choice |
| List By Creation Date | boolean |
| Must Include Time Point | date |
| Must Include Time Range Start | date |
| Must Include Time Range End | date |
| Sort By | choice |
| Sort Reverse | boolean |
| Detail Level | number |
| User | choice |
| User Email | |
| Unit Assignment | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
| Reservation ID | number |
| Start Time | date |
| End Time | date |
| Creation Time | date |
| Quantity | number |
| User Notes | text |
| Admin Notes | text |
| Unit Assignment | text |
| Custom Color | text |
| Night Reservation | boolean |
| First Name | text |
| Last Name | text |
| Login | text |
| User ID | number |
12other output fields
List ResourcesSearch
Input fields[3]
| Field | Type |
|---|---|
| Detail Level | number |
| Published Only | boolean |
| Reservable Only | boolean |
| Resource Types | choice |
| Resource Admin | choice |
| Resource Property Filter | text |
| GPS Search Radius | text |
| Resource GPS Coordinates | text |
| Site GPS Coordinates | text |
| Resource ID Filter (comma-separated) | text |
| Sort By | choice |
| Site | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Resource Count | number |
| Max Page | number |
| Resources | array |
| ID | number |
| Name | text |
| Quantity | number |
| Site ID | number |
| Confirmation Type | number |
| Unit Price | text |
| Currency | text |
| Category | number |
| Is Published | boolean |
| Is Listed | boolean |
List ReviewsSearch
List SitesSearch
Input fields[3]
| Field | Type |
|---|---|
| Detail Level | number |
| Main Administrator | choice |
| Filter Name | text |
| Filter Value | text |
| GPS Search Radius | text |
| Sort By | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Site Count | number |
| Max Page | number |
| Sites | array |
| ID | number |
| Name | text |
| Metasite ID | text |
| Admin ID | number |
| Creation Time | date |
| Base Site ID | number |
| Timezone | text |
| Default Language | text |
List TranslationsSearch
List UsersSearch
Input fields[3]
| Field | Type |
|---|---|
| Site | choice |
| Detail Level | number |
| Custom Property Filter Name | text |
| Custom Property Filter Value | text |
| First Name Filter | text |
| Last Name Filter | text |
| Email Filter | |
| Country Filter | text |
| Address Filter | text |
| City Filter | text |
| ZIP Filter | text |
| Phone Number Filter | text |
| Phone Country Code Filter | text |
| Mobile Number Filter | text |
| Mobile Country Code Filter | text |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| First Name | text |
| Last Name | text |
| Login | text |
| Registration Time | date |
| IP Address | text |
| Reservation Count | number |
| Phone Number | text |
| Phone Country Code | text |
| Mobile Number | text |
| Mobile Country Code | text |
| Address | text |
| City | text |
| ZIP | text |
4other output fields
List VacationsSearch
Input fields[3]
| Field | Type |
|---|---|
Start TimeRequired | date |
End TimeRequired | date |
| Resource ID | text |
| Site | choice |
TypeRequired | choice |
| Unit Assignment | text |
| Include Site Vacations | boolean |
| Recurrence Type | choice |
| Expand Recurring | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Vacation ID | number |
| Start Time | date |
| End Time | date |
| Comment | text |
| Quantity | number |
| Type | number |
| Resource ID | number |
| Valid From | date |
| Valid To | date |
| Period Type | number |
| Weekday | number |
| Start Month Day | number |
| End Month Day | number |
| Start Month | number |
| End Month | number |
List VouchersSearch
Input fields[3]
| Field | Type |
|---|---|
| Rental Start Time | date |
| Rental End Time | date |
| Resource | choice |
| Site | choice |
| Voucher Code / Prefix | text |
| Check Reservation Time | boolean |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Voucher ID | number |
| Code | text |
| Quantity | number |
| Quantity Used | number |
| Reservation Start Date | date |
| Reservation End Date | date |
| Discount Value | text |
| Unique Codes | text |
| Non Combinable | boolean |
| Rental Start Date | date |
| Rental End Date | date |
| Voucher Title | text |
| Resources | text |
Reservation SearchSearch
Input fields[3]
| Field | Type |
|---|---|
Search QueryRequired | text |
| Detail Level | number |
| Sort By | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| Reservation ID | number |
| Start Time | date |
| End Time | date |
| User Notes | text |
| Admin Notes | text |
| Custom Color | text |
| Night Reservation | boolean |
| First Name | text |
| Last Name | text |
| Login | text |
| User ID | number |
| Phone | text |
| Phone Country Code | text |
| Resource ID | number |
1other output field
Resource SearchSearch
Input fields[3]
| Field | Type |
|---|---|
Start TimeRequired | date |
End TimeRequired | date |
| Site | choice |
| Site IDs (comma-separated) | text |
QuantityRequired | number |
| Sort By | choice |
| Resource Property Filter | text |
| Site Property Filter | text |
| Reservation Property | text |
| Resource ID Filter (comma-separated) | text |
| Output Format | choice |
| Detail Level | number |
| Range Search | text |
| List Unavailable Resources | boolean |
| Skip Pricing Log | boolean |
6other input fields
Output fields[3]
| Field | Type |
|---|---|
| Results | array |
| ID | number |
| Name | text |
| Total Price | number |
| HTML Code | text |
| Reason Not Listed | array |
Add Additional ProductAction
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
| Site | choice |
PriceRequired | number |
Max QuantityRequired | number |
| Description | text |
| Per Person | choice |
| Recurring (Daily) | boolean |
| Reservable By Customer | boolean |
| Selected By Default | boolean |
| Priority Group (0-20) | number |
| Currency | text |
| Tax Rate (%) | number |
| Extra Info Field Label | text |
| Custom Value | text |
| Compatible Resource IDs (comma-separated) | text |
Output fields[3]
| Field | Type |
|---|---|
| New Product ID | number |
Add AgentAction
Add Notification MessageAction
Input fields[3]
| Field | Type |
|---|---|
Notification TypeRequired | choice |
RecipientRequired | choice |
| Resource | choice |
| Message Language | text |
SubjectRequired | text |
BodyRequired | text |
| From Address | choice |
| BCC (comma-separated) | text |
| Invoice Attachment | choice |
| Reservation Document 1 (index) | text |
| Reservation Document 2 (index) | text |
| Reply-To Customer | choice |
Add Pricing Manager RuleAction
Add Recurring VacationAction
Add Reservation PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Payment ModeRequired | choice |
Payment StatusRequired | choice |
Transaction IDRequired | text |
AmountRequired | number |
CurrencyRequired | text |
| Reservation ID | number |
| Reservation IDs | text |
| Payment Response Code | text |
| Transaction Status Text | text |
| Payment Time | date |
| Extra Info | text |
| Is Quiet | boolean |
Output fields[3]
| Field | Type |
|---|---|
| Status | number |
| Payment ID | number |
Add ResourceAction
Input fields[3]
| Field | Type |
|---|---|
Base ResourceRequired | choice |
NameRequired | text |
QuantityRequired | number |
| Predefined Duration Count | number |
| Min Rental Time (hours) | number |
| Max Rental Time (hours) | number |
| Available From (Hour, 24h) | number |
| Available Until (Hour, 24h) | number |
| Restricted Start Times (comma-separated) | text |
| Min Hours To Rental | number |
| Max Days To Rental | number |
| Default Price | text |
| Resource Admin | choice |
| Event Dates (comma-separated) | text |
| Published | boolean |
3other input fields
Output fields[3]
| Field | Type |
|---|---|
| New Resource ID | number |
Add Resource ImageAction
Add Resource SeasonAction
Input fields[3]
| Field | Type |
|---|---|
Start Month (1-12)Required | number |
Start Day (1-31)Required | number |
End Month (1-12)Required | number |
End Day (1-31)Required | number |
| Year | number |
| Resource | choice |
| Site | choice |
Min Rental Time (hours)Required | number |
| Max Rental Time (hours) | number |
| Start Weekday Flags | number |
| End Weekday Flags | number |
| Priority | number |
| Title | text |
| Color | text |
Output fields[3]
| Field | Type |
|---|---|
| Season ID | number |
| Priority | number |
Add SiteAction
Input fields[3]
| Field | Type |
|---|---|
Base SiteRequired | choice |
Main AdministratorRequired | choice |
NameRequired | text |
Commission Based (PRO-COMM)Required | boolean |
| Copy Resources | boolean |
| Payment Account ID | text |
| Generate API Key | boolean |
| Moderator | choice |
| Copy Published Resources Only | boolean |
Output fields[3]
| Field | Type |
|---|---|
| New Site ID | number |
| New Key | text |
Add UserAction
Input fields[3]
| Field | Type |
|---|---|
EmailRequired | |
First NameRequired | text |
| Last Name | text |
| Login | text |
| Password | secret |
| Country | text |
| Address | text |
| City | text |
| ZIP / Postal Code | text |
| State / Province | text |
| Phone | text |
| Phone Country Code | text |
| Mobile | text |
| Mobile Country Code | text |
| Language | text |
2other input fields
Output fields[3]
| Field | Type |
|---|---|
| User ID | number |
| Is New | number |
Apply CouponAction
Apply VoucherAction
Can Make ReservationAction
Input fields[3]
| Field | Type |
|---|---|
ResourceRequired | choice |
Start TimeRequired | date |
End TimeRequired | date |
QuantityRequired | number |
| Unit Assignment 1 | text |
| Admin Mode | boolean |
| Sharing Mode | text |
| Reservation Property | text |
| User | choice |
| Excluded Reservation | choice |
| Return Availability | boolean |
| Return Price | text |
Output fields[3]
| Field | Type |
|---|---|
| Is Reservation Possible | boolean |
| Problem Time | date |
| Reason | text |
Create CartAction
Create VoucherAction
Input fields[3]
| Field | Type |
|---|---|
QuantityRequired | number |
Voucher Code / PrefixRequired | text |
Discount ValueRequired | text |
Reservation Start TimeRequired | date |
Reservation End TimeRequired | date |
| Title | text |
| Rental Start Time | date |
| Rental End Time | date |
| Site | choice |
| Resource IDs (comma-separated) | text |
| Non-combinable | boolean |
| One Per Customer | boolean |
| Include Products | boolean |
| Unique Codes | choice |
Output fields[3]
| Field | Type |
|---|---|
| New Voucher ID | number |
| Codes | array |
Delete CartAction
Input fields[3]
| Field | Type |
|---|---|
Shopping CartRequired | choice |
Delete ReservationAction
Input fields[3]
| Field | Type |
|---|---|
ReservationRequired | choice |
| Delete User If No Other Reservations | boolean |
Delete Unit PropertyAction
Do Reservation ActionAction
Generate CouponAction
Generate InvoiceAction
Make an Api Calluniversal
Make ReservationAction
Input fields[3]
| Field | Type |
|---|---|
ResourceRequired | choice |
Start TimeRequired | date |
End TimeRequired | date |
QuantityRequired | number |
| Admin Mode | boolean |
| Send Notifications | boolean |
| Force Status | number |
| Sharing Mode | text |
| Reservation Property | text |
| Voucher Code | text |
| Custom Price | text |
| User | choice |
EmailRequired | |
First NameRequired | text |
| Last Name | text |
18other input fields
Output fields[3]
| Field | Type |
|---|---|
| Reservation ID | number |
| Shopping Cart ID | number |
| User Text | text |
| Status | number |
| Total Price | number |
| Original Price | number |
| Currency | text |
| Discount | number |
| Properties | object |
Modify Additional ProductAction
Input fields[3]
| Field | Type |
|---|---|
ProductRequired | choice |
| Name | text |
| Price | number |
| Max Quantity | number |
| Description | text |
| Per Person | choice |
| Recurring (Daily) | boolean |
| Reservable By Customer | boolean |
| Selected By Default | boolean |
| Priority Group (0-20) | number |
| Tax Rate (%) | number |
| Extra Info Field Label | text |
| Custom Value | text |
| Compatible Resource IDs (comma-separated) | text |
Modify CouponAction
Modify ReservationAction
Input fields[3]
| Field | Type |
|---|---|
| Reservation | choice |
| Reservation IDs (comma-separated, max 50) | text |
| Resource | choice |
| Start Time | date |
| End Time | date |
| User | choice |
| Quantity | number |
| Admin Mode | boolean |
| Send Notifications | boolean |
| Reservation Property | text |
| Unit Assignment 1 | text |
| Recalculate Price | boolean |
| Administrator | choice |
| Comments | text |
Output fields[3]
| Field | Type |
|---|---|
| Status | number |
| Warning Text | text |
Modify ResourceAction
Input fields[3]
| Field | Type |
|---|---|
ResourceRequired | choice |
| Name | text |
| Description | text |
| Quantity | number |
| Min Rental Time (hours) | number |
| Max Rental Time (hours) | number |
| Predefined Durations | text |
| Available From (Hour, 24h) | number |
| Available Until (Hour, 24h) | number |
| Restricted Start Times (comma-separated) | text |
| Confirmation Method | choice |
| Min Time Between Rentals (hours) | number |
| Min Hours To Rental | number |
| Max Days To Rental | number |
| Start Quarters | number |
10other input fields
Modify Resource SeasonAction
Input fields[3]
| Field | Type |
|---|---|
SeasonRequired | choice |
| Start Month (1-12) | number |
| Start Day (1-31) | number |
| End Month (1-12) | number |
| End Day (1-31) | number |
| Year | number |
| Min Rental Time (hours) | number |
| Max Rental Time (hours) | number |
| Start Weekday Flags | number |
| End Weekday Flags | number |
| Priority | number |
| Title | text |
| Color | text |
Modify SiteAction
Input fields[3]
| Field | Type |
|---|---|
| Site | choice |
| Name | text |
| Description | text |
| Use Shopping Cart | boolean |
| Site Property | text |
| Timezone | text |
| Date Format | choice |
| Time Format | choice |
| Default Language | text |
| Online Payment Surcharge (%) | number |
| Allowed Domains (comma-separated, max 10) | text |
| Notification Send Window (days) | number |
Modify UserAction
Input fields[3]
| Field | Type |
|---|---|
| User | choice |
| Login | text |
| New First Name | text |
| New Last Name | text |
| New Email | |
| New Country | text |
| New Address | text |
| Email Verified | boolean |
| New City | text |
| New ZIP / Postal Code | text |
| New State / Province | text |
| New Phone | text |
| New Phone Country Code | text |
| New Mobile | text |
6other input fields
Output fields[3]
| Field | Type |
|---|---|
| User ID | number |
Modify VoucherAction
Input fields[3]
| Field | Type |
|---|---|
VoucherRequired | choice |
| Quantity | number |
| Voucher Code / Prefix | text |
| Discount Value | text |
| Reservation Start Time | date |
| Reservation End Time | date |
| Title | text |
| Rental Start Time | date |
| Rental End Time | date |
| Non-combinable | boolean |
| One Per Customer | boolean |
| Include Products | boolean |
| Resource IDs (comma-separated) | text |
Move Reservations to CartAction
Process TemplateAction
Recalculate PriceAction
Remove Additional ProductAction
Input fields[3]
| Field | Type |
|---|---|
ProductRequired | choice |
SiteRequired | choice |
Product ID MD5Required | text |
Remove CouponAction
Input fields[3]
| Field | Type |
|---|---|
CouponRequired | choice |
Remove Reservation PaymentAction
Remove ResourceAction
Input fields[3]
| Field | Type |
|---|---|
ResourceRequired | choice |
Resource NameRequired | text |
Parent SiteRequired | choice |
Resource ID MD5Required | text |
Remove Resource SeasonAction
Input fields[3]
| Field | Type |
|---|---|
SeasonRequired | choice |
Remove UserAction
Input fields[3]
| Field | Type |
|---|---|
UserRequired | choice |
| Site | choice |
Remove VacationAction
Input fields[3]
| Field | Type |
|---|---|
VacationRequired | choice |
Remove VoucherAction
Input fields[3]
| Field | Type |
|---|---|
VoucherRequired | choice |
Send Email to CustomerAction
Set Reservation PriceAction
Set Resource AdminAction
Set Resource PricingAction
Input fields[3]
| Field | Type |
|---|---|
ResourceRequired | choice |
| Rule Price Type (per rule ID) | text |
Rule Price Value (per rule ID)Required | text |
Set TranslationAction
Input fields[3]
| Field | Type |
|---|---|
Text IDRequired | text |
Translation ValueRequired | text |
| Site | choice |
| Resource | choice |
Templates
Look for Planyo templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Acuity Scheduling[2]Online appointment scheduling for service businesses and calendars.
- AgendizeOnline appointment scheduling and customer engagement platform for businesses.
- AppointeddOnline booking and appointment scheduling for retail and service businesses.
- Appointment ReminderCreate, retrieve and manage appointments and their automated phone, SMS and email reminders in Appointment Reminder.
- BetterezPassenger ticketing and operations platform for bus and coach carriers — routes, fares, and bookings.
References
- WEXTL® Planyo Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Planyo.
- WEXTL® visual workflow builder data.
Last updated: Jul 22, 2026 23:18