About this integration
Client engagement platform for online scheduling, payments, and customer communications.
There are 1 trigger, 19 search modules and 19 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 | In order to receive your unique token, please contact [email protected] or contact your account manager. |
Use it in workflow automation
Start with Watch Events, then add Cancel a Booking.
The canvas below runs Watch Events into Cancel a Booking — watch the video, then drop a node onto the canvas.
Select the Watch Events trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Create an Event Waitlist as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 20 ready-made modules for scheduling work — each run logs its inputs and outputs for debugging.
vCita workflow on the canvas: Watch Events then Create an Event Waitlist
Triggers, searches and actions
Open any vCita trigger, search, or action to see its inputs and outputs — 1 trigger, 19 searchs, 19 actions.
Triggers
Use one of 1 trigger to kick off a workflow as soon as an event occurs in the app.
- Watch Events
Searches
This integration includes 19 search modules for looking data up mid-run.
- Get a Business
- Get a Client
- Get an Appointment
- Get an Invoice
- Get Appointments
Actions
Take action during a run with 19 available modules that write data back into the app.
- Cancel a Booking
- Cancel a Waitlist Registration
- Create a Booking
- Create a Business
- Create a Client
Explore the fields available for each vCita trigger, search, and action.
Triggers
No fields documented.
Searches
| Field | Type |
|---|---|
Business IDRequired | text |
| Field | Type |
|---|---|
Admin account | object |
Country name | text |
Display name | text |
Email | text |
First name | text |
Language | text |
Last name | text |
Phone | text |
Staff uid | text |
User ID | text |
Business | object |
Account blocked at | date |
Address | text |
Business category | text |
Business maturity in years | text |
Country name | text |
Dedicated number | text |
Hide address | text |
ID | text |
Landing page | text |
Name | text |
Integrations | object |
Plugins | array |
Meta | object |
Auth token | text |
Booking settings | object |
Branding | object |
External ID | text |
External reference ID | text |
Identities | array |
In setup | text |
Intents | array |
Is template | text |
Marketing channel | text |
| Field | Type |
|---|---|
Client IDRequired | choice |
| Field | Type |
|---|---|
Address | text |
Business uid | text |
Campaign | text |
Channel | text |
Created at | date |
Custom field 1 | text |
Custom field 2 | text |
Custom field 3 | text |
Customer status | text |
Email | text |
First name | text |
ID | text |
Last name | text |
Mobile phone | text |
Normalized phone | text |
Opt in | text |
Source | text |
Source URL | text |
Tags | array |
Updated at | date |
| Field | Type |
|---|---|
Appointment IDRequired | choice |
| Field | Type |
|---|---|
Approval mode | text |
Business uid | text |
Category name | text |
Charge type | text |
Client color ID | number |
Client first name | text |
Client ID | text |
Client last name | text |
Conversation ID | text |
Created at | date |
Currency | text |
Duration | number |
End time | date |
ID | text |
Image URL | text |
Initiator | text |
Interaction details | text |
Interaction type | text |
Is recurring | boolean |
Linked booking uid | text |
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
Address | text |
Allow online payment | boolean |
Amount | number |
Client ID | text |
Conversation ID | text |
Created at | date |
Currency | text |
Due date | text |
ID | text |
Invoice number | text |
Issued at | text |
Items | array |
Note | text |
Payment balance | number |
Payment state | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Status | text |
Title | text |
| Field | Type |
|---|---|
Client ID | choice |
Business ID | text |
State | choice |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
Approval mode | text |
Business uid | text |
Category name | text |
Charge type | text |
Client color ID | number |
Client first name | text |
Client ID | text |
Client last name | text |
Conversation ID | text |
Created at | date |
Currency | text |
Duration | number |
End time | date |
ID | text |
Image URL | text |
Initiator | text |
Interaction details | text |
Interaction type | text |
Is recurring | boolean |
Linked booking uid | text |
| Field | Type |
|---|---|
Service IDRequired | choice |
Extra Decorator Fields | boolean |
| Field | Type |
|---|---|
Booking restriction | object |
Is client restricted | boolean |
Restricted client statuses | array |
Restriction rule text | text |
Uid | text |
Charge type | text |
Currency | text |
Description | text |
Duration | number |
ID | text |
Image path | text |
Interaction type | text |
Name | text |
Price | number |
Type | text |
| Field | Type |
|---|---|
Business IDRequired | text |
| Field | Type |
|---|---|
Active | text |
Blocked at | text |
Business role display name | text |
Deleted | text |
Display name | text |
Email | text |
First name | text |
ID | text |
Invite sent | text |
Last name | text |
Mobile number | text |
Photo | text |
Photo path | text |
Professional title | text |
Role | text |
| Field | Type |
|---|---|
Business IDRequired | text |
Matter UID | text |
Passed | text |
Start Time | time |
End Time | time |
Limit | number |
| Field | Type |
|---|---|
Approval mode | text |
Business uid | text |
Category name | text |
Charge type | text |
Client color ID | number |
Client first name | text |
Client ID | text |
Client last name | text |
Conversation ID | text |
Created at | date |
Currency | text |
Duration | number |
End time | date |
ID | text |
Image URL | text |
Initiator | text |
Interaction details | text |
Interaction type | text |
Is recurring | boolean |
Linked booking uid | text |
| Field | Type |
|---|---|
Email | text |
External Reference ID | text |
External ID | text |
| Field | Type |
|---|---|
Businesses | array |
| Field | Type |
|---|---|
Client IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Address | text |
Amount | number |
Client address | text |
Client ID | text |
Client name | text |
Conversation ID | text |
Created at | date |
Currency | text |
Due date | text |
Estimate date | text |
Estimate number | text |
ID | text |
Items | array |
Note | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Status | text |
Title | text |
| Field | Type |
|---|---|
Client IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Address | text |
Allow online payment | boolean |
Amount | number |
Client ID | text |
Conversation ID | text |
Created at | date |
Currency | text |
Due date | text |
ID | text |
Invoice number | text |
Issued at | text |
Items | array |
Note | text |
Payment balance | number |
Payment state | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Status | text |
Title | text |
| Field | Type |
|---|---|
Client IDRequired | choice |
Limit | number |
| Field | Type |
|---|---|
Amount | number |
Charged at | text |
Client ID | text |
Conversation ID | text |
Currency | text |
Fees | array |
ID | text |
Note | text |
Offline | boolean |
Other payment method | text |
Payment method | text |
Payment requests | array |
Reference | text |
State | text |
Tips | array |
Title | text |
| Field | Type |
|---|---|
Search TermRequired | text |
Search ByRequired | choice |
Updated At | text |
Limit | number |
| Field | Type |
|---|---|
Address | text |
Business uid | text |
Campaign | text |
Channel | text |
Created at | date |
Custom field 1 | text |
Custom field 2 | text |
Custom field 3 | text |
Customer status | text |
Email | text |
First name | text |
ID | text |
Last name | text |
Mobile phone | text |
Normalized phone | text |
Opt in | text |
Source | text |
Source URL | text |
Tags | array |
Updated at | date |
| Field | Type |
|---|---|
Filter | text |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
Address | text |
Amount | number |
Client address | text |
Client ID | text |
Client name | text |
Conversation ID | text |
Created at | date |
Currency | text |
Due date | text |
Estimate date | text |
Estimate number | text |
ID | text |
Items | array |
Note | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Status | text |
Title | text |
| Field | Type |
|---|---|
Filter | text |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
Address | text |
Allow online payment | boolean |
Amount | number |
Client ID | text |
Conversation ID | text |
Created at | date |
Currency | text |
Due date | text |
ID | text |
Invoice number | text |
Issued at | text |
Items | array |
Note | text |
Payment balance | number |
Payment state | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Status | text |
Title | text |
| Field | Type |
|---|---|
Filter | text |
Sort | text |
Limit | number |
| Field | Type |
|---|---|
Amount | number |
Charged at | text |
Client ID | text |
Conversation ID | text |
Currency | text |
Fees | array |
ID | text |
Note | text |
Offline | boolean |
Other payment method | text |
Payment method | text |
Payment requests | array |
Reference | text |
State | text |
Tips | array |
Title | text |
| Field | Type |
|---|---|
Business IDRequired | text |
Staff UIDs Array | array |
Add | text |
Has Future Instance | boolean |
Include Hidden | boolean |
Active Staff Only | boolean |
Extra Decorator Fields | boolean |
Name | text |
Charge Type | text |
Order By | text |
Limit | number |
| Field | Type |
|---|---|
Auto follow up hours | number |
Booking restriction | object |
Is client restricted | boolean |
Restricted client statuses | array |
Restriction rule text | text |
Uid | text |
Charge type | text |
Currency | text |
Default staff | text |
Description | text |
Duration | number |
Future bookings limit | number |
ID | text |
Image path | text |
Interaction type | text |
Meeting reminder sms 1 | boolean |
Meeting reminder sms 2 | boolean |
Min hours before meeting | number |
Name | text |
Order | number |
Padding | number |
Price | number |
Remind before in hours 1 | number |
Remind before in hours 2 | number |
| Field | Type |
|---|---|
Business IDRequired | text |
Staff UIDs Array | array |
Add | text |
Has Future Instance | boolean |
Include Hidden | boolean |
Active Staff Only | boolean |
Extra Decorator Fields | boolean |
Name | text |
Charge Type | text |
Order By | text |
Limit | number |
| Field | Type |
|---|---|
Auto follow up hours | number |
Booking restriction | object |
Is client restricted | boolean |
Restricted client statuses | array |
Restriction rule text | text |
Uid | text |
Charge type | text |
Currency | text |
Default staff | text |
Description | text |
Duration | number |
Future bookings limit | number |
ID | text |
Image path | text |
Interaction type | text |
Meeting reminder sms 1 | boolean |
Meeting reminder sms 2 | boolean |
Min hours before meeting | number |
Name | text |
Order | number |
Padding | number |
Price | number |
Remind before in hours 1 | number |
Remind before in hours 2 | number |
| Field | Type |
|---|---|
Business IDRequired | text |
Status | choice |
Limit | number |
| Field | Type |
|---|---|
Active | text |
Blocked at | text |
Business role display name | text |
Deleted | text |
Display name | text |
Email | text |
First name | text |
ID | text |
Invite sent | text |
Last name | text |
Mobile number | text |
Photo | text |
Photo path | text |
Professional title | text |
Role | text |
Actions
| Field | Type |
|---|---|
Booking IDRequired | choice |
Business IDRequired | text |
Event Instance ID | text |
| Field | Type |
|---|---|
Business ID | text |
Client ID | text |
Conversation ID | text |
Created at | date |
Duration | number |
Event instance ID | text |
ID | text |
Service ID | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Start time | text |
Status | text |
Time zone | text |
Title | text |
Type | text |
| Field | Type |
|---|---|
Business UidRequired | text |
Client Uid | choice |
Event Instance UID | text |
Matter Uid | text |
| Field | Type |
|---|---|
Client ID | number |
Created at | date |
Entity ID | number |
Entity type | text |
Event instance uid | text |
Initiator | text |
Matter | object |
Display name | text |
Uid | text |
Source ID | number |
Spot | number |
Staff uid | text |
Start time h | text |
State summary | object |
State | text |
State h | text |
Status | text |
Title | text |
Type | text |
Uid | text |
Where h | text |
| Field | Type |
|---|---|
Business IDRequired | text |
Campaign | text |
Channel | text |
Client ID | choice |
Event Instance ID | text |
Form Data | array |
KeyRequired | text |
ValueRequired | text |
Matter UID | text |
Portal ID | text |
Service ID | text |
Source Name | text |
Source URL | url |
Staff ID | choice |
Start Time | date |
Time Zone | time |
| Field | Type |
|---|---|
Business ID | text |
Client ID | text |
Conversation ID | text |
Created at | date |
Duration | number |
Event instance ID | text |
ID | text |
Service ID | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Start time | text |
Status | text |
Time zone | text |
Title | text |
Type | text |
| Field | Type |
|---|---|
Admin Account | object |
EmailRequired | |
Country Name | text |
Display Name | text |
First Name | text |
Last Name | text |
Language | choice |
Password | text |
Phone | text |
Business | object |
NameRequired | text |
Address | text |
Business Category | text |
Business Maturity in Years | choice |
Country Name | text |
Hide Address | boolean |
Landing Page | text |
Logo URL | url |
Phone | text |
Short Description | text |
Meta | object |
Analytics | object |
Audit | array |
External ID | text |
External Reference ID | text |
Identities | array |
In Setup | boolean |
Intents | array |
Invite | text |
Is Template | boolean |
Note | text |
| Field | Type |
|---|---|
Admin account | object |
Country name | text |
Display name | text |
Email | text |
First name | text |
Language | text |
Last name | text |
Phone | text |
Staff uid | text |
User ID | text |
Business | object |
Account blocked at | date |
Address | text |
Business category | text |
Business maturity in years | text |
Country name | text |
Dedicated number | text |
Hide address | text |
ID | text |
Landing page | text |
Name | text |
Integrations | object |
Plugins | array |
Meta | object |
Auth token | text |
Booking settings | object |
Branding | object |
External ID | text |
External reference ID | text |
Identities | array |
In setup | text |
Intents | array |
Is template | text |
Marketing channel | text |
| Field | Type |
|---|---|
Email | |
First Name | text |
Last Name | text |
Phone | text |
Address | text |
Opt-in Transactional SMS | boolean |
Custom Field 1 | text |
Custom Field 2 | text |
Custom Field 3 | text |
Source Campaign | text |
Source Channel | text |
Source Name | text |
Source URL | url |
Staff ID | text |
Status | text |
Tags | text |
| Field | Type |
|---|---|
Address | text |
Business uid | text |
Campaign | text |
Channel | text |
Created at | date |
Custom field 1 | text |
Custom field 2 | text |
Custom field 3 | text |
Customer status | text |
Email | text |
First name | text |
ID | text |
Last name | text |
Mobile phone | text |
Normalized phone | text |
Opt in | text |
Source | text |
Source URL | text |
Tags | array |
Updated at | date |
| Field | Type |
|---|---|
First NameRequired | text |
Identifier TypeRequired | choice |
Request TitleRequired | text |
Address | text |
Business ID | text |
Email | |
Last Name | text |
Message Data | array |
Notifications | choice |
Opt In | text |
Opt In Transactional SMS | boolean |
Phone | text |
Request Data | array |
Source | text |
Source URL | url |
Status | text |
System Message | text |
Tags | text |
Unique ID | text |
| Field | Type |
|---|---|
Conversation uid | text |
Status | text |
Uid | text |
| Field | Type |
|---|---|
Estimate TitleRequired | text |
AddressRequired | text |
Client IDRequired | choice |
CurrencyRequired | text |
Due DateRequired | date |
Estimate DateRequired | date |
ItemsRequired | array |
Note | text |
Send Email | boolean |
Client Address | text |
Client Name | text |
Conversation ID | text |
Estimate Number | number |
Source Campaign | text |
Source Channel | text |
Source Name | text |
Source URL | url |
Status | choice |
| Field | Type |
|---|---|
Address | text |
Amount | number |
Client address | text |
Client ID | text |
Client name | text |
Conversation ID | text |
Created at | date |
Currency | text |
Due date | text |
Estimate date | text |
Estimate number | text |
ID | text |
Items | array |
Note | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Status | text |
Title | text |
| Field | Type |
|---|---|
Business IDRequired | text |
Event Instance IDRequired | text |
Channel | text |
Client ID | choice |
Matter UID | text |
Source Name | text |
Source URL | url |
Time Zone | time |
| Field | Type |
|---|---|
Client ID | number |
Created at | date |
Entity ID | number |
Entity type | text |
Event instance uid | text |
Initiator | text |
Matter | object |
Display name | text |
Uid | text |
Source ID | number |
Spot | number |
Staff uid | text |
Start time h | text |
State summary | object |
State | text |
State h | text |
Status | text |
Title | text |
Type | text |
Uid | text |
Where h | text |
| Field | Type |
|---|---|
AddressRequired | text |
Client IDRequired | choice |
CurrencyRequired | text |
Due DateRequired | date |
Issued AtRequired | date |
ItemsRequired | array |
Allow Online Payment | boolean |
Conversation ID | text |
Invoice Number | number |
Note | text |
Send Email | boolean |
Source Campaign | text |
Source Channel | text |
Source Name | text |
Source URL | text |
Staff ID | text |
Status | choice |
Title | text |
| Field | Type |
|---|---|
Address | text |
Allow online payment | boolean |
Amount | number |
Client ID | text |
Conversation ID | text |
Created at | date |
Currency | text |
Due date | text |
ID | text |
Invoice number | text |
Issued at | text |
Items | array |
Note | text |
Payment balance | number |
Payment state | text |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
Staff ID | text |
Status | text |
Title | text |
| Field | Type |
|---|---|
TitleRequired | text |
AmountRequired | number |
Client IDRequired | choice |
CurrencyRequired | text |
Payment MethodRequired | choice |
Fees | array |
Mark As Online | boolean |
Other Payment Method | text |
Paid At | text |
Pay Key | text |
Payment Subject ID | text |
Payment Subject Type | choice |
Reference | text |
Send Receipt | boolean |
Staff ID | text |
State | choice |
Tips | array |
| Field | Type |
|---|---|
Amount | number |
Client ID | text |
Conversation ID | text |
Created at | date |
Currency | text |
Fees | array |
Marked as online | boolean |
Other payment method | text |
Paid at | text |
Paid offline | boolean |
Pay key | text |
Payment action | text |
Payment ID | text |
Payment method | text |
Reference | text |
Send receipt | boolean |
Staff ID | text |
State | text |
Tips | array |
Title | text |
| Field | Type |
|---|---|
Business IDRequired | text |
StaffRequired | object |
Display NameRequired | text |
EmailRequired | |
First Name | text |
Last Name | text |
Role | text |
Meta | object |
Invite | text |
| Field | Type |
|---|---|
Active | text |
Blocked at | text |
Business role display name | text |
Deleted | text |
Display name | text |
Email | text |
First name | text |
ID | text |
Invite sent | text |
Last name | text |
Mobile number | text |
Photo | text |
Photo path | text |
Professional title | text |
Role | text |
| Field | Type |
|---|---|
Client IDRequired | choice |
| Field | Type |
|---|---|
Address | text |
Business uid | text |
Campaign | text |
Channel | text |
Created at | date |
Custom field 1 | text |
Custom field 2 | text |
Custom field 3 | text |
Customer status | text |
Email | text |
First name | text |
ID | text |
Last name | text |
Mobile phone | text |
Normalized phone | text |
Opt in | text |
Source | text |
Source URL | text |
Tags | array |
Updated at | date |
| Field | Type |
|---|---|
Business IDRequired | text |
| 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 |
|---|---|
Payment IDRequired | choice |
Matter UIDRequired | text |
Payment Status UIDRequired | text |
| Field | Type |
|---|---|
Amount | number |
Client ID | text |
Conversation ID | text |
Created at | date |
Currency | text |
Marked as online | boolean |
Other payment method | text |
Paid at | text |
Paid offline | boolean |
Payment action | text |
Payment ID | text |
Payment method | text |
Reference | text |
Send receipt | boolean |
Source data | object |
Campaign | text |
Channel | text |
Name | text |
Website URL | text |
State | text |
| Field | Type |
|---|---|
From Client IDsRequired | choice |
To Client IDRequired | choice |
| Field | Type |
|---|---|
Business IDRequired | text |
Admin Account | object |
Email | |
Country Name | text |
Display Name | text |
First Name | text |
Last Name | text |
Language | choice |
Password | text |
Phone | text |
Business | object |
Name | text |
Address | text |
Business Category | text |
Business Maturity in Years | choice |
Country Name | text |
Hide Address | boolean |
Landing Page | text |
Logo URL | url |
Phone | text |
Short Description | text |
Meta | object |
Analytics | object |
Audit | array |
External ID | text |
External Reference ID | text |
Identities | array |
In Setup | boolean |
Intents | array |
Invite | text |
Is Template | boolean |
Note | text |
| Field | Type |
|---|---|
Admin account | object |
Country name | text |
Display name | text |
Email | text |
First name | text |
Language | text |
Last name | text |
Phone | text |
Staff uid | text |
User ID | text |
Business | object |
Account blocked at | date |
Address | text |
Business category | text |
Business maturity in years | text |
Country name | text |
Dedicated number | text |
Hide address | text |
ID | text |
Landing page | text |
Name | text |
Integrations | object |
Plugins | array |
Meta | object |
Auth token | text |
Booking settings | object |
Branding | object |
External ID | text |
External reference ID | text |
Identities | array |
In setup | text |
Intents | array |
Is template | text |
Marketing channel | text |
| Field | Type |
|---|---|
Client IDRequired | choice |
First Name | text |
Last Name | text |
Email | |
Address | text |
Phone | text |
Mobile Phone | text |
Force Nullifying | boolean |
Custom Field 1 | text |
Custom Field 2 | text |
Custom Field 3 | text |
Spam | boolean |
Staff ID | text |
Status | text |
Tags | text |
| Field | Type |
|---|---|
Address | text |
Business uid | text |
Campaign | text |
Channel | text |
Created at | date |
Custom field 1 | text |
Custom field 2 | text |
Custom field 3 | text |
Customer status | text |
Email | text |
First name | text |
ID | text |
Last name | text |
Mobile phone | text |
Normalized phone | text |
Opt in | text |
Source | text |
Source URL | text |
Tags | array |
Updated at | date |
| Field | Type |
|---|---|
Booking IDRequired | choice |
Appointment TypeRequired | choice |
Business IDRequired | text |
New RSVP StateRequired | choice |
| Field | Type |
|---|---|
Approval mode | text |
Category name | text |
Charge type | text |
Client ID | text |
Conversation ID | text |
Currency | text |
Depth | text |
Description | text |
Duration | number |
End time | text |
Image URL | text |
Interaction details | text |
Interaction type | text |
Invoice payment status uid | text |
Invoices | array |
Is recurring | boolean |
No show | boolean |
Notes | text |
Payable | boolean |
Payment | text |

