About this integration
Virtual waitlist and appointment platform for walk-ins and scheduled visits.
There are 9 triggers, 30 search modules and 32 actions available. The integration connects via basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for API Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | Generate an API key in your dashboard under Settings → API keys. The key will be used to authenticate requests to the API. |
Use it in workflow automation
Start with Watch Audit Entry, then add Cancel Visits.
The canvas below runs Watch Audit Entry into Cancel Visits — watch the video, then drop a node onto the canvas.
Select the Watch Locations trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create or Update a Default Location Message Template as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 41 ready-made modules for scheduling work — each run logs its inputs and outputs for debugging.
Waitwhile workflow on the canvas: Watch Locations then Create or Update a Default Location Message Template
Triggers, searches and actions
Open any Waitwhile trigger, search, or action to see its inputs and outputs — 9 triggers, 30 searchs, 32 actions.
Triggers
Use one of 9 triggers to kick off a workflow as soon as an event occurs in the app.
- Watch Audit Entry
- Watch Customers
- Watch Events
- Watch Locations
- Watch Messages
Searches
This integration includes 30 search modules for looking data up mid-run.
- Get a Customer
- Get a Customer Note
- Get a Default Location Message Template
- Get a Location by ID or Short Name
- Get a Location Message Config
Actions
Take action during a run with 32 available modules that write data back into the app.
- Cancel Visits
- Create a Customer
- Create a Customer Note
- Create a Location
- Create a User
Explore the fields available for each Waitwhile trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Audit Entry ID | text |
Request ID | text |
Method | text |
URL | text |
User | object |
ID | text |
Impersonator ID | text |
Remote IP | text |
Country | text |
Region | text |
City | text |
User agent | text |
Email | text |
Auth provider ID | text |
Entity | object |
ID | text |
Type | text |
Organization ID | text |
Account ID | text |
Location ID | text |
Event | text |
Info | array |
Changes | array |
Created | date |
| Field | Type |
|---|---|
Customer ID | text |
External ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Notes | text |
Tags | array |
Location ids | text |
States | object |
Last visits | object |
Created | date |
Updated | date |
Created by | date |
Updated by | date |
Metadata | object |
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
Date created | date |
| Field | Type |
|---|---|
Address | object |
City | text |
Country | object |
State | object |
Street | text |
Street 2 | text |
Zip | text |
Allow est wait to exceed hours | boolean |
Assigned plugins | array |
Booking allow overbooking | boolean |
Booking hours | object |
Mon | object |
Tue | object |
Wed | object |
Thu | object |
Fri | object |
Sat | object |
Sun | object |
Booking hours by date | object |
Booking reject unknown customers | boolean |
Booking slot color | text |
Booking waitlist order | text |
Business name | text |
Business type | text |
Currency | text |
Customer search method | text |
Customer session overlap mode | text |
Default num servers | number |
Default visit order value | number |
Default serve duration | number |
| Field | Type |
|---|---|
Name | text |
Email | |
Phone | text |
Default location ID | text |
Location ids | text |
Roles | array |
Resource ID | text |
Message ID | text |
Business name | text |
Account ID | text |
Created | date |
Created by | text |
Updated by | text |
| Field | Type |
|---|---|
Short | text |
Subject | text |
Body | text |
Push | text |
White label | boolean |
Message Template ID | text |
Created | date |
Updated | date |
Created by | text |
Updated by | text |
Location ID | text |
Message type | text |
Language | text |
| Field | Type |
|---|---|
Name | text |
Email | |
Phone | text |
Default location ID | text |
Location ids | text |
Roles | array |
Resource ID | text |
ID | text |
Business name | text |
Account ID | text |
Created | date |
Created by | text |
Updated by | text |
| Field | Type |
|---|---|
User ID | text |
Account ID | text |
Organization ID | text |
Name | text |
Email | |
Phone | text |
Photo URL | text |
Default location ID | text |
Location ids | text |
Roles | array |
Password | text |
Notifications | object |
Arrived | object |
Booked | object |
Waiting | object |
Rescheduled | object |
Serving | object |
Complete | object |
Cancelled | object |
No show | object |
Removed | object |
Alerted | object |
Reports | object |
Performance | array |
Messaging tokens | array |
Created | date |
Updated | date |
Created by | text |
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
Date created | date |
Searches
| Field | Type |
|---|---|
Customer IDRequired | number |
| Field | Type |
|---|---|
Customers ID | text |
External ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Notes | text |
Tags | array |
Location ids | text |
States | object |
Last visits | object |
Created | date |
Updated | date |
Created by | text |
Updated by | text |
Metadata | object |
| Field | Type |
|---|---|
CustomerRequired | choice |
| Field | Type |
|---|---|
Note ID | text |
Location ID | text |
Visit ID | text |
Content | text |
Created by | text |
Created by name | text |
Updated by | text |
Updated by name | text |
Created | date |
Updated | date |
| Field | Type |
|---|---|
Location IDRequired | choice |
Message TypeRequired | text |
| Field | Type |
|---|---|
Short | text |
Subject | text |
Body | text |
Push | text |
White label | boolean |
ID | text |
Created | date |
Updated | date |
Created by | text |
Updated by | text |
Location ID | text |
Message type | text |
Language | text |
| Field | Type |
|---|---|
Location ID or Short NameRequired | choice |
| Field | Type |
|---|---|
Address | object |
City | text |
Country | object |
State | object |
Street | text |
Street 2 | text |
Zip | text |
Allow est wait to exceed hours | boolean |
Assigned plugins | array |
Booking allow overbooking | boolean |
Booking hours | object |
Mon | object |
Tue | object |
Wed | object |
Thu | object |
Fri | object |
Sat | object |
Sun | object |
Booking hours by date | object |
Booking reject unknown customers | boolean |
Booking slot color | text |
Booking waitlist order | text |
Business name | text |
Business type | text |
Currency | text |
Customer search method | text |
Customer session overlap mode | text |
Default num servers | number |
Default visit order value | number |
Default serve duration | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
Message TypeRequired | text |
Include Languages | boolean |
| Field | Type |
|---|---|
Channels | array |
Conditions | array |
Trigger | object |
Type | text |
Value | array |
Schedule times | array |
Languages | object |
Short | array |
Subject | array |
Body | array |
Push | array |
Type | text |
| Field | Type |
|---|---|
Message IDRequired | choice |
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
| Field | Type |
|---|---|
User IDRequired | choice |
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
| Field | Type |
|---|---|
Invite IDRequired | choice |
| Field | Type |
|---|---|
User ID | number |
Email address | |
Name | text |
| Field | Type |
|---|---|
VisitRequired | choice |
| Field | Type |
|---|---|
Results | array |
Limit | number |
Start at | text |
End at | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
From Date | text |
To Date | text |
Visit State | choice |
Tag | choice |
Customer ID | choice |
External Customer ID | text |
Service ID | choice |
Resource ID | choice |
| Field | Type |
|---|---|
Format | choice |
Location ID | choice |
From Date | date |
To Date | date |
| Field | Type |
|---|---|
Location ids | text |
From date | date |
To date | date |
Timezone | text |
Overall | object |
Num visits | number |
Num waitlisted | number |
Num bookings made | number |
Num bookings | number |
Num no showed | number |
Num served | number |
Num completed | number |
Num cancelled | number |
Num removed | number |
Num check ins | number |
Locations | array |
Resources | array |
Services | array |
Data fields | array |
Party sizes | array |
Users | array |
| Field | Type |
|---|---|
Location | choice |
From Date | date |
To Date | date |
| Field | Type |
|---|---|
Location ids | text |
From date | date |
To date | date |
Timezone | text |
Dates | array |
| Field | Type |
|---|---|
Format | choice |
Location | choice |
From Date | date |
To Date | date |
| Field | Type |
|---|---|
Period | text |
Business name | text |
Account ID | text |
Location name | text |
Location short name | text |
Location ID | text |
Num visits | number |
Num bookings made | number |
Num bookings | number |
Served visits | number |
Completed visits | number |
No showed visits | number |
Cancelled visits | number |
Removed visits | number |
Unique customers | number |
Num customers | number |
Serve ratio | number |
| Field | Type |
|---|---|
Location | choice |
From Date | date |
To Date | date |
Number of Buckets | number |
Bucket Size (Seconds) | number |
| Field | Type |
|---|---|
Location ids | text |
From date | date |
To date | date |
Timezone | text |
Durations | array |
| Field | Type |
|---|---|
Limit | number |
Location | choice |
Event | text |
Entity Type | choice |
Entity ID | text |
From Date | date |
To Date | date |
Descending Order | boolean |
| Field | Type |
|---|---|
Audit Entry ID | text |
Request ID | text |
Method | text |
URL | text |
User | object |
ID | text |
Impersonator ID | text |
Remote IP | text |
Country | text |
Region | text |
City | text |
User agent | text |
Email | text |
Auth provider ID | text |
Entity | object |
ID | text |
Type | text |
Organization ID | text |
Account ID | text |
Location ID | text |
Event | text |
Info | array |
Changes | array |
Created | date |
| Field | Type |
|---|---|
Location IDRequired | choice |
From Date | text |
To Date | text |
Show Off Hours | boolean |
Show Removed | boolean |
Show Pending | boolean |
Show Draft | boolean |
Show Rejected | boolean |
Resource IDs | choice |
Service IDs | choice |
Show Bookings | boolean |
Show Services | boolean |
Show Details | boolean |
Ignore Visit ID | text |
Service Duration (seconds) | number |
Minimum Available Spots | number |
Public Slots Only | boolean |
| Field | Type |
|---|---|
Date | date |
Duration | number |
Is within hours | boolean |
Num spots by resource ID | object |
Num spots by service ID | object |
Num booked spots by resource ID | object |
Num booked spots by service ID | object |
Num available spots by resource ID | object |
Num available spots by service ID | object |
Num spots | number |
Num booked spots | number |
Num available spots | number |
Bookings | array |
| Field | Type |
|---|---|
CustomerRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Note ID | text |
Location ID | text |
Visit ID | text |
Content | text |
Created by | text |
Created by name | text |
Updated by | text |
Updated by name | text |
Created | date |
Updated | date |
| Field | Type |
|---|---|
Location | choice |
External ID | text |
From Date | date |
To Date | date |
Descending Order | boolean |
Limit | number |
| Field | Type |
|---|---|
Customer ID | text |
External ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Notes | text |
Tags | array |
Location ids | text |
States | object |
Last visits | object |
Created | date |
Updated | date |
Created by | date |
Updated by | date |
Metadata | object |
| Field | Type |
|---|---|
Location IDRequired | choice |
From Date | text |
To Date | text |
Max Number of Dates | number |
Resource IDs | choice |
Service IDs | choice |
Public Dates Only | boolean |
Limit | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
From Date | text |
To Date | text |
Max Number of Slots | number |
Party Size | number |
Resource IDs | choice |
Service IDs | choice |
Show Bookings | boolean |
Show Details | boolean |
Ignore Visit ID | text |
Service Duration (seconds) | number |
Public Slots Only | boolean |
Slot Mode | choice |
Limit | number |
| Field | Type |
|---|---|
Date | date |
Duration | number |
Is within hours | boolean |
Num spots by resource ID | object |
Num spots by service ID | object |
Num booked spots by resource ID | object |
Num booked spots by service ID | object |
Num available spots by resource ID | object |
Num available spots by service ID | object |
Num spots | number |
Num booked spots | number |
Num available spots | number |
Bookings | array |
| Field | Type |
|---|---|
Location IDRequired | choice |
Include Languages | boolean |
Limit | number |
| Field | Type |
|---|---|
Channels | array |
Conditions | array |
Trigger | object |
Type | text |
Value | array |
Schedule times | array |
Languages | object |
Short | array |
Subject | array |
Body | array |
Push | array |
Type | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Message Type | text |
Language | choice |
Descending Order | boolean |
Maximum Results | number |
| Field | Type |
|---|---|
Short | text |
Subject | text |
Body | text |
Push | text |
White label | boolean |
ID | text |
Created | date |
Updated | date |
Created by | text |
Updated by | text |
Location ID | text |
Message type | text |
Language | text |
| Field | Type |
|---|---|
Limit | number |
External ID | text |
Country Code | text |
Descending Order | boolean |
| Field | Type |
|---|---|
Address | object |
City | text |
Country | object |
State | object |
Street | text |
Street 2 | text |
Zip | text |
Allow est wait to exceed hours | boolean |
Assigned plugins | array |
Booking allow overbooking | boolean |
Booking hours | object |
Mon | object |
Tue | object |
Wed | object |
Thu | object |
Fri | object |
Sat | object |
Sun | object |
Booking hours by date | object |
Booking reject unknown customers | boolean |
Booking slot color | text |
Booking waitlist order | text |
Business name | text |
Business type | text |
Currency | text |
Customer search method | text |
Customer session overlap mode | text |
Default num servers | number |
Default visit order value | number |
Default serve duration | number |
| Field | Type |
|---|---|
Limit | number |
Location ID | choice |
Message State | choice |
Visit ID | choice |
Customer ID | choice |
External Customer ID | text |
From Date | date |
To Date | date |
Descending Order | boolean |
| Field | Type |
|---|---|
Name | text |
Email | |
Phone | text |
Default location ID | text |
Location ids | text |
Roles | array |
Resource ID | text |
Message ID | text |
Business name | text |
Account ID | text |
Created | date |
Created by | text |
Updated by | text |
| Field | Type |
|---|---|
Limit | number |
Location ID | choice |
Descending Order | boolean |
| Field | Type |
|---|---|
Name | text |
Email | |
Phone | text |
Default location ID | text |
Location ids | text |
Roles | array |
Resource ID | text |
ID | text |
Business name | text |
Account ID | text |
Created | date |
Created by | text |
Updated by | text |
| Field | Type |
|---|---|
Limit | number |
Location IDs | choice |
Labels | array |
Roles | array |
External ID | text |
Search Query | text |
Descending Order | boolean |
| Field | Type |
|---|---|
User ID | text |
Account ID | text |
Organization ID | text |
Name | text |
Email | |
Phone | text |
Photo URL | text |
Default location ID | text |
Location ids | text |
Roles | array |
Password | text |
Notifications | object |
Arrived | object |
Booked | object |
Waiting | object |
Rescheduled | object |
Serving | object |
Complete | object |
Cancelled | object |
No show | object |
Removed | object |
Alerted | object |
Reports | object |
Performance | array |
Messaging tokens | array |
Created | date |
Updated | date |
Created by | text |
| Field | Type |
|---|---|
Maximum number of visits | number |
Location ID | choice |
Visit State | choice |
From Date | date |
To Date | date |
| Field | Type |
|---|---|
Results | array |
Limit | number |
Start at | text |
End at | text |
| Field | Type |
|---|---|
Limit | number |
Location | choice |
Visit State | choice |
Tag | text |
Search Query | text |
From Date | date |
To Date | date |
| Field | Type |
|---|---|
Customer ID | text |
External ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Notes | text |
Tags | array |
Location ids | text |
States | object |
Last visits | object |
Created | date |
Updated | date |
Created by | text |
Updated by | text |
Metadata | object |
| Field | Type |
|---|---|
EmailRequired | text |
Maximum number of users | number |
| Field | Type |
|---|---|
User ID | text |
Account ID | text |
Organization ID | text |
Name | text |
Email | |
Phone | text |
Photo URL | text |
Default location ID | text |
Location ids | text |
Roles | array |
Password | text |
Notifications | object |
Arrived | object |
Booked | object |
Waiting | object |
Rescheduled | object |
Serving | object |
Complete | object |
Cancelled | object |
No show | object |
Removed | object |
Alerted | object |
Reports | object |
Performance | array |
Messaging tokens | array |
Created | date |
Updated | date |
Created by | text |
| Field | Type |
|---|---|
Location ID | choice |
Visit State | choice |
Tag | choice |
Exclude Tags | array |
Search Query | text |
Limit | number |
| Field | Type |
|---|---|
Visit ID | text |
Location ID | text |
Type | text |
Customer ID | text |
External ID | text |
External customer ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Messaging tokens | array |
Live activity token | object |
Fcm token | text |
Apns token | text |
Notes | text |
Session series ID | text |
Service ids | array |
Resource ids | array |
Actions
| Field | Type |
|---|---|
VisitsRequired | array |
Suppress Messages | boolean |
Resend Messages | boolean |
| Field | Type |
|---|---|
Visit ID | text |
Location ID | text |
Type | text |
Customer ID | text |
External ID | text |
External customer ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Messaging tokens | array |
Live activity token | object |
Fcm token | text |
Apns token | text |
Notes | text |
Session series ID | text |
Service ids | array |
Resource ids | array |
| Field | Type |
|---|---|
Name | text |
First Name | text |
Last Name | text |
Phone Number | text |
Email | text |
Notes | text |
Tags | array |
Location IDs | array |
Add Tags | array |
Remove Tags | array |
Metadata | array |
External ID | text |
| Field | Type |
|---|---|
Customer ID | text |
External ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Notes | text |
Tags | array |
Location ids | text |
States | object |
Last visits | object |
Created | date |
Updated | date |
Created by | text |
Updated by | text |
Metadata | object |
| Field | Type |
|---|---|
CustomerRequired | choice |
Note Content | text |
Location | choice |
Visit ID | choice |
| Field | Type |
|---|---|
Note ID | text |
Location ID | text |
Visit ID | text |
Content | text |
Created by | text |
Created by name | text |
Updated by | text |
Updated by name | text |
Created | date |
Updated | date |
| Field | Type |
|---|---|
Location ID | choice |
Location NameRequired | text |
Short Name | text |
External ID | text |
Copy From Location | choice |
Include Users | boolean |
Include Resources | choice |
Include Services | choice |
Include Data Fields | choice |
Include Labels | boolean |
Make Default Location | boolean |
Business Name | text |
Display Name | text |
Email | |
Email Reply-To | |
Phone | text |
Website | text |
| Field | Type |
|---|---|
Address | object |
City | text |
Country | object |
State | object |
Street | text |
Street 2 | text |
Zip | text |
Allow est wait to exceed hours | boolean |
Assigned plugins | array |
Booking allow overbooking | boolean |
Booking hours | object |
Mon | object |
Tue | object |
Wed | object |
Thu | object |
Fri | object |
Sat | object |
Sun | object |
Booking hours by date | object |
Booking reject unknown customers | boolean |
Booking slot color | text |
Booking waitlist order | text |
Business name | text |
Business type | text |
Currency | text |
Customer search method | text |
Customer session overlap mode | text |
Default num servers | number |
Default visit order value | number |
Default serve duration | number |
| Field | Type |
|---|---|
User ID | text |
NameRequired | text |
EmailRequired | text |
Phone | text |
Photo URL | url |
PasswordRequired | secret |
Default Location IDRequired | text |
Location IDsRequired | choice |
RolesRequired | array |
Job Level | choice |
Notifications | object |
arrived | object |
booked | object |
waiting | object |
rescheduled | object |
serving | object |
complete | object |
cancelled | object |
noShow | object |
removed | object |
alerted | object |
Language | choice |
Locale | choice |
Skip Onboarding | boolean |
External ID | text |
Metadata | array |
| Field | Type |
|---|---|
User ID | text |
Account ID | text |
Organization ID | text |
Name | text |
Email | |
Phone | text |
Photo URL | url |
Default location ID | text |
Location ids | text |
Roles | array |
Password | text |
Notifications | object |
Arrived | object |
Booked | object |
Waiting | object |
Rescheduled | object |
Serving | object |
Complete | object |
Cancelled | object |
No show | object |
Removed | object |
Alerted | object |
Reports | object |
Performance | array |
Messaging tokens | array |
Created | date |
Updated | date |
Created by | text |
| Field | Type |
|---|---|
NameRequired | text |
EmailRequired | |
Phone Number | text |
Default Location ID | text |
LocationsRequired | choice |
RolesRequired | array |
Resource ID | choice |
Send Invitation Email | boolean |
| Field | Type |
|---|---|
Name | text |
Email | |
Phone | text |
Default location ID | text |
Location ids | text |
Roles | array |
Resource ID | text |
ID | text |
Business name | text |
Account ID | text |
Created | date |
Created by | text |
Updated by | text |
| Field | Type |
|---|---|
Visit ID | choice |
Visit IDs | choice |
Target VisitRequired | object |
Target Location IDRequired | choice |
Target Visit State | choice |
Complete Original Visit | boolean |
Suppress Messages | boolean |
Resend Messages | boolean |
| Field | Type |
|---|---|
Visit ID | text |
Location ID | text |
Type | text |
Customer ID | text |
External ID | text |
External customer ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Messaging tokens | array |
Live activity token | object |
Fcm token | text |
Apns token | text |
Notes | text |
Session series ID | text |
Service ids | array |
Resource ids | array |
| Field | Type |
|---|---|
Location IDRequired | choice |
Message TypeRequired | text |
Short Message | text |
Subject | text |
Message Body | text |
Push Message | text |
White Label | boolean |
| Field | Type |
|---|---|
Short | text |
Subject | text |
Body | text |
Push | text |
White label | boolean |
ID | text |
Created | date |
Updated | date |
Created by | text |
Updated by | text |
Location ID | text |
Message type | text |
Language | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Message TypeRequired | text |
Channels | array |
Trigger | object |
typeRequired | choice |
valueRequired | array |
scheduleTimes | array |
Conditions | array |
Languages | object |
short | array |
subject | array |
body | array |
push | array |
| Field | Type |
|---|---|
Channels | array |
Conditions | array |
Trigger | object |
Type | text |
Value | array |
Schedule times | array |
Languages | object |
Short | array |
Subject | array |
Body | array |
Push | array |
Type | text |
| Field | Type |
|---|---|
Visit ID | choice |
Location ID | choice |
Customer ID | choice |
External Customer ID | text |
Customer Name | text |
First Name | text |
Last Name | text |
Email | |
Phone | text |
Add Messaging Tokens | array |
Remove Messaging Tokens | array |
Live Activity Token | object |
fcmToken | text |
apnsToken | text |
Session Series ID | text |
Service IDs | choice |
Resource IDs | choice |
Data Fields | array |
Party Size | number |
| Field | Type |
|---|---|
Visit ID | text |
Location ID | text |
Type | text |
Customer ID | text |
External ID | text |
External customer ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Messaging tokens | array |
Live activity token | object |
Fcm token | text |
Apns token | text |
Notes | text |
Session series ID | text |
Service ids | array |
Resource ids | array |
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
CustomerRequired | choice |
Note IDRequired | text |
| Field | Type |
|---|---|
Status code | number |
Message | text |
Error | text |
Error code | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
Message TypeRequired | text |
| Field | Type |
|---|---|
Location IDRequired | choice |
| Field | Type |
|---|---|
User IDRequired | choice |
| Field | Type |
|---|---|
Visit ID | choice |
| Field | Type |
|---|---|
Location IDRequired | choice |
Message TypeRequired | text |
| Field | Type |
|---|---|
Visit IDsRequired | choice |
| Field | Type |
|---|---|
Export Format | choice |
Location ID | choice |
From Date | date |
To Date | date |
Date Range Field | choice |
| Field | Type |
|---|---|
CSV FileRequired | file |
Import Type | choice |
Location | choice |
| Field | Type |
|---|---|
Import FileRequired | file |
Import Type | choice |
Location ID | choice |
Visit State | choice |
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
EmailRequired | |
Recaptcha Response | text |
| Field | Type |
|---|---|
Name | text |
Email | |
Phone | text |
Default location ID | text |
Location ids | text |
Roles | array |
Resource ID | text |
ID | text |
Business name | text |
Account ID | text |
Created | date |
Created by | text |
Updated by | text |
| Field | Type |
|---|---|
Invite IDRequired | choice |
| Field | Type |
|---|---|
Location IDRequired | choice |
Clear Waiting Visits | boolean |
Clear Booked Visits | boolean |
Clear Serving Visits | boolean |
Clear Completed Visits | boolean |
Clear Customers | boolean |
Clear Analytics | boolean |
Reset Settings | boolean |
Reset Wait Estimation | boolean |
| Field | Type |
|---|---|
Customer IDRequired | choice |
Name | text |
First Name | text |
Last Name | text |
Phone Number | text |
Email | |
Notes | text |
Tags | array |
Location IDs | choice |
Add Tags | array |
Remove Tags | array |
Metadata | array |
| Field | Type |
|---|---|
Customer ID | text |
External ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Notes | text |
Tags | array |
Location ids | text |
States | object |
Last visits | object |
Created | date |
Updated | date |
Created by | text |
Updated by | text |
Metadata | object |
| Field | Type |
|---|---|
CustomerRequired | choice |
Note IDRequired | text |
Note Content | text |
| Field | Type |
|---|---|
Note ID | text |
Location ID | text |
Visit ID | text |
Content | text |
Created by | text |
Created by name | text |
Updated by | text |
Updated by name | text |
Created | date |
Updated | date |
| Field | Type |
|---|---|
Location IDRequired | choice |
name | text |
shortName | text |
displayName | text |
externalId | text |
isActive | boolean |
email | |
emailReplyToAddress | text |
phone | text |
website | url |
logoUrl | url |
publicLogoUrl | url |
customStyleUrl | url |
publicStyleUrl | url |
Address | object |
street | text |
street2 | text |
city | text |
state | object |
zip | text |
country | object |
coordinates | object |
timezone | text |
| Field | Type |
|---|---|
Address | object |
City | text |
Country | object |
State | object |
Street | text |
Street 2 | text |
Zip | text |
Allow est wait to exceed hours | boolean |
Assigned plugins | array |
Booking allow overbooking | boolean |
Booking hours | object |
Mon | object |
Tue | object |
Wed | object |
Thu | object |
Fri | object |
Sat | object |
Sun | object |
Booking hours by date | object |
Booking reject unknown customers | boolean |
Booking slot color | text |
Booking waitlist order | text |
Business name | text |
Business type | text |
Currency | text |
Customer search method | text |
Customer session overlap mode | text |
Default num servers | number |
Default visit order value | number |
Default serve duration | number |
| Field | Type |
|---|---|
Location IDRequired | choice |
Force Open | boolean |
Force Closed | boolean |
| Field | Type |
|---|---|
Address | object |
City | text |
Country | object |
State | object |
Street | text |
Street 2 | text |
Zip | text |
Allow est wait to exceed hours | boolean |
Assigned plugins | array |
Booking allow overbooking | boolean |
Booking hours | object |
Mon | object |
Tue | object |
Wed | object |
Thu | object |
Fri | object |
Sat | object |
Sun | object |
Booking hours by date | object |
Booking reject unknown customers | boolean |
Booking slot color | text |
Booking waitlist order | text |
Business name | text |
Business type | text |
Currency | text |
Customer search method | text |
Customer session overlap mode | text |
Default num servers | number |
Default visit order value | number |
Default serve duration | number |
| Field | Type |
|---|---|
MessageRequired | choice |
Mark as ReadRequired | boolean |
| Field | Type |
|---|---|
Message ID | text |
Type | text |
Channel | text |
Is incoming | boolean |
Sender | text |
Recipient | text |
Sender name | text |
Recipient name | text |
Subject | text |
Body | text |
Substitutions | object |
Template ID | text |
Location ID | text |
Customer ID | text |
Visit ID | text |
External ID | text |
Provider ID | text |
| Field | Type |
|---|---|
User ID | choice |
NameRequired | text |
EmailRequired | |
Phone | text |
Photo URL | url |
PasswordRequired | secret |
Default Location IDRequired | text |
Location IDsRequired | choice |
RolesRequired | array |
Job Level | choice |
Notifications | object |
arrived | object |
booked | object |
waiting | object |
rescheduled | object |
serving | object |
complete | object |
cancelled | object |
noShow | object |
removed | object |
alerted | object |
Language | choice |
Locale | choice |
Skip Onboarding | boolean |
External ID | text |
Metadata | array |
| Field | Type |
|---|---|
User ID | text |
Account ID | text |
Organization ID | text |
Name | text |
Email | |
Phone | text |
Photo URL | url |
Default location ID | text |
Location ids | text |
Roles | array |
Password | text |
Notifications | object |
Arrived | object |
Booked | object |
Waiting | object |
Rescheduled | object |
Serving | object |
Complete | object |
Cancelled | object |
No show | object |
Removed | object |
Alerted | object |
Reports | object |
Performance | array |
Messaging tokens | array |
Created | date |
Updated | date |
Created by | text |
| Field | Type |
|---|---|
Visit ID | choice |
Location ID | choice |
Customer ID | choice |
External Customer ID | text |
Customer Name | text |
First Name | text |
Last Name | text |
Email | |
Phone | text |
Add Messaging Tokens | array |
Remove Messaging Tokens | array |
Live Activity Token | object |
fcmToken | text |
apnsToken | text |
Session Series ID | text |
Service IDs | choice |
Resource IDs | choice |
Data Fields | array |
Party Size | number |
| Field | Type |
|---|---|
Visit ID | text |
Location ID | text |
Type | text |
Customer ID | text |
External ID | text |
External customer ID | text |
Name | text |
First name | text |
Last name | text |
Phone | text |
Email | |
Messaging tokens | array |
Live activity token | object |
Fcm token | text |
Apns token | text |
Notes | text |
Session series ID | text |
Service ids | array |
Resource ids | array |

