API Reference

Subscribe to Webhook

post
https://api.vcita.biz/platform/v1/webhook/subscribe

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', 'business', 'meeting', 'payment')
  • event_type: The action that triggers the notification (e.g., 'created', 'updated', 'deleted')

Common Events

  • client/created - New client created
  • business/created - New business created
  • meeting/created - New meeting scheduled
  • meeting/cancelled - Meeting cancelled
  • payment/paid - Payment received
  • invoice/issued - Invoice issued

Error Responses

Returns HTTP 500 with {"response": "Not Subscribed"} when subscription fails (e.g., invalid event format, service unavailable).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The event to subscribe to in the format 'entity/event_type'. The entity is the object type to monitor (e.g., 'client', 'business', 'meeting') and event_type is the action that triggers the webhook (e.g., 'created', 'updated', 'deleted', 'cancelled').

uri
required

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.

Responses

Updated 8 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago