Subscribe to Webhook

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).