vcita Developers Hub

Home
Guides
API Reference

vcita Developer Hub

Welcome to the vcita Developer Hub.
Find comprehensive guides and documentation to help you
start working with our APIs as quickly as possible.
Let's jump right in!

Get Started

HomeGuidesTutorialsAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Documentation

Getting Started

Open Platform APIs

Open Platform Overview
Who can access vcita Open Platform?
OAuth 2.0 Authentication Flow

Webhooks API

Webhooks Overview
Webhook subscriptions

Partners API

Partners API Overview
Single Sign On

SDK for Widgets And Website Integration

SDK Overview
LiveSite.js - Quickstart
Widget CSS Customization
Widget Configuration
Widget Custom Actions
Actions Reference
Website Embedded Actions

Sample Applications

Sample Application Overview
Sample Applications

Documentation

Getting Started

Open Platform APIs

Open Platform Overview
Who can access vcita Open Platform?
OAuth 2.0 Authentication Flow

Webhooks API

Webhooks Overview
Webhook subscriptions

Partners API

Partners API Overview
Single Sign On

SDK for Widgets And Website Integration

SDK Overview
LiveSite.js - Quickstart
Widget CSS Customization
Widget Configuration
Widget Custom Actions
Actions Reference
Website Embedded Actions

Sample Applications

Sample Application Overview
Sample Applications

Platform API

Token Management
Business
Staff
Categories
- getGet Categories [Alpha]
Services
Clients
Client Packages
Conversations
- getGet Conversations For A Client
- getGet Conversations
Documents
- getGet Documents For A Client
Estimates
Invoices
Payments
Identities
- getGet Identities
/docs
- getDocumentation
Fields
Forms
- getGet Forms
- putUpdates a Form
LeadGen
- postCreates a lead
Messages
- postCreate a Message
Payment Checkout
- putSend checkout update by webhook
- getGet Open Checkout For Specific url_key
Packages
Payment Settings
- getGet Current Payment Settings
- postUpdate Payment Settings
Payment Statuses
- putApply Coupon
- getValidate Coupon
Appointments
- getGet Appointments List
- getGet Appointment
Bookings
- postCreate New Booking [Alpha]
- postCancel a Booking [Alpha]
Event Instance
- getGet Event Instance
Availability
- getGet Service availability By ID [Alpha]
Webhooks
- postSubscribe To Webhook
- postUnsubscribe from Webhook

Scheduling related API

Bookings

client_api API

Forms

Payment related API

Client Packages
- getShow Client Package Info [Alpha]
- putUpdate client package [Alpha]
Packages
- putReorder packages [Alpha]
Payment request
- postSend payment request link [Alpha]
Products
Taxes

Payment related API

Cards
- getGet most recent pending card added to client [Alpha]
Packages
- getList Packages Info [Alpha]
- getShow Package Info [Alpha]

Client related API

Matters [Alpha]

Oauth API

Token Management
- postExchanges a OAuth Code for an Access Token
OpenID
- getGet authenticated user info

Webhooks responses

Getting Started
Client ('created', 'updated')
Message ('business_sent_message' , 'client_sent_message')
Payments ('recorded' / 'refunded')
Invoice ('issued')
Estimate ('requested', 'rejected', 'approved')
Appointment ('requested', 'scheduled', 'rescheduled', 'cancelled' , 'reminder_sent')
Event registration ('created', 'updated')
Review ('submitted')
Document ('created')
App Subscription ('installed', 'uninstalled')

Partners API

Account Management
Injection Leads From Any Form
- postLead Injection
Reporting
Single Sign On

Powered by