Events Catalog
All 35 events you can subscribe to via webhooks.
How to subscribe
Call events.subscribe('event.name', 'https://your-url.com/webhook') from your addon. See Events & Webhooks for details.
All Events
| Event | Description | Required Scope |
|---|---|---|
invoice.created | A new invoice was created | invoices.read |
invoice.updated | An invoice was updated | invoices.read |
invoice.paid | An invoice was fully paid | invoices.read |
invoice.overdue | An invoice became overdue | invoices.read |
invoice.deleted | An invoice was deleted | invoices.read |
customer.created | A new customer was added | customers.read |
customer.updated | A customer record was updated | customers.read |
product.created | A new product was created | products.read |
product.updated | A product was updated | products.read |
product.low_stock | Product fell below reorder level | inventory.read |
payment.received | A payment was received | payments.read |
payment.created | A new payment was recorded | payments.read |
expense.created | A new expense was recorded | expenses.read |
expense.approved | An expense was approved | expenses.read |
payroll.processed | A payroll run was processed | payroll.read |
payroll.paid | Payroll payments disbursed | payroll.read |
employee.created | A new employee was added | employees.read |
employee.updated | An employee record was updated | employees.read |
store.order.created | A new online store order | ecommerce.read |
store.order.shipped | An order was shipped | ecommerce.read |
store.order.delivered | An order was delivered | ecommerce.read |
fleet.maintenance.due | Vehicle maintenance is due | fleet.read |
fleet.fuel.anomaly | Fuel consumption anomaly detected | fleet.read |
subscription.created | A new subscription started | subscriptions.read |
subscription.cancelled | A subscription was cancelled | subscriptions.read |
ticket.created | A new support ticket was opened | helpdesk.read |
ticket.resolved | A support ticket was resolved | helpdesk.read |
repair.completed | A repair job was completed | repairs.read |
repair.ready_for_pickup | A repair is ready for pickup | repairs.read |
bill.created | A new bill was created | bills.read |
bill.paid | A bill was paid | bills.read |
vendor.created | A new vendor was added | vendors.read |
project.created | A new project was created | projects.read |
project.completed | A project was marked complete | projects.read |
journal_entry.posted | A journal entry was posted to GL | journal_entries.read |
Get this programmatically
Call GET /api/addon/v1/events/catalog to get this list as JSON from the API.