Skip to docs navigation

vCita integration guide

Verified

How to connect vCita to WEXTL and use its 1 trigger and 38 actions in your workflows. About vCita: Client engagement platform for online scheduling, payments, and customer communications.

  • 1 trigger
  • 19 searches
  • 19 actions
  • Instant (webhooks)
  • Auth: API key

AI-assisted documentation23 min read

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

Open vCita on WEXTL →
  • vCita
  • WEXTL
  • Acuity Scheduling
  • Agendize
  • Calendesk
  • Cal.com
  • AgendaPro
  • Avirato
  • Appointedd
  • BookingLayer
  • Bookwhen
  • Accelevents
  • Calenso
  • Checkfront
  • Bookster
  • Amenitiz
  • Amelia
  • Booxi
  • Betterez
  • Check Cherry
  • BookingPress
  • AddEvent
  • AxisRooms
  • Appointment Reminder
  • Boulevard
  • Cloudbeds
  • Anny Admin API
  • Cronofy
  • Bookeo
  • Calendly
  • Anny Customer API
  • BookedScheduler
  • API KeypasswordRequired

    In order to receive your unique token, please contact [email protected] or contact your account manager.[1]

  1. Log in to your WEXTL account, add the vCita node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your vCita account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

Trigger

No fields documented.

Get a Business

Action
Input fields[3]
FieldType
Business IDRequired
text
Output fields[3]
FieldType
Admin accountobject
Country nametext
Display nametext
Emailtext
First nametext
Languagetext
Last nametext
Phonetext
Staff uidtext
User IDtext
Businessobject
Account blocked atdate
Addresstext
Business categorytext
Business maturity in yearstext
Country nametext
Dedicated numbertext
Hide addresstext
IDtext
Landing pagetext
Nametext
Integrationsobject
Pluginsarray
Metaobject
Auth tokentext
Booking settingsobject
Brandingobject
External IDtext
External reference IDtext
Identitiesarray
In setuptext
Intentsarray
Is templatetext
Marketing channeltext

Get a Client

Action
Input fields[3]
FieldType
Client IDRequired
choice
Output fields[3]
FieldType
Addresstext
Business uidtext
Campaigntext
Channeltext
Created atdate
Custom field 1text
Custom field 2text
Custom field 3text
Customer statustext
Emailtext
First nametext
IDtext
Last nametext
Mobile phonetext
Normalized phonetext
Opt intext
Sourcetext
Source URLtext
Tagsarray
Updated atdate

Get a Service

Action
Input fields[3]
FieldType
Service IDRequired
choice
Extra Decorator Fieldsboolean
Output fields[3]
FieldType
Booking restrictionobject
Is client restrictedboolean
Restricted client statusesarray
Restriction rule texttext
Uidtext
Charge typetext
Currencytext
Descriptiontext
Durationnumber
IDtext
Image pathtext
Interaction typetext
Nametext
Pricenumber
Typetext

Get a Staff Member

Action
Input fields[3]
FieldType
Business IDRequired
text
Output fields[3]
FieldType
Activetext
Blocked attext
Business role display nametext
Deletedtext
Display nametext
Emailtext
First nametext
IDtext
Invite senttext
Last nametext
Mobile numbertext
Phototext
Photo pathtext
Professional titletext
Roletext

Get an Appointment

Action
Input fields[3]
FieldType
Appointment IDRequired
choice
Output fields[3]
FieldType
Approval modetext
Business uidtext
Category nametext
Charge typetext
Client color IDnumber
Client first nametext
Client IDtext
Client last nametext
Conversation IDtext
Created atdate
Currencytext
Durationnumber
End timedate
IDtext
Image URLtext
Initiatortext
Interaction detailstext
Interaction typetext
Is recurringboolean
Linked booking uidtext

17other output fields

Get an Invoice

Action
Input fields[3]
FieldType
Invoice IDRequired
choice
Output fields[3]
FieldType
Addresstext
Allow online paymentboolean
Amountnumber
Client IDtext
Conversation IDtext
Created atdate
Currencytext
Due datetext
IDtext
Invoice numbertext
Issued attext
Itemsarray
Notetext
Payment balancenumber
Payment statetext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Statustext
Titletext

Get Appointments

Search
Input fields[3]
FieldType
Client IDchoice
Business IDtext
Statechoice
Sorttext
Limitnumber
Output fields[3]
FieldType
Approval modetext
Business uidtext
Category nametext
Charge typetext
Client color IDnumber
Client first nametext
Client IDtext
Client last nametext
Conversation IDtext
Created atdate
Currencytext
Durationnumber
End timedate
IDtext
Image URLtext
Initiatortext
Interaction detailstext
Interaction typetext
Is recurringboolean
Linked booking uidtext

17other output fields

Get Bookings

Search
Input fields[3]
FieldType
Business IDRequired
text
Matter UIDtext
Passedtext
Start Timetime
End Timetime
Limitnumber
Output fields[3]
FieldType
Approval modetext
Business uidtext
Category nametext
Charge typetext
Client color IDnumber
Client first nametext
Client IDtext
Client last nametext
Conversation IDtext
Created atdate
Currencytext
Durationnumber
End timedate
IDtext
Image URLtext
Initiatortext
Interaction detailstext
Interaction typetext
Is recurringboolean
Linked booking uidtext

17other output fields

Get Businesses

Action
Input fields[3]
FieldType
Emailtext
External Reference IDtext
External IDtext
Output fields[3]
FieldType
Businessesarray

Get Client Estimates

Search
Input fields[3]
FieldType
Client IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Addresstext
Amountnumber
Client addresstext
Client IDtext
Client nametext
Conversation IDtext
Created atdate
Currencytext
Due datetext
Estimate datetext
Estimate numbertext
IDtext
Itemsarray
Notetext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Statustext
Titletext

Get Client Invoices

Search
Input fields[3]
FieldType
Client IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Addresstext
Allow online paymentboolean
Amountnumber
Client IDtext
Conversation IDtext
Created atdate
Currencytext
Due datetext
IDtext
Invoice numbertext
Issued attext
Itemsarray
Notetext
Payment balancenumber
Payment statetext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Statustext
Titletext

Get Client Payments

Search
Input fields[3]
FieldType
Client IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Amountnumber
Charged attext
Client IDtext
Conversation IDtext
Currencytext
Feesarray
IDtext
Notetext
Offlineboolean
Other payment methodtext
Payment methodtext
Payment requestsarray
Referencetext
Statetext
Tipsarray
Titletext

Get Clients

Search
Input fields[3]
FieldType
Search TermRequired
text
Search ByRequired
choice
Updated Attext
Limitnumber
Output fields[3]
FieldType
Addresstext
Business uidtext
Campaigntext
Channeltext
Created atdate
Custom field 1text
Custom field 2text
Custom field 3text
Customer statustext
Emailtext
First nametext
IDtext
Last nametext
Mobile phonetext
Normalized phonetext
Opt intext
Sourcetext
Source URLtext
Tagsarray
Updated atdate

Get Estimates

Search
Input fields[3]
FieldType
Filtertext
Sorttext
Limitnumber
Output fields[3]
FieldType
Addresstext
Amountnumber
Client addresstext
Client IDtext
Client nametext
Conversation IDtext
Created atdate
Currencytext
Due datetext
Estimate datetext
Estimate numbertext
IDtext
Itemsarray
Notetext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Statustext
Titletext

Get Invoices

Search
Input fields[3]
FieldType
Filtertext
Sorttext
Limitnumber
Output fields[3]
FieldType
Addresstext
Allow online paymentboolean
Amountnumber
Client IDtext
Conversation IDtext
Created atdate
Currencytext
Due datetext
IDtext
Invoice numbertext
Issued attext
Itemsarray
Notetext
Payment balancenumber
Payment statetext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Statustext
Titletext

Get Payments

Search
Input fields[3]
FieldType
Filtertext
Sorttext
Limitnumber
Output fields[3]
FieldType
Amountnumber
Charged attext
Client IDtext
Conversation IDtext
Currencytext
Feesarray
IDtext
Notetext
Offlineboolean
Other payment methodtext
Payment methodtext
Payment requestsarray
Referencetext
Statetext
Tipsarray
Titletext

Get Services

Search
Input fields[3]
FieldType
Business IDRequired
text
Staff UIDs Arrayarray
Addtext
Has Future Instanceboolean
Include Hiddenboolean
Active Staff Onlyboolean
Extra Decorator Fieldsboolean
Nametext
Charge Typetext
Order Bytext
Limitnumber
Output fields[3]
FieldType
Auto follow up hoursnumber
Booking restrictionobject
Is client restrictedboolean
Restricted client statusesarray
Restriction rule texttext
Uidtext
Charge typetext
Currencytext
Default stafftext
Descriptiontext
Durationnumber
Future bookings limitnumber
IDtext
Image pathtext
Interaction typetext
Meeting reminder sms 1boolean
Meeting reminder sms 2boolean
Min hours before meetingnumber
Nametext
Ordernumber
Paddingnumber
Pricenumber
Remind before in hours 1number
Remind before in hours 2number

