vCita Webhooks API
The Webhooks API from vCita — 3 operation(s) for webhooks.
The Webhooks API from vCita — 3 operation(s) for webhooks.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vcita:vcita-webhooks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Platform_administration Webhooks API
description: Unified OpenAPI specification for platform_administration domain
version: '3.0'
x-generated:
sourceFiles:
- directory.json
- license.json
- operator-portal.json
- legacy_v2_todo.json
- legacy_v1_platform.json
- legacy_v2_settings_businesses.json
- business.json
- staff.json
- staff_member.json
- oauth.json
- online_profiles.json
- partners-api.json
- staff.json
- access_control.json
- accounts.json
pathNormalizations:
- file: license.json
basePath: /v3
transformations:
- original: /license/offerings
normalized: /v3/license/offerings
basePath: /v3
- original: /license/offerings/{uid}
normalized: /v3/license/offerings/{uid}
basePath: /v3
- original: /license/directory_offerings
normalized: /v3/license/directory_offerings
basePath: /v3
- original: /license/directory_offerings/{uid}
normalized: /v3/license/directory_offerings/{uid}
basePath: /v3
- original: /license/bundled_offerings
normalized: /v3/license/bundled_offerings
basePath: /v3
- original: /license/bundled_offerings/bulk
normalized: /v3/license/bundled_offerings/bulk
basePath: /v3
- original: /license/bundled_offerings/{uid}
normalized: /v3/license/bundled_offerings/{uid}
basePath: /v3
- original: /license/subscriptions
normalized: /v3/license/subscriptions
basePath: /v3
- original: /license/subscriptions/bulk
normalized: /v3/license/subscriptions/bulk
basePath: /v3
- original: /license/subscriptions/{uid}
normalized: /v3/license/subscriptions/{uid}
basePath: /v3
- original: /license/business_carts
normalized: /v3/license/business_carts
basePath: /v3
- original: /license/business_carts/{uid}
normalized: /v3/license/business_carts/{uid}
basePath: /v3
- original: /license/skus
normalized: /v3/license/skus
basePath: /v3
- original: /license/features_packages
normalized: /v3/license/features_packages
basePath: /v3
- original: /license/features
normalized: /v3/license/features
basePath: /v3
- original: /license/features/{uid}
normalized: /v3/license/features/{uid}
basePath: /v3
- original: /license/features_packages/{id}
normalized: /v3/license/features_packages/{id}
basePath: /v3
- original: /license/features_packages/add_feature
normalized: /v3/license/features_packages/add_feature
basePath: /v3
- original: /license/quota_consumptions
normalized: /v3/license/quota_consumptions
basePath: /v3
- original: /license/quota_balances
normalized: /v3/license/quota_balances
basePath: /v3
- file: operator-portal.json
basePath: /api/operator_api/v1
transformations:
- original: /packages
normalized: /api/operator_api/v1/packages
basePath: /api/operator_api/v1
- original: /packages/{id}
normalized: /api/operator_api/v1/packages/{id}
basePath: /api/operator_api/v1
- original: /packages/add_feature
normalized: /api/operator_api/v1/packages/add_feature
basePath: /api/operator_api/v1
- original: /features
normalized: /api/operator_api/v1/features
basePath: /api/operator_api/v1
- original: /features/{id}
normalized: /api/operator_api/v1/features/{id}
basePath: /api/operator_api/v1
- file: legacy_v1_platform.json
basePath: /platform/v1
transformations:
- original: /businesses
normalized: /platform/v1/businesses
basePath: /platform/v1
- original: /businesses/validate_login
normalized: /platform/v1/businesses/validate_login
basePath: /platform/v1
- original: /businesses/verify_audience_claim
normalized: /platform/v1/businesses/verify_audience_claim
basePath: /platform/v1
- original: /businesses/{business_uid}
normalized: /platform/v1/businesses/{business_uid}
basePath: /platform/v1
- original: /directory/branding
normalized: /platform/v1/directory/branding
basePath: /platform/v1
- original: /tokens
normalized: /platform/v1/tokens
basePath: /platform/v1
- original: /tokens/revoke
normalized: /platform/v1/tokens/revoke
basePath: /platform/v1
- original: /webhook/subscribe
normalized: /platform/v1/webhook/subscribe
basePath: /platform/v1
- original: /webhook/unsubscribe
normalized: /platform/v1/webhook/unsubscribe
basePath: /platform/v1
- original: /webhooks
normalized: /platform/v1/webhooks
basePath: /platform/v1
- original: /businesses/{business_uid}/features
normalized: /platform/v1/businesses/{business_uid}/features
basePath: /platform/v1
- original: /businesses/{business_uid}/purchased_items
normalized: /platform/v1/businesses/{business_uid}/purchased_items
basePath: /platform/v1
- original: /businesses/{business_uid}/recurly_data
normalized: /platform/v1/businesses/{business_uid}/recurly_data
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs
normalized: /platform/v1/businesses/{business_uid}/staffs
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs/{staff_uid}
normalized: /platform/v1/businesses/{business_uid}/staffs/{staff_uid}
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs/{staff_uid}/sessions
normalized: /platform/v1/businesses/{business_uid}/staffs/{staff_uid}/sessions
basePath: /platform/v1
- original: /businesses/{business_uid}/wizards
normalized: /platform/v1/businesses/{business_uid}/wizards
basePath: /platform/v1
- original: /businesses/{business_uid}/wizards/{wizard_name}
normalized: /platform/v1/businesses/{business_uid}/wizards/{wizard_name}
basePath: /platform/v1
- original: /scheduling/staff
normalized: /platform/v1/scheduling/staff
basePath: /platform/v1
- original: /scheduling/staff/{staff_uid}
normalized: /platform/v1/scheduling/staff/{staff_uid}
basePath: /platform/v1
- original: /business/jobber/flows
normalized: /platform/v1/business/jobber/flows
basePath: /platform/v1
- original: /business/jobber/executions
normalized: /platform/v1/business/jobber/executions
basePath: /platform/v1
- file: staff.json
basePath: /business/staffs
transformations:
- original: /v1/daily_staff_sign_ins
normalized: /business/staffs/v1/daily_staff_sign_ins
basePath: /business/staffs
- original: /v1/staffs/{uid}
normalized: /business/staffs/v1/staffs/{uid}
basePath: /business/staffs
- file: oauth.json
basePath: /oauth
transformations:
- original: /token
normalized: /oauth/token
basePath: /oauth
- original: /userinfo
normalized: /oauth/userinfo
basePath: /oauth
- file: online_profiles.json
basePath: /v3/business_administration
transformations:
- original: /online_profiles/{business_uid}
normalized: /v3/business_administration/online_profiles/{business_uid}
basePath: /v3/business_administration
- original: /online_profiles
normalized: /v3/business_administration/online_profiles
basePath: /v3/business_administration
- original: /online_profiles/{uid}
normalized: /v3/business_administration/online_profiles/{uid}
basePath: /v3/business_administration
- file: accounts.json
basePath: /business/accounts
transformations:
- original: /v1/attributes
normalized: /business/accounts/v1/attributes
basePath: /business/accounts
- original: /v1/branding
normalized: /business/accounts/v1/branding
basePath: /business/accounts
- original: /v1/identities
normalized: /business/accounts/v1/identities
basePath: /business/accounts
- original: /v1/usage/last_3_months_activity
normalized: /business/accounts/v1/usage/last_3_months_activity
basePath: /business/accounts
pathConflicts: []
componentConflicts:
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_license
files:
- merged
- license.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_operator-portal
files:
- merged
- operator-portal.json
- type: schema
name: Paging
resolution: Renamed to Paging_business
files:
- merged
- business.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_online_profiles
files:
- merged
- online_profiles.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_staff
files:
- merged
- staff.json
totalPaths: 85
totalComponents: 54
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- name: Webhooks
paths:
/platform/v1/webhook/subscribe:
post:
description: '## Overview
Subscribe to webhook notifications. Webhooks allow you to receive real-time notifications when specific events occur in the system. You must specify the event (a combined string of entity and event_type in the format ''entity/event_type'') and the target_url where notifications will be sent.
Available for **Staff and Directory Tokens**.
## Event Format
The `event` parameter uses the format `entity/event_type` where:
- **entity**: The object type to monitor (e.g., ''client'', ''appointment'', ''payment'', ''invoice'')
- **event_type**: The action that triggers the notification (e.g., ''created'', ''updated'', ''scheduled'')
See the enum for the full list of supported `entity/event_type` values.
## Entity Aliases
Some entities are accepted as aliases of a canonical entity (either spelling works):
- `lead` → `client`
- `account` → `business`
- `appointment` → `meeting`
- `engagement` → `matter`
## Common Events
- `client/created` - New client created
- `appointment/scheduled` - New appointment scheduled
- `appointment/cancelled` - Appointment cancelled
- `payment/paid` - Payment received
- `invoice/issued` - Invoice issued
- `estimate/approved` - Estimate approved
## Business Account Events (`pivot/event`)
A single `pivot/event` subscription delivers several business-level notifications. Its payload is flat — `{"id": "", "event": ""}` — and the `event` field distinguishes them:
- `account_muted` - The business was muted after being flagged as a suspected spammer
- `account_promotional_muted` - The business was blocked from sending promotional campaigns (the dedicated `account/promotional_blocked` event carries the full block details)
- `campaigns_recipients_quota_reached` - The business exceeded its monthly campaign recipients quota (only sent when the directory has the `campaign_recipient_quota_breached` feature enabled)
Note: with a Directory token, the `pivot` entity accepts only the `create`, `update` and `event` event types.
## Error Responses
Returns HTTP 500 with `{"response": "Not Subscribed"}` when subscription fails (e.g., invalid event format, service unavailable).'
parameters: []
responses:
'201':
description: Webhook subscription created successfully. Returns a subscription_id that can be used to identify this subscription.
content:
application/json:
example:
data:
subscription_id: '12345'
status: OK
'400':
description: Bad Request - Invalid parameters provided. The event format may be invalid (must be 'entity/event_type'), the target_url format is incorrect, or required fields are missing.
content:
application/json:
example:
message: Invalid event format
status: Error
'401':
description: Unauthorized - Invalid or missing authentication token.
content:
application/json:
example:
message: Unauthorized
status: Error
'500':
description: 'Subscription Failed - The webhook subscription could not be created. This typically occurs when the event format is invalid, the target URL is unreachable, or the webhook service encounters an error. Note: This status code is also returned for business-rule failures that should ideally be 400 errors.'
content:
application/json:
example:
response: Not Subscribed
summary: Subscribe to Webhook
tags:
- Webhooks
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: POST
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/webhook/subscribe
x-auth-type: Application & Application User
requestBody:
content:
application/json:
schema:
properties:
event:
description: The event to subscribe to in the format 'entity/event_type'. The entity is the object type to monitor (e.g., 'client', 'appointment', 'payment') and event_type is the action that triggers the webhook (e.g., 'created', 'updated', 'scheduled', 'cancelled'). Must be one of the values in the enum below.
type: string
enum:
- account/closed
- account/created
- account/promotional_blocked
- account/updated
- app_subscription/installed
- app_subscription/uninstalled
- application/installed
- application/uninstalled
- appointment/cancelled
- appointment/completed
- appointment/no_show
- appointment/reminder_sent
- appointment/requested
- appointment/rescheduled
- appointment/scheduled
- bulk_import/done
- business/created
- business/deleted
- business_rules_bulk_import/completed
- channel/status
- client/created
- client/updated
- contact_form/created
- conversation/read
- conversation_item/created
- customized_notification/update
- deposit/created
- document/sent
- estimate/approved
- estimate/rejected
- estimate/requested
- event/created
- event/updated
- event_attendance/created
- event_attendance/updated
- invoice/issued
- invoice/updated
- lead/created
- matter/delete
- matter/recover
- meeting/cancelled
- meeting/completed
- meeting/no_show
- meeting/reminder_sent
- meeting/requested
- meeting/rescheduled
- meeting/scheduled
- message/business_sent_message
- message/client_sent_message
- payment/cancelled
- payment/matched
- payment/paid
- payment/recorded
- payment/refunded
- payment/updated
- payment_gateways_settings/changed_primary_payment_gateway
- payment_gateways_settings/connected
- payment_gateways_settings/disconnected
- pivot/event
- pivot/update
- purchasable_subscription/create
- purchasable_subscription/created
- purchasable_subscription/update
- purchasable_subscription/updated
- review/submitted
- service/updated
- staff/created
- staff/deactivated
- staff/deleted
- staff/reactivated
- staff/updated
- subscription/create
- subscription/created
- subscription/update
- subscription/updated
- tag/add
- tag/delete
- voice_call/create
- voice_calls_settings/update
example: client/created
target_url:
description: The URL where webhook notifications will be sent. Must be a valid, publicly accessible URL that can receive HTTP POST requests with the webhook payload.
type: string
format: uri
example: https://my.domain.com/webhooks/handler
required:
- event
- target_url
type: object
x-example:
event: client/created
target_url: https://my.domain.com/webhooks/client-created
security:
- Bearer: []
operationId: postPlatformV1WebhookSubscribe
x-operation-id-source: derived
/platform/v1/webhook/unsubscribe:
post:
description: '## Overview
Unsubscribe from webhook. Note: This endpoint uses legacy parameter names (''event'' and ''target_url''). The ''target_url'' must match exactly the URL used when subscribing. The ''event'' parameter is optional and can be used to unsubscribe from a specific event type.
Available for **Staff and Directory Tokens**.'
parameters: []
responses:
'200':
description: Success
content:
application/json:
example:
data:
unsubscribed: true
status: OK
summary: Unsubscribe from Webhook
tags:
- Webhooks
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: POST
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/webhook/unsubscribe
x-auth-type: Application & Application User
requestBody:
content:
application/json:
schema:
properties:
event:
description: Object / Event name to unsubscribe from (optional). If not provided, all subscriptions for the target_url will be removed.
type: string
target_url:
description: The webhook URL that was used when subscribing. Must match exactly the URL used during subscription.
type: string
required:
- target_url
type: object
security:
- Bearer: []
operationId: postPlatformV1WebhookUnsubscribe
x-operation-id-source: derived
/platform/v1/webhooks:
get:
description: '## Overview
Get webhooks list.
Available for **Staff and Directory tokens**.'
parameters:
- description: "Filtering the list of webhooks.\nFilter is a 'deepObject' works with:\n 1. 'entity' - object which listen to event (example: client)\n 2. 'event_type' - type of event to trigger webhook (example: created)\n\nExample:\n <url>?filter[entity]=client&filter[event_type]=created\n"
in: query
name: filter
required: false
schema:
type: string
responses:
'200':
description: List webhooks
content:
application/json:
schema:
type: object
properties:
response:
type: object
properties:
success:
type: string
description: Indicates the success status of the request (e.g., "ok").
data:
type: object
properties:
subscriptions:
type: array
items:
type: object
properties:
id:
type: integer
description: The unique identifier of the webhook subscription.
entity:
type: string
description: 'Object / Event name that the webhook is subscribed to. This is the entity type being monitored. Available entities include: ''business'' (business accounts), ''client'' (client records), ''appointment'' (scheduled appointments), ''payment'' (payment transactions), ''invoice'' (invoices), ''account'' (account-related events), and 34 other entity types. See the enum list below for all available entities.'
enum:
- account
- app_subscription
- application
- appointment
- booking
- bulk_import
- business
- cancellation
- channel
- client
- confirmation
- contact_form
- conversation
- conversation_item
- deposit
- document
- engagement
- estimate
- event
- event_attendance
- invoice
- lead
- location
- matter
- meeting
- message
- notification
- payment
- payment_gateways_settings
- pivot
- purchasable_subscription
- reminder
- reschedule
- review
- service
- staff
- subscription
- tag
- voice_call
- voice_calls_settings
event_type:
type: string
description: 'The type of event that triggers the webhook notification. This specifies what action or state change triggers the webhook. Common event types include: ''create'' (object created), ''update'' (object updated), ''delete'' (object deleted), ''scheduled'' (appointment/event scheduled), ''cancelled'' (appointment/event cancelled), ''rejected'' (request rejected), ''paid'' (payment received), ''recorded'' (payment recorded), ''issued'' (invoice/estimate issued), ''sent'' (message sent), and 25 other event types. See the enum list below for all available event types.'
enum:
- approved
- business_sent_message
- cancelled
- changed_primary_payment_gateway
- client_sent_message
- closed
- completed
- connected
- create
- deactivated
- delete
- disconnected
- done
- event
- installed
- issued
- matched
- no_show
- paid
- promotional_blocked
- read
- reactivated
- recover
- recorded
- refunded
- rejected
- reminder_sent
- requested
- rescheduled
- scheduled
- sent
- status
- submitted
- uninstalled
- update
url:
type: string
description: The target URL where webhook notifications will be sent.
required:
- subscriptions
required:
- success
- data
required:
- response
example:
response:
success: ok
data:
subscriptions:
- id: 32
entity: client
event_type: create
url: https://my.domain.com/path/of/webhook/call
summary: Get Webhooks List
tags:
- Webhooks
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///v1/subscriptions
x-auth-type: Application & Application User
security:
- Bearer: []
operationId: getPlatformV1Webhooks
x-operation-id-source: derived
components:
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
Business:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
Directory:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
x-provenance:
method: searched
source: https://developers.intandem.tech:443/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.intandem.tech/reference/account-creation-1.md
- https://developers.intandem.tech/reference/account-manipulation.md
- https://developers.intandem.tech/reference/addfeaturetofeaturespackages.md
- https://developers.intandem.tech/reference/addremove-staff.md
- https://developers.intandem.tech/reference/business-info.md
- https://developers.intandem.tech/reference/close-an-account.md
- https://developers.intandem.tech/reference/createfeaturespackage.md
- https://developers.intandem.tech/reference/createlicensefeature.md
- https://developers.intandem.tech/reference/createonlineprofile.md
- https://developers.intandem.tech/reference/createquotaconsumption.md
- https://developers.intandem.tech/reference/delete_api-operator-api-v1-features-id.md
- https://developers.intandem.tech/reference/delete_api-operator-api-v1-packages-id.md
- https://developers.intandem.tech/reference/delete_business-accounts-v1-identities.md
- https://developers.intandem.tech/reference/delete_platform-v1-businesses-business-uid-staffs-staff-uid-sessions.md
- https://developers.intandem.tech/reference/delete_platform-v1-businesses-business-uid-staffs-staff-uid.md
- https://developers.intandem.tech/reference/delete_v3-access-control-business-roles-uid.md
- https://developers.intandem.tech/reference/delete_v3-access-control-staff-permission-overrides-lists-staff-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-bundled-offerings-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-directory-offerings-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-offerings-uid.md
- https://developers.intandem.tech/reference/deletefeaturespackage.md
- https://developers.intandem.tech/reference/deletelicensefeature.md
- https://developers.intandem.tech/reference/engagements-report.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-features-id.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-features.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-packages-id.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-packages.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-attributes.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-branding.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-identities.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-usage-last-3-months-activity.md
- https://developers.intandem.tech/reference/get_business-staffs-v1-daily-staff-sign-ins.md
- https://developers.intandem.tech/reference/get_businesses-validate-login.md
- https://developers.intandem.tech/reference/get_businesses.md
- https://developers.intandem.tech/reference/get_oauth-userinfo.md
- https://developers.intandem.tech/reference/get_platform-v1-business-jobber-executions.md
- https://developers.intandem.tech/reference/get_platform-v1-business-jobber-flows.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-features.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-recurly-data.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-staffs-staff-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-staffs.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-wizards-wizard-name.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-wizards.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-directory-branding.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-staff-staff-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-staff.md
- https://developers.intandem.tech/reference/get_platform-v1-tokens.md
- https://developers.intandem.tech/reference/get_platform-v1-webhooks.md
- https://developers.intandem.tech/reference/get_v2-settings-businesses-business-uid.md
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-webhooks-api-openapi.yml