Developer
Available events
The catalogue. Also served at GET /api/v1 as webhook_events.
| Event | Fires when |
|---|---|
| invoice.created | A sales invoice was posted |
| invoice.voided | A sales invoice was voided |
| invoice.paid | A sales invoice became fully paid or settled |
| invoice.reminder | A collections reminder went out for a customer with overdue invoices |
| bill.created | A vendor bill was posted |
| bill.voided | A vendor bill was voided |
| bill.paid | A vendor bill became fully paid or settled |
| receipt.created | Money was received from a customer |
| receipt.voided | A customer receipt was voided |
| payment.created | Money was paid to a vendor |
| payment.voided | A vendor payment was voided |
| sales_receipt.created | A cash sale was recorded (including POS) |
| sales_receipt.voided | A cash sale was voided |
| credit_note.created | A credit note was issued |
| debit_note.created | A debit note was issued |
| estimate.created | An estimate was created |
| purchase_order.created | A purchase order was raised |
| sales_order.created | A sales order was raised |
| expense.created | An expense was recorded |
| document.created | Any other document type was posted |
| document.voided | Any other document type was voided |
| customer.created | A customer was added |
| vendor.created | A vendor was added |
| bank_feed.received | Statement lines arrived on a bank account — pushed through the API, a rail, or an import |
| ping | Sent from Settings → Send test |
Subscribe to * on a business endpoint to receive everything. invoice.paid / bill.paid fire once, when the document crosses into Paid or Settled.
The live catalogue is served at GET /api/v1 under webhook_events, and to a key holding the Webhooks option at GET /api/v1/webhooks/events. If this page and that list ever disagree, the list is right.