3other output fields

Get Services by Category

Search
Input fields[3]
FieldType
Business IDRequired
text
Staff UIDs Arrayarray
Addtext
Has Future Instanceboolean
Include Hiddenboolean
Active Staff Onlyboolean
Extra Decorator Fieldsboolean
Nametext
Charge Typetext
Order Bytext
Limitnumber
Output fields[3]
FieldType
Auto follow up hoursnumber
Booking restrictionobject
Is client restrictedboolean
Restricted client statusesarray
Restriction rule texttext
Uidtext
Charge typetext
Currencytext
Default stafftext
Descriptiontext
Durationnumber
Future bookings limitnumber
IDtext
Image pathtext
Interaction typetext
Meeting reminder sms 1boolean
Meeting reminder sms 2boolean
Min hours before meetingnumber
Nametext
Ordernumber
Paddingnumber
Pricenumber
Remind before in hours 1number
Remind before in hours 2number

3other output fields

Get Staff Members

Search
Input fields[3]
FieldType
Business IDRequired
text
Statuschoice
Limitnumber
Output fields[3]
FieldType
Activetext
Blocked attext
Business role display nametext
Deletedtext
Display nametext
Emailtext
First nametext
IDtext
Invite senttext
Last nametext
Mobile numbertext
Phototext
Photo pathtext
Professional titletext
Roletext

Cancel a Booking

Action
Input fields[3]
FieldType
Booking IDRequired
choice
Business IDRequired
text
Event Instance IDtext
Output fields[3]
FieldType
Business IDtext
Client IDtext
Conversation IDtext
Created atdate
Durationnumber
Event instance IDtext
IDtext
Service IDtext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Start timetext
Statustext
Time zonetext
Titletext
Typetext

Cancel a Waitlist Registration

Action
Input fields[3]
FieldType
Business UidRequired
text
Client Uidchoice
Event Instance UIDtext
Matter Uidtext
Output fields[3]
FieldType
Client IDnumber
Created atdate
Entity IDnumber
Entity typetext
Event instance uidtext
Initiatortext
Matterobject
Display nametext
Uidtext
Source IDnumber
Spotnumber
Staff uidtext
Start time htext
State summaryobject
Statetext
State htext
Statustext
Titletext
Typetext
Uidtext
Where htext

Create a Booking

Action
Input fields[3]
FieldType
Business IDRequired
text
Campaigntext
Channeltext
Client IDchoice
Event Instance IDtext
Form Dataarray
KeyRequired
text
ValueRequired
text
Matter UIDtext
Portal IDtext
Service IDtext
Source Nametext
Source URLurl
Staff IDchoice
Start Timedate
Time Zonetime
Output fields[3]
FieldType
Business IDtext
Client IDtext
Conversation IDtext
Created atdate
Durationnumber
Event instance IDtext
IDtext
Service IDtext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Start timetext
Statustext
Time zonetext
Titletext
Typetext

Create a Business

Action
Input fields[3]
FieldType
Admin Accountobject
EmailRequired
email
Country Nametext
Display Nametext
First Nametext
Last Nametext
Languagechoice
Passwordtext
Phonetext
Businessobject
NameRequired
text
Addresstext
Business Categorytext
Business Maturity in Yearschoice
Country Nametext
Hide Addressboolean
Landing Pagetext
Logo URLurl
Phonetext
Short Descriptiontext
Metaobject
Analyticsobject
Auditarray
External IDtext
External Reference IDtext
Identitiesarray
In Setupboolean
Intentsarray
Invitetext
Is Templateboolean
Notetext
Output fields[3]
FieldType
Admin accountobject
Country nametext
Display nametext
Emailtext
First nametext
Languagetext
Last nametext
Phonetext
Staff uidtext
User IDtext
Businessobject
Account blocked atdate
Addresstext
Business categorytext
Business maturity in yearstext
Country nametext
Dedicated numbertext
Hide addresstext
IDtext
Landing pagetext
Nametext
Integrationsobject
Pluginsarray
Metaobject
Auth tokentext
Booking settingsobject
Brandingobject
External IDtext
External reference IDtext
Identitiesarray
In setuptext
Intentsarray
Is templatetext
Marketing channeltext

Create a Client

Action
Input fields[3]
FieldType
Emailemail
First Nametext
Last Nametext
Phonetext
Addresstext
Opt-in Transactional SMSboolean
Custom Field 1text
Custom Field 2text
Custom Field 3text
Source Campaigntext
Source Channeltext
Source Nametext
Source URLurl
Staff IDtext
Statustext
Tagstext
Output fields[3]
FieldType
Addresstext
Business uidtext
Campaigntext
Channeltext
Created atdate
Custom field 1text
Custom field 2text
Custom field 3text
Customer statustext
Emailtext
First nametext
IDtext
Last nametext
Mobile phonetext
Normalized phonetext
Opt intext
Sourcetext
Source URLtext
Tagsarray
Updated atdate

Create a Lead

Action
Input fields[3]
FieldType
First NameRequired
text
Identifier TypeRequired
choice
Request TitleRequired
text
Addresstext
Business IDtext
Emailemail
Last Nametext
Message Dataarray
Notificationschoice
Opt Intext
Opt In Transactional SMSboolean
Phonetext
Request Dataarray
Sourcetext
Source URLurl
Statustext
System Messagetext
Tagstext
Unique IDtext
Output fields[3]
FieldType
Conversation uidtext
Statustext
Uidtext

Create a Payment

Action
Input fields[3]
FieldType
TitleRequired
text
AmountRequired
number
Client IDRequired
choice
CurrencyRequired
text
Payment MethodRequired
choice
Feesarray
Mark As Onlineboolean
Other Payment Methodtext
Paid Attext
Pay Keytext
Payment Subject IDtext
Payment Subject Typechoice
Referencetext
Send Receiptboolean
Staff IDtext
Statechoice
Tipsarray
Output fields[3]
FieldType
Amountnumber
Client IDtext
Conversation IDtext
Created atdate
Currencytext
Feesarray
Marked as onlineboolean
Other payment methodtext
Paid attext
Paid offlineboolean
Pay keytext
Payment actiontext
Payment IDtext
Payment methodtext
Referencetext
Send receiptboolean
Staff IDtext
Statetext
Tipsarray
Titletext

Create a Staff Member

Action
Input fields[3]
FieldType
Business IDRequired
text
StaffRequired
object
Display NameRequired
text
EmailRequired
email
First Nametext
Last Nametext
Roletext
Metaobject
Invitetext
Output fields[3]
FieldType
Activetext
Blocked attext
Business role display nametext
Deletedtext
Display nametext
Emailtext
First nametext
IDtext
Invite senttext
Last nametext
Mobile numbertext
Phototext
Photo pathtext
Professional titletext
Roletext

Create an Estimate

Action
Input fields[3]
FieldType
Estimate TitleRequired
text
AddressRequired
text
Client IDRequired
choice
CurrencyRequired
text
Due DateRequired
date
Estimate DateRequired
date
ItemsRequired
array
Notetext
Send Emailboolean
Client Addresstext
Client Nametext
Conversation IDtext
Estimate Numbernumber
Source Campaigntext
Source Channeltext
Source Nametext
Source URLurl
Statuschoice
Output fields[3]
FieldType
Addresstext
Amountnumber
Client addresstext
Client IDtext
Client nametext
Conversation IDtext
Created atdate
Currencytext
Due datetext
Estimate datetext
Estimate numbertext
IDtext
Itemsarray
Notetext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Statustext
Titletext

Create an Event Waitlist

Action
Input fields[3]
FieldType
Business IDRequired
text
Event Instance IDRequired
text
Channeltext
Client IDchoice
Matter UIDtext
Source Nametext
Source URLurl
Time Zonetime
Output fields[3]
FieldType
Client IDnumber
Created atdate
Entity IDnumber
Entity typetext
Event instance uidtext
Initiatortext
Matterobject
Display nametext
Uidtext
Source IDnumber
Spotnumber
Staff uidtext
Start time htext
State summaryobject
Statetext
State htext
Statustext
Titletext
Typetext
Uidtext
Where htext

Create an Invoice

