About API Webhooks
Read below to find out more about each API webhook offered by IntakeQ.
To see the options below, go to More → Settings → Integrations, then click the Settings button next to the Developer API Integration heading.
Intake Forms API
- Triggers each time a form is submitted OR resubmitted (a form can only be resubmitted if rejected by staff)
- Triggers each time a form is manually set to "Completed" by staff
Treatment Notes API
- Triggers each time a treatment note is locked
Appointments API
Appointment Created
- Triggers each time an appointment request is submitted by a client
- Triggers each time an appointment is manually scheduled by staff
Appointment Canceled
- Triggers each time an appointment is canceled by a client
- Triggers each time an appointment is manually canceled by staff
Appointment Declined
- Triggers each time an appointment request is declined by staff
Appointment Attendance Confirmed
- Triggers each time a client confirms that they will attend an appointment
- Triggers when staff manually confirms the appointment
Appointment Deleted
- Triggers each time an appointment is manually deleted by staff
Appointment Rescheduled
- Triggers each time an appointment is rescheduled by a client
- Triggers each time an appointment is manually rescheduled by staff
Appointment Confirmed
- Triggers each time an appointment request is approved by staff
Appointment Missed
- Triggers each time an appointment is marked Missed by staff
Trigger webhook only for actions performed by clients
- Select this if you only wish to trigger webhooks for appointment events completed by clients on the booking widget.
Invoice API
Invoice Issued
- Triggers each time an invoice is automatically issued via an appointment
- Triggers each time an invoice is manually issued by staff
Invoice Auto-Charge Failed (Appt.)
- Triggers each time an automatic charge for a scheduled appointment fails
Invoice Canceled
- Triggers each time an invoice is manually canceled by staff
Invoice Paid
- Triggers each time a payment is added to an invoice
Invoice Recurring Charge Failed
- Triggers each time a scheduled recurring charge fails
Invoice Payment Refunded
- Triggers each time an invoice payment is manually refunded by staff