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": "<business_uid>", "event": "<event_name>"} — 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).