Webhook events

All webhook payloads follow a consistent structure:

TypeScript

interface BaseWebhookEventPayload<D extends Record<string, unknown>> {
  event: WebhookEventName;                  // The event name (e.g., 'invoice:create')
  data: D;                                  // Event-specific data
  status: 'success' | 'error' | 'pending';  // Event status
}

Payload Fields

• event (string): The name of the event that triggered the webhook
• data (object): Event-specific data containing relevant information
• status (string): The status of the event (success, error, or pending)

---

Event Reference

Events and Payloads Overview

Event Name	Description	When Triggered
invoice:create	New invoice created	When a new invoice is successfully created in the system
invoice:update	Invoice updated	When an existing invoice is modified (amounts, dates, items, etc.)
invoice:delete	Invoice deleted	When an invoice is successfully deleted from the system
invoice:status_changed	Invoice status changed	When invoice status transitions (e.g., pending → paid, pending → overdue)
invoice:procurement_added	Procurement item added	When a procurement item (product, service, or product varier) is added to an invoice
invoice:procurement_updated	Procurement item updated	When a procurement item on an invoice is modified (quantity, price, tax, etc.)
invoice:procurement_removed	Procurement item removed	When a procurement item is removed from an invoice
product:create	Product created	When a new product is successfully created in the system
product:update	Product updated	When an existing product is modified
product:delete	Product deleted	When a product is successfully deleted from the system
service:create	Service created	When a new service is successfully created in the system
service:update	Service updated	When an existing service is modified
service:delete	Service deleted	When a service is successfully deleted from the system
pos:create	POS created	When a new POS is successfully created in the system
pos:update	POS updated	When an existing POS is modified
pos:delete	POS deleted	When a POS is successfully deleted from the system
customer:create	Customer created	When a new customer is successfully created in the system
customer:update	Customer updated	When an existing customer is modified
customer:delete	Customer deleted	When a customer is successfully deleted from the system
vendor:create	Vendor created	When a new vendor is successfully created in the system
vendor:update	Vendor updated	When an existing vendor is modified
vendor:delete	Vendor deleted	When a vendor is successfully deleted from the system
external_revenue:create	External revenue created	When a new external revenue is successfully created in the system
external_revenue:update	External revenue updated	When an existing external revenue is modified
external_revenue:delete	External revenue deleted	When an external revenue is successfully deleted from the system
expense:create	Expense created	When a new expense is successfully created in the system
expense:update	Expense updated	When an existing expense is modified
expense:delete	Expense deleted	When an expense is successfully deleted from the system
purchase_order:create	Purchase order created	When a new purchase order is successfully created in the system
purchase_order:update	Purchase order updated	When an existing purchase order is modified
purchase_order:delete	Purchase order deleted	When a purchase order is successfully deleted from the system
table:create	Table created	When a new table is successfully created in the system
table:update	Table updated	When an existing table is modified
table:delete	Table deleted	When a table is successfully deleted from the system
shop_order:initiated	Shop order initiated	When a new shop order is initiated
shop_order:completed	Shop order completed	When a shop order is marked as completed
shop_order:status_changed	Shop order status changed	When a shop order's status changes
payment:record:invoice	Payment recorded for invoice	When a payment is recorded for an invoice
payment:record:pos	Payment recorded for POS	When a payment is recorded for a POS transaction
payment:record:external_revenue	Payment recorded for external revenue	When a payment is recorded for external revenue
payment:record:shop_purchase	Payment recorded for shop purchase	When a payment is recorded for a shop purchase
payment:record:expense	Payment recorded for expense	When a payment is recorded for an expense
payment:record:purchase_order	Payment recorded for purchase order	When a payment is recorded for a purchase order
payment:remove:invoice:payment	Payment removed from invoice	When a payment is removed from an invoice
payment:remove:pos	Payment removed from POS	When a payment is removed from a POS transaction
payment:remove:external_revenue	Payment removed from external revenue	When a payment is removed from external revenue
payment:remove:shop_purchase	Payment removed from shop purchase	When a payment is removed from a shop purchase
payment:remove:expense	Payment removed from expense	When a payment is removed from an expense
payment:remove:purchase_order	Payment removed from purchase order	When a payment is removed from a purchase order