Subscribe to Webhook

Subscribe to webhook notifications. Webhooks allow you to receive real-time notifications when specific events occur in the system. You must specify the entity (what object to monitor) and the event_type (what action triggers the notification).

Common Entity and Event Type Combinations:

• business + create - Notify when a business is created
• account + rejected - Notify when business creation fails (for asynchronous creation)
• client + create - Notify when a client is created
• appointment + scheduled - Notify when an appointment is scheduled
• payment + recorded - Notify when a payment is recorded
• invoice + issued - Notify when an invoice is issued

Available Entities (40 total):

• Business Management: business, account, staff, location, service
• Client Management: client, lead, engagement, tag
• Scheduling: appointment, booking, meeting, event, event_attendance, cancellation, reschedule, confirmation
• Financial: payment, invoice, estimate, deposit, subscription, purchasable_subscription
• Communication: message, conversation, conversation_item, voice_call, notification, reminder
• Content: document, review, contact_form
• Integrations: application, app_subscription, payment_gateways_settings, voice_calls_settings, channel
• Other: bulk_import, matter, pivot

Available Event Types (35 total):

• Lifecycle Events: create, update, delete
• Status Changes: approved, rejected, closed, completed, done, deactivated, reactivated
• Scheduling Events: scheduled, cancelled, rescheduled, no_show
• Financial Events: paid, refunded, recorded, issued
• Communication Events: sent, read, business_sent_message, client_sent_message, reminder_sent
• Integration Events: installed, uninstalled, connected, disconnected, changed_primary_payment_gateway
• Other Events: event, status, submitted, matched, requested, recover, promotional_blocked

Note: Not all entity/event_type combinations are valid. Refer to the webhook documentation for valid combinations.