Action
Input fields[3]
FieldType
AddressRequired
text
Client IDRequired
choice
CurrencyRequired
text
Due DateRequired
date
Issued AtRequired
date
ItemsRequired
array
Allow Online Paymentboolean
Conversation IDtext
Invoice Numbernumber
Notetext
Send Emailboolean
Source Campaigntext
Source Channeltext
Source Nametext
Source URLtext
Staff IDtext
Statuschoice
Titletext
Output fields[3]
FieldType
Addresstext
Allow online paymentboolean
Amountnumber
Client IDtext
Conversation IDtext
Created atdate
Currencytext
Due datetext
IDtext
Invoice numbertext
Issued attext
Itemsarray
Notetext
Payment balancenumber
Payment statetext
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Staff IDtext
Statustext
Titletext

Delete a Client

Action
Input fields[3]
FieldType
Client IDRequired
choice
Output fields[3]
FieldType
Addresstext
Business uidtext
Campaigntext
Channeltext
Created atdate
Custom field 1text
Custom field 2text
Custom field 3text
Customer statustext
Emailtext
First nametext
IDtext
Last nametext
Mobile phonetext
Normalized phonetext
Opt intext
Sourcetext
Source URLtext
Tagsarray
Updated atdate

Delete a Staff Member

Action
Input fields[3]
FieldType
Business IDRequired
text

Make an API Call

universal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Match a Payment

Action
Input fields[3]
FieldType
Payment IDRequired
choice
Matter UIDRequired
text
Payment Status UIDRequired
text
Output fields[3]
FieldType
Amountnumber
Client IDtext
Conversation IDtext
Created atdate
Currencytext
Marked as onlineboolean
Other payment methodtext
Paid attext
Paid offlineboolean
Payment actiontext
Payment IDtext
Payment methodtext
Referencetext
Send receiptboolean
Source dataobject
Campaigntext
Channeltext
Nametext
Website URLtext
Statetext

Merge Duplicate Clients

Action
Input fields[3]
FieldType
From Client IDsRequired
choice
To Client IDRequired
choice

Update a Business

Action
Input fields[3]
FieldType
Business IDRequired
text
Admin Accountobject
Emailemail
Country Nametext
Display Nametext
First Nametext
Last Nametext
Languagechoice
Passwordtext
Phonetext
Businessobject
Nametext
Addresstext
Business Categorytext
Business Maturity in Yearschoice
Country Nametext
Hide Addressboolean
Landing Pagetext
Logo URLurl
Phonetext
Short Descriptiontext
Metaobject
Analyticsobject
Auditarray
External IDtext
External Reference IDtext
Identitiesarray
In Setupboolean
Intentsarray
Invitetext
Is Templateboolean
Notetext
Output fields[3]
FieldType
Admin accountobject
Country nametext
Display nametext
Emailtext
First nametext
Languagetext
Last nametext
Phonetext
Staff uidtext
User IDtext
Businessobject
Account blocked atdate
Addresstext
Business categorytext
Business maturity in yearstext
Country nametext
Dedicated numbertext
Hide addresstext
IDtext
Landing pagetext
Nametext
Integrationsobject
Pluginsarray
Metaobject
Auth tokentext
Booking settingsobject
Brandingobject
External IDtext
External reference IDtext
Identitiesarray
In setuptext
Intentsarray
Is templatetext
Marketing channeltext

Update a Client

Action
Input fields[3]
FieldType
Client IDRequired
choice
First Nametext
Last Nametext
Emailemail
Addresstext
Phonetext
Mobile Phonetext
Force Nullifyingboolean
Custom Field 1text
Custom Field 2text
Custom Field 3text
Spamboolean
Staff IDtext
Statustext
Tagstext
Output fields[3]
FieldType
Addresstext
Business uidtext
Campaigntext
Channeltext
Created atdate
Custom field 1text
Custom field 2text
Custom field 3text
Customer statustext
Emailtext
First nametext
IDtext
Last nametext
Mobile phonetext
Normalized phonetext
Opt intext
Sourcetext
Source URLtext
Tagsarray
Updated atdate

Update RSVP State

Action
Input fields[3]
FieldType
Booking IDRequired
choice
Appointment TypeRequired
choice
Business IDRequired
text
New RSVP StateRequired
choice
Output fields[3]
FieldType
Approval modetext
Category nametext
Charge typetext
Client IDtext
Conversation IDtext
Currencytext
Depthtext
Descriptiontext
Durationnumber
End timetext
Image URLtext
Interaction detailstext
Interaction typetext
Invoice payment status uidtext
Invoicesarray
Is recurringboolean
No showboolean
Notestext
Payableboolean
Paymenttext

20other output fields

Look for vCita templates in the WEXTL template library.

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

Last updated: Jul 24, 2026 18:13

How we write our apps documentation

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