Event catalogue
The event catalogue is owned by the shared EventRegistry. Existing wildcard (*) subscriptions expand automatically when a new webhook-visible core or plugin event is registered.
Additional Registry Events
| Event |
Trigger |
credit_note.updated |
A credit note is updated |
dispatch.stage_advanced |
A dispatch advances to its next stage |
invoice_payment.updated |
An invoice payment is updated |
option_list.created |
A list is created |
option_list.deleted |
A list is deleted |
option_list.updated |
A list is updated |
list_entry.created |
A list entry is created |
list_entry.deleted |
A list entry is deleted |
list_entry.updated |
A list entry is updated |
customer_tax_profile.created |
A customer tax profile is created |
customer_tax_profile.deleted |
A customer tax profile is deleted |
customer_tax_profile.updated |
A customer tax profile is updated |
catalogue_item.flightcase_config.updated |
A catalogue item flightcase configuration is updated |
item_tax_code.created |
A item tax code is created |
item_tax_code.deleted |
A item tax code is deleted |
item_tax_code.updated |
A item tax code is updated |
returns.closed |
A return is closed |
returns.disposition_recorded |
A return disposition is recorded |
returns.exception_dismissed |
A pending return exception is dismissed |
returns.exception_dispositioned |
A pending return exception is linked to a recorded disposition |
returns.exception_raised |
A return exception is raised for operator review |
returns.stage_advanced |
A return advances to its next stage |
scan_session.opened |
A scan session is opened |
scannable_identifier.deactivated |
A scannable identifier is deactivated |
scannable_identifier.registered |
A scannable identifier is registered |
stock_check.discrepancy_dismissed |
A stock-check discrepancy is dismissed |
stock_check.sign_off_cleared |
A stock-check sign-off is cleared |
stock_check.signed_off |
A stock check is signed off |
Workflows
| Event |
Trigger |
workflow.duplicated |
A workflow definition is duplicated as a new inactive draft |
workflow.run_completed |
A workflow run completes successfully |
workflow.run_failed |
A workflow run reaches a terminal failure |
workflow.run_cancelled |
A workflow run is cancelled |
Accounts
| Event |
Trigger |
account.created |
A new account is created |
account.credit_override_granted |
A credit override is granted for an account; the payload contains the account reference and action plus standard delivery metadata |
account.updated |
An account's details are updated |
account.archived |
An account is explicitly archived |
account.restored |
An archived account is restored |
account.deleted |
An account is soft-archived through DELETE. |
account.merged |
Two accounts are merged (source becomes an alias of the canonical account) |
account.anonymised |
An account's personally identifiable information is erased |
account.vat_validated |
An account's VAT number is validated (VIES or manual confirmation) |
Account events carry meta.event_id, meta.schema_version and meta.ref. A producer-supplied identifier is preserved; otherwise an account-only UUID is stamped once before subscriber fan-out. Redelivery uses the same persisted identifier and payload. Deduplicate deliveries by event ID; HTTP retries are at least once. These fields do not expose internal credit decisions, reservation release or history rebuild, or enable protected privacy and relationship subscriptions. Recipient identity, contact, commercial and credit-field permissions still apply.
Account archive and restore events
DELETE /api/v1/accounts/{id} performs a soft archive: the account becomes inactive
and recoverable, and its existing documents and relationships remain. It emits the
account.deleted event for webhook, plugin and workflow integrations. account.archived is not also sent for that DELETE.
REST integrations archive accounts with DELETE and subscribe to account.deleted.
Internal explicit-archive commands emit account.archived; that event has no
separate REST archive endpoint and is not also emitted by DELETE. Restore uses
POST /api/v1/accounts/{id}/restore and emits account.restored once. A vetoed
archive returns a coded account_archive_vetoed 422 response with no lifecycle
change, so callers must not treat it as successful deletion.
Archived accounts are excluded from new rental, invoice and activity account
selection. Existing documents and activity history retain their account links.
The DELETE delivery includes the account identifier in data and attribution in meta (shown for account 42 and an API actor):
{
"data": {
"id": 42
},
"meta": {
"event": "account.deleted",
"timestamp": "2026-01-15T14:30:00Z",
"event_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"schema_version": 1,
"actor_type": "api",
"ref": "account:42",
"occurred_at": "2026-01-15T14:30:00Z",
"resource_type": "account",
"resource_id": 42,
"resource_version": null
}
}
Catalogue items
| Event |
Trigger |
catalogue_item.created |
A new catalogue item is created |
catalogue_item.updated |
A catalogue item's details are updated |
catalogue_item.archived |
A catalogue item is archived (soft-deleted, recoverable) |
catalogue_item.restored |
An archived catalogue item is restored |
catalogue_item.deleted |
A catalogue item is deleted |
catalogue_item.merged |
Two catalogue items are merged |
catalogue_item_group.created |
A new catalogue item group is created |
catalogue_item_group.updated |
A catalogue item group is updated |
catalogue_item_group.deleted |
A catalogue item group is deleted |
related_item.created |
A related item link is added to a catalogue item |
related_item.updated |
A related item link is updated |
related_item.deleted |
A related item link is removed |
kit_component.created |
A kit bill-of-materials component is added |
kit_component.updated |
A kit bill-of-materials component is updated |
kit_component.deleted |
A kit bill-of-materials component is removed |
Stock
| Event |
Trigger |
asset.created |
An asset record is created |
asset.updated |
An asset is updated |
asset.deleted |
An asset is deleted |
asset_ledger_entry.created |
An asset ledger entry is recorded |
asset_ledger_entry.deleted |
An asset ledger entry is deleted |
Flightcases
| Event |
Trigger |
flightcase.created |
A flightcase is created (catalogue-item-backed or temporary) |
flightcase.updated |
Flightcase metadata or scan mode is updated |
flightcase.item.packed |
An item is packed into a flightcase |
flightcase.item.unpacked |
An item is unpacked from a flightcase |
flightcase.item.transferred |
An item is moved between flightcases in one step |
flightcase.nested |
A flightcase is packed inside another flightcase |
flightcase.sealed |
A flightcase passes the seal gate and is sealed |
flightcase.unsealed |
A sealed flightcase is reopened (manual or transfer-triggered) |
flightcase.dissolved |
A flightcase is manually or dispatch-dissolved |
flightcase.dispatched |
A kit/hybrid flightcase is dispatched as a persistent unit |
flightcase.returned |
A kit/hybrid flightcase is returned from a rental |
flightcase.repack.started |
Repack-on-return initiated for a transport flightcase housing |
flightcase.checkin_verified |
A flightcase's contents are verified during check-in |
Activities
| Event |
Trigger |
activity.created |
A new activity is created |
activity.updated |
An activity is updated |
activity.deleted |
An activity is deleted |
activity.overdue |
An open activity receives its daily overdue reminder |
activity.completed |
An activity enters Completed; includes completion timestamp and acting user |
activity.reopened |
A completed activity returns to Scheduled and clears completion details |
Addresses
| Event |
Trigger |
address.created |
An address is created |
address.updated |
An address is updated |
address.deleted |
An address is deleted |
Conversations
| Event |
Trigger |
conversation.created |
A conversation note/email/system entry is created |
conversation.updated |
A conversation is updated |
conversation.deleted |
A conversation is deleted |
conversation.mentioned |
A user-type account is @mentioned in a conversation or comment |
conversation_comment.created |
A comment is added to a conversation |
conversation_comment.updated |
A conversation comment is edited |
conversation_comment.deleted |
A conversation comment is deleted |
Rate specifications
| Event |
Trigger |
rate_specification.created |
A rate specification is created |
rate_specification.updated |
A rate specification is updated |
rate_specification.deleted |
A rate specification is deleted |
catalogue_item_price.created |
A catalogue item price is assigned |
catalogue_item_price.updated |
A catalogue item price is updated |
catalogue_item_price.deleted |
A catalogue item price is removed |
Tax
| Event |
Trigger |
tax_rate.created |
A tax rate is created |
tax_rate.updated |
A tax rate is updated |
tax_rate.deleted |
A tax rate is deleted |
tax_rule.created |
A tax rule is created |
tax_rule.updated |
A tax rule is updated |
tax_rule.deleted |
A tax rule is deleted |
tax_zone.created |
A tax zone is created |
tax_zone.updated |
A tax zone is updated |
tax_zone.deleted |
A tax zone is deleted |
tax_category.created |
A tax category is created |
tax_category.updated |
A tax category is updated |
tax_category.deleted |
A tax category is deleted |
Pricing
| Event |
Trigger |
discount_group.created |
A discount group is created |
discount_group.updated |
A discount group is updated |
discount_group.deleted |
A discount group is deleted |
discount_rule.created |
A discount rule is created |
discount_rule.updated |
A discount rule is updated |
discount_rule.deleted |
A discount rule is deleted |
surcharge.created |
A surcharge is created |
surcharge.updated |
A surcharge is updated |
surcharge.deleted |
A surcharge is deleted |
surcharge_group.created |
A surcharge group is created |
surcharge_group.updated |
A surcharge group is updated |
surcharge_group.deleted |
A surcharge group is deleted |
rate_band.created |
A rate band is created |
rate_band.updated |
A rate band is updated |
rate_band.deleted |
A rate band is deleted |
bundle_rule.created |
A bundle rule is created |
bundle_rule.updated |
A bundle rule is updated |
bundle_rule.deleted |
A bundle rule is deleted |
Warehouses
| Event |
Trigger |
warehouse.created |
A warehouse location is created |
warehouse.updated |
A warehouse location is updated |
warehouse.deleted |
A warehouse location is deleted |
Currencies
| Event |
Trigger |
currency.created |
A currency is created |
currency.updated |
A currency is updated |
currency.deleted |
A currency is deleted |
Exchange Rates
| Event |
Trigger |
exchange_rate.created |
An exchange rate is created |
exchange_rate.updated |
An exchange rate is updated |
exchange_rate.deleted |
An exchange rate is deleted |
Users
| Event |
Trigger |
user.created |
A new user is invited or created |
user.updated |
A user's profile or roles are updated |
user.deactivated |
A user account is deactivated |
user.deleted |
A user is deleted |
Roles
| Event |
Trigger |
role.created |
A new role is created |
role.updated |
A role's name or permissions are modified |
role.deleted |
A role is deleted |
Settings
| Event |
Trigger |
settings.updated |
Application settings are changed |
Rentals
Rental events fire on every committed mutation of a rental, its line
items, costs, allocated assets, and quote versions. They are never re-delivered
when event history is rebuilt.
Webhook rental objects use the same flat fields as rental reads: owner_id, quote_expires_at, starts_at, ends_at, uses_billable_days, billable_days, customer_collects, customer_returns, subtotal, tax_total and total. The billing and customer choices are booleans. Totals are decimal strings in currency_code, and totals by kind use rental_total, sale_total, service_total, sub_hire_total, transit_total and loss_damage_total. State and status are string identities. Lean events retain their event-specific result fields.
On rental.created and rental.updated events that replace phases, data.phases is the ordered event-time snapshot. Entries have the same public shape as rental reads:
{
"key": "delivery",
"label": "Delivery",
"starts_at": "2026-11-04T09:00:00.000Z",
"ends_at": "2026-11-04T11:00:00.000Z"
}
Endpoints can be null. A cleared replacement is phases: []. The captured labels and instants come from the committed event, so changing definitions or rental dates later does not rewrite those phase values. The shared outbound payload feeds both webhook and workflow consumers. This event snapshot guarantee applies to creation and phase replacement; a header-only update does not capture a new phase replacement.
The rental event stream retains phase_snapshot with a format version and ordered rows containing child ID, key, sequence, timestamps and definition evidence (label, colour, visibility, blocking and role). Public webhook phase entries expose the four fields above. Use workflow phase conditions to select captured entries by key. A phase timestamp does not schedule a new event.
| Event |
Trigger |
rental.created |
A new rental (quote) is created |
rental.updated |
A rental's header fields or phases are updated |
rental.state_changed |
A rental changes document state or returns to an active status; from and to identify the transition |
approval.chain_archived |
A published approval-chain version is archived |
approval.chain_deleted |
A never-published approval-chain draft is permanently deleted |
approval.chain_restored |
An archived approval-chain version is restored |
approval.requested |
An approval request is committed |
approval.assigned |
An approval assignment is committed |
approval.actioned |
An approval assignment receives a decision |
approval.changes_requested |
An approver requests changes and closes the current approval attempt |
approval.stage_resolved |
An approval stage reaches its quorum |
approval.delegated |
An approval assignment is delegated |
approval.reassigned |
An approval assignment is reassigned |
approval.delegation_revoked |
An approval delegation is revoked |
approval.delegation_expired |
An approval delegation expires |
approval.reminded |
An approval assignment receives a reminder |
approval.escalated |
An approval assignment receives an escalation recipient |
approval.escalation_replaced |
An approval escalation recipient is replaced |
approval.stale |
An approval request becomes stale |
approval.expired |
An approval request expires |
approval.completed |
An approved request is consumed by its original transition |
rental.locks_applied |
FX/tax locks are applied to an order |
rental.locks_released |
An order's FX/tax locks are released for re-pricing |
rental.status_changed |
A rental's status changes |
rental.status_promoted |
A rental's status is promoted along its workflow |
rental.cloned |
A rental is cloned into a new rental |
rental.deleted |
A rental is soft-deleted |
rental.restored |
A soft-deleted rental is restored |
rental.associated |
A rental is associated beneath a parent rental |
rental.dissociated |
A rental is detached from its parent rental |
rental.agreed_price_set |
A negotiated agreed total is set |
rental.agreed_price_cleared |
A negotiated agreed total is cleared |
rental.group_agreed_price_set |
A negotiated agreed total is set on a line-item group |
rental.group_agreed_price_cleared |
A negotiated agreed total is cleared from a line-item group |
rental.pricing_recalculated |
Rental pricing is recalculated (rates, tax, surcharges) |
rental.late_return |
An order still has equipment out past its scheduled end date |
rental.quote_expiring |
A quote is approaching its quote_expires_at expiry |
rental.discount_reset |
Applied discounts are cleared from a rental |
rental.discount_group_applied |
A discount group is applied to a rental |
rental.discount_manually_overridden |
A discount group percentage is manually overridden |
rental.line_added |
A line item is added |
rental.line_removed |
A line item is removed |
rental.surcharge_group_toggled |
A surcharge group is enabled or disabled on a rental |
rental.cost_added |
An additional cost is added |
rental.cost_updated |
An additional cost is updated |
rental.cost_removed |
An additional cost is removed |
rental.version_created |
A new quote version is created |
rental.version_activated |
A quote version is made active |
rental.version_accepted |
A quote version is accepted by the customer |
rental.version_declined |
A quote version is declined |
rental.version_sent |
A quote version is sent to the customer |
rental.version_relabelled |
A quote version's label is changed |
rental.version_superseded |
A quote version is superseded by a newer one |
rental.version_deleted |
A quote version is deleted |
rental.asset_allocated |
A barcoded asset is allocated to a line item |
rental.asset_deallocated |
A barcoded asset is deallocated |
rental.asset_substituted |
An allocated asset is substituted for another |
rental.asset_prepared |
An asset is marked prepared for dispatch |
rental.asset_preparation_reverted |
An asset's prepared state is reverted |
rental.asset_checked |
An asset is scan-checked |
rental.asset_dispatched |
An asset is dispatched |
rental.asset_on_hire |
An asset is marked on-hire |
rental.asset_returned |
An asset is returned |
rental.asset_status_changed |
An assigned asset changes status; assignment_id, from and to identify the change |
rental.asset_flightcase_set |
An asset is placed in a flightcase |
rental.asset_flightcase_cleared |
An asset is removed from its flightcase |
rental.bulk_dispatched |
A bulk (non-barcoded) quantity is dispatched |
rental.bulk_returned |
A loose quantity is returned |
rental.bulk_quantity_adjusted |
A bulk dispatched/returned quantity is adjusted |
Rental pricing mode payload
rental.pricing_recalculated delivers a lean data object with required id,
action, mutation_class, and pricing_manifest_hash. The mutation class is
accepted_terms_recomputation, rebase, or permitted_net_override; the
manifest hash is a string or null. Other lean events retain their existing shape.
Workflow consumers resolve the rental subject from the event payload id
(data.id in the webhook delivery). The committed OpenAPI webhook schema describes this event.
Communication Drafts
Payloads are lean envelopes — id, status, and the title pointer. A draft's
body is customer prose that has not (yet) cleared the approval gate, so it is
never broadcast; re-read /api/v1/communication_drafts/{id} for the content.
| Event |
Trigger |
communication_draft.created |
A customer communication is drafted for approval |
communication_draft.approved |
A human approves a draft (optionally editing it first) |
communication_draft.discarded |
A draft is rejected and can never be sent |
communication_draft.sent |
An approved draft is handed to the delivery pipeline |
Documents
| Event |
Trigger |
document.created |
A document is generated from a template |
document.pdf_generated |
A PDF is generated and stored for a document |
document.finalised |
A document is finalised (locked for sharing) |
document.voided |
A finalised document is voided |
document.emailed |
A document is emailed to a recipient (Notification Engine, P38) |
document.public_link_created |
A public sharing link is created for a document |
document.public_link_accessed |
A public sharing link is accessed for the first time |
document.public_link_revoked |
A public sharing link is revoked |
document.public_link_configured |
A public link's expiry or PIN settings are changed |
document.approval_requested |
A document is shared with the customer asking for approval |
document.portal_question |
A customer asks a question from the public document portal |
document.approved |
A customer approves a document from the public portal |
document.declined |
A customer declines a document from the public portal |
document_template.created |
A document template is created or duplicated |
document_template.updated |
A document template is saved |
document_template.deleted |
A custom document template is deleted |
document_template.restored |
A system template is restored to its shipped default |
document_template.set_as_default |
A template is marked as the default for its type |
document_sequence.reset |
A document numbering sequence rolls over to a new period |
document_sequence.updated |
A document numbering sequence is updated |
Document payloads include nullable response_recorded_by_user_id: the authenticated staff user who recorded a customer decision, separate from responded_by_name. Customer portal submissions leave it null. Deleting that staff user clears the live reference; previously delivered webhook payloads can still contain the identifier. Treat it as staff personal data under the recipient's retention and access policy.
Communication Templates
| Event |
Trigger |
communication_template.created |
A communication template is created |
communication_template.updated |
A communication template is updated |
communication_template.deleted |
A communication template is deleted |
Email Layouts & Templates
| Event |
Trigger |
email_layout.created |
An email layout is created |
email_layout.updated |
An email layout is saved or restored from a version |
email_layout.deleted |
A custom email layout is deleted |
email_layout.set_as_default |
An email layout is promoted to the default |
email_template.created |
A custom email template is created in the admin UI |
email_template.updated |
An email template is saved or restored from a version |
email_template.deleted |
A custom email template is deleted in the admin UI |
email_template.reset |
A system email template is restored to its shipped subject and HTML |
Attachments
| Event |
Trigger |
attachment.created |
A file is attached to an entity |
attachment.deleted |
An attachment is deleted from an entity |
Invoices
| Event |
Trigger |
invoice.created |
A draft invoice is generated |
invoice.issued |
A draft invoice is issued to the customer |
invoice.voided |
An invoice is voided |
invoice.overdue |
An issued invoice passes its due date with an outstanding balance |
payment.recorded |
A payment is recorded against an invoice — payload embeds payment fields (see Invoices API) |
invoice.portal_payment_received |
A customer pays an invoice from the public portal |
payment.refunded |
A refund is recorded against an invoice — payload embeds payment/refund fields (see Invoices API) |
credit_note.issued |
A credit note is issued against an invoice |
credit_note.draft_created |
A draft credit note is created (no financial effect) |
credit_note.applied |
A draft credit note is applied and balances committed |
credit_note.voided |
A credit note is voided |
Billing Runs
| Event |
Trigger |
billing_run.created |
A billing run is created |
billing_run.completed |
A billing-run issue batch finishes successfully |
Availability
| Event |
Trigger |
availability.changed |
A catalogue-item/warehouse's availability read model has been recalculated |
Shortages
| Event |
Trigger |
shortage.detected |
A shortage is detected for an order line |
shortage.cleared |
A previously-detected shortage no longer exists |
shortage.acknowledged |
A shortage is acknowledged at a confirmation gate |
shortage.resolution.created |
A shortage resolution is created |
shortage.resolution.confirmed |
A shortage resolution is confirmed |
shortage.resolution.in_progress |
A shortage resolution's fulfilment has begun |
shortage.resolution.fulfilled |
A shortage resolution completes and stock is available |
shortage.resolution.partially_fulfilled |
A shortage resolution is partially fulfilled |
shortage.resolution.failed |
A shortage resolution attempt fails |
shortage.resolution.cancelled |
A shortage resolution is cancelled |
shortage.waitlist.created |
A waitlist monitor is placed on a shortage |
shortage.waitlist.matched |
Monitored stock becomes available |
shortage.waitlist.expired |
A waitlist monitor expires without matching |
shortage.escalated |
An unresolved shortage passes the configured escalation threshold |
Purchase Orders
| Event |
Trigger |
purchase_order.created |
A draft purchase order is created |
purchase_order.updated |
A draft purchase order is updated |
purchase_order.sent |
A purchase order is sent to the supplier |
purchase_order.received |
Goods are received against a purchase order |
purchase_order.cancelled |
A purchase order is cancelled |
purchase_order.deleted |
A draft purchase order is deleted |
purchase_order_document.created |
A document (e.g. supplier PDF) is generated for a purchase order |
Virtual Stock
| Event |
Trigger |
virtual_stock_intake.created |
A draft virtual stock intake is created |
virtual_stock_intake.updated |
A draft virtual stock intake is updated |
virtual_stock_intake.confirmed |
A virtual stock intake is confirmed |
virtual_stock_intake.received |
Virtual stock is received into availability |
virtual_stock_intake.returned |
Virtual stock is returned after the hire window |
virtual_stock_intake.cancelled |
A virtual stock intake is cancelled |
virtual_stock_intake.deleted |
A draft virtual stock intake is deleted |
Scanning
| Event |
Trigger |
scan_event.voided |
An operator appends a compensating event that reverses a supported scan |
Vehicles
| Event |
Trigger |
vehicle.created |
A vehicle is created |
vehicle.updated |
A vehicle is updated |
vehicle.deleted |
A vehicle is deleted |
vehicle.assigned |
A vehicle is assigned to a rental or job |
vehicle.assignment_updated |
A vehicle assignment's details are updated |
vehicle.unassigned |
A vehicle is unassigned |
Facilities
| Event |
Trigger |
facility.created |
A bookable facility is created |
facility.updated |
A bookable facility is updated |
facility.deleted |
A bookable facility is deleted |
Services
| Event |
Trigger |
service.created |
A labour catalogue service is created |
service.updated |
A labour catalogue service is updated |
service.deleted |
A labour catalogue service is deleted |
Resource assignments
| Event |
Trigger |
resource_assignment.created |
A scheduling resource assignment is created |
resource_assignment.updated |
A scheduling resource assignment is updated |
resource_assignment.cancelled |
A scheduling resource assignment is cancelled |
resource_assignment.confirmed |
A scheduling resource assignment is confirmed |
resource_assignment.started |
A scheduling resource assignment is started |
resource_assignment.completed |
A scheduling resource assignment is completed |
resource_assignment.rescheduled |
A scheduling resource assignment window is changed |
resource_assignment.demand_unmet |
Cancelling an assignment leaves service demand unmet (rental_line_id + shortfall) |
Assignment route stops
Route-stop payloads identify the destination with stop_target_type (warehouse, address, or account) and stop_target_id.
| Event |
Trigger |
assignment_route_stop.created |
A route stop is appended to a resource assignment |
assignment_route_stop.updated |
A route stop's location, type, times, or notes are updated |
assignment_route_stop.reordered |
Route stops on an assignment are reordered |
assignment_route_stop.deleted |
A route stop is removed from a resource assignment |
Scheduling conflicts
| Event |
Trigger |
scheduling_conflict.detected |
A scheduling conflict is detected on assignment write |
scheduling_conflict.resolved |
A scheduling conflict is resolved |
Repair
| Event |
Trigger |
repair.created |
An asset is placed into repair |
repair.updated |
A repair record's details are updated |
repair.released |
A repaired item is released back into service |
Equipment tests
| Event |
Trigger |
equipment_test.created |
An equipment_test record is created |
equipment_test.updated |
An equipment_test record is updated |
equipment_test_certificate.issued |
A passed equipment-test result certificate is issued |
equipment_test.deleted |
An equipment_test record is deleted |
equipment_test.completed |
An equipment_test is completed |
equipment_test.failed |
An equipment_test is recorded as failed |
equipment_test_result.created |
A result line is recorded against an equipment_test |
equipment_test_result.deleted |
Historical deletion event; new results are retained and voided instead |
equipment_test_result.voided |
A result is voided with a reason, preserving readings and recalculating asset compliance |
equipment_test_result.updated |
An equipment_test result line is updated |
Asset Lifecycle
| Event |
Trigger |
asset_cost.created |
A maintenance/asset cost is recorded |
asset_cost.updated |
An asset cost is updated |
asset_cost.deleted |
An asset cost is deleted |
asset_retirement.created |
An asset is retired (disposed) |
asset_retirement.voided |
A stock-check-sourced retirement is voided directly (not emitted on reinstate) |
asset_retirement.reinstated |
A retired asset is reinstated (returned to active stock) |
usage_reading.recorded |
A usage reading (e.g. odometer/hours) is recorded against a stock unit |
usage_reading.deleted |
A usage reading is deleted |
Stock Checks
| Event |
Trigger |
stock_check.created |
A stock check is created |
stock_check.updated |
A stock check is updated |
stock_check.closed |
A stock check is closed for review |
stock_check.completed |
A stock check is completed and reconciled |
stock_check.reopened |
A stock check is reopened |
stock_check.cancelled |
A stock check is cancelled |
stock_check.discrepancy_resolved |
A stock check discrepancy is resolved (ledger/relocation applied) |
Warehouse Transfers
| Event |
Trigger |
warehouse_transfer.created |
A warehouse transfer is created |
warehouse_transfer.updated |
A warehouse transfer's details are updated |
warehouse_transfer.dispatched |
A warehouse transfer is dispatched from the origin warehouse |
warehouse_transfer.received |
A warehouse transfer is received at the destination warehouse |
warehouse_transfer.cancelled |
A warehouse transfer is cancelled |
Rental Projects
| Event |
Trigger |
rental_project.created |
A rental project is created |
rental_project.cost_added |
A project-level labour or fleet cost is added |
rental_project.cost_updated |
A project-level labour or fleet cost is updated |
rental_project.cost_removed |
A project-level labour or fleet cost is removed |
rental_project.updated |
A rental project's details or status are updated |
rental_project.deleted |
A rental project is deleted (its rentals are detached) |
rental.assigned_to_project |
A rental is assigned to a rental project |
rental.detached_from_project |
A rental is detached from its rental project |
Suppliers
| Event |
Trigger |
catalogue_item_supplier.created |
A supplier is recorded against a catalogue item |
catalogue_item_supplier.updated |
A catalogue item supplier is updated |
catalogue_item_supplier.deleted |
A catalogue item supplier is deleted |
Dispatch & Returns
| Event |
Trigger |
dispatch.stage_advanced |
A rental dispatch is moved to a new dispatch stage |
returns.stage_advanced |
A rental return is moved to a new return stage |
returns.disposition_recorded |
A return disposition (damage, loss, write-off, …) is recorded |
returns.closed |
A rental's returns are closed |
returns.exception_dismissed |
A pending return exception is dismissed |
returns.exception_dispositioned |
A pending return exception is resolved with a disposition |
returns.exception_raised |
A return exception is raised for operator review |
Scannable Identifiers
| Event |
Trigger |
scannable_identifier.registered |
A barcode/QR/RFID identifier is registered against a scannable entity |
scannable_identifier.deactivated |
A scannable identifier is deactivated |
Scan Sessions
| Event |
Trigger |
scan_session.completed |
A scanning session is completed |
scan_session.abandoned |
A scanning session is abandoned |
scan_session.opened |
A scanning session is opened |
Reporting
| Event |
Trigger |
report.generated |
A scheduled report finishes running and has been delivered to its subscribers |
Import / Export
| Event |
Trigger |
export.completed |
An export job finishes successfully |
export.failed |
An export job fails |
export.deleted |
An export job and its generated file are deleted |
import.batch.parsing |
An import batch begins parsing the uploaded file |
import.batch.validated |
An import batch finishes validation |
import.batch.committed |
An import batch finishes committing rows |
import.batch.failed |
An import batch commit fails or pauses with errors |
import.batch.paused |
An exhausted commit worker pauses its import batch for recovery |
import.plan.started |
A migration / import plan begins sequential execution |
import.plan.step_completed |
A plan step finishes committing its batch |
import.plan.failed |
Plan execution pauses at a failing step (pause-not-rollback) |
Updates
| Event |
Trigger |
update.started |
A self-hosted upgrade run begins |
update.completed |
A self-hosted upgrade run finishes successfully |
update.failed |
A self-hosted upgrade run stops at a failing step |
Event stability
Event names are a public contract. A subscription records the names it wants
verbatim, so a renamed or removed name simply stops matching and deliveries end
silently — there is no error for the integration to see.
The policy is therefore:
- Additive only. New events may be added at any time. A released event name
is never renamed and never removed.
- Payload changes are additive. Fields may be added to an event payload;
existing fields are not renamed, retyped, or dropped. Subscribers should
ignore unknown fields.
- Stable delivery. Supported event names and payload fields remain available throughout v1.x.
This is enforced in CI, not just by convention: a frozen snapshot of every
released event name is kept, and a CI check fails if any of them disappears
from config/events.php. Adding an event is free.
Every registered event has a delivery schema under the OpenAPI 3.1 document's top-level webhooks key. meta.schema_version is owned by that event's registry entry; a breaking payload change increments its version, while additive optional fields do not. Retried and replayed events retain their original schema version, meta.event_id and meta.occurred_at.
Verify X-Signals-Signature as HMAC-SHA256 over {X-Signals-Timestamp}.{raw body} and reject timestamps outside a 300-second window. X-Signals-Event-Id matches meta.event_id. See Webhooks for verification code, the full metadata field table, and test/redeliver/replay endpoints.
Payload Schemas
Registered single-resource results are promoted directly to data, using the same resource shape as the REST API. Compound results retain their meaningful resource keys and other result fields together as an object under data. Lifecycle events that only need to identify a record (deletions, archive/restore) put that identifier in data.id.
The event catalogue's internal payload schema and the HTTP delivery shape are distinct. Internal event payloads can nest a DTO under the registered payload_key; this does not make that key an HTTP response root. Outbound delivery projects the event result into data after recipient privacy filtering, and places delivery attributes in root meta.
Published webhook delivery schemas describe the HTTP envelope. Nullable fields use a type union that includes null, such as "type": ["string", "null"]. Fields that recipient filtering can remove are optional rather than required: for example, commercial.purchase.unit_cost can be absent when the recipient lacks cost visibility. Consumers must distinguish an omitted field from a field whose value is null.
Each event declares its internal payload classification in the event catalogue; delivery applies these rules:
| Shape |
data contains |
full_dto |
the resource directly for a registered single-resource result; a compound object retaining its resource keys and result fields for a multiple-resource result |
lean_envelope |
id and action only — re-read the resource endpoint for detail |
ad_hoc |
a bespoke payload documented per event (change snapshots, progress counters) |
Catalogue item fields
Catalogue item resource events carry the same field groups as REST: data.offered_for is rental, sale or both, and data.tracking is bulk or serialised. data.availability contains buffer_before_minutes, turnaround_minutes and reserve_percent. data.commercial contains rental, sale, sub_hire and purchase; expanded references remain inside the corresponding group. The unit_cost values in the purchasing and sub-hire groups are decimal strings and can be omitted when the recipient cannot view costs. See catalogue field groups.
Compound Flightcase Events
flightcase.nested is classified as full_dto, but its result includes both the parent and child flightcases. It retains parent_flightcase, child_flightcase, their identifiers, and depth under data; a receiver reads data.parent_flightcase.id and data.child_flightcase.id. The resource objects are abbreviated in this example:
{
"data": {
"parent_flightcase": {
"id": 10,
"uuid": "cd07a010-f77e-4316-ac4a-05659938359c"
},
"child_flightcase": {
"id": 11,
"uuid": "33a33fa3-a93e-421a-a22a-c361d7c2ef8a"
},
"parent_flightcase_id": 10,
"parent_flightcase_uuid": "cd07a010-f77e-4316-ac4a-05659938359c",
"child_flightcase_id": 11,
"child_flightcase_uuid": "33a33fa3-a93e-421a-a22a-c361d7c2ef8a",
"depth": 1,
"user_id": 7
},
"meta": {
"event": "flightcase.nested",
"timestamp": "2026-01-15T14:30:00Z",
"actor_type": "user",
"event_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"occurred_at": "2026-01-15T14:30:00Z",
"resource_type": "flightcase",
"resource_id": null,
"resource_version": null,
"schema_version": 1
}
}
Every delivery includes event_id, occurred_at, resource_type, resource_id, resource_version and schema_version in root meta alongside event and timestamp. The resource ID and version may be null. Optional attribution and correlation fields such as actor_type and ref also belong in meta. A resource's own fields remain inside its object in data.
Tax Rate Events
tax_rate.created includes the full tax rate object:
{
"data": {
"id": 1,
"name": "UK Standard",
"description": "Standard rate VAT",
"rate": "20.0000",
"is_active": true,
"created_at": "2026-01-15T14:30:00Z",
"updated_at": "2026-01-15T14:30:00Z"
},
"meta": {
"event": "tax_rate.created",
"timestamp": "2026-01-15T14:30:00Z",
"event_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"occurred_at": "2026-01-15T14:30:00Z",
"resource_type": "tax_rate",
"resource_id": 1,
"resource_version": "2026-01-15T14:30:00Z",
"schema_version": 1
}
}
| Field |
Type |
Description |
id |
integer |
Tax rate identifier |
name |
string |
Display name (e.g. UK Standard) |
description |
string|null |
Optional description |
rate |
string |
Percentage as a decimal string (e.g. 20.0000) |
is_active |
boolean |
Whether the rate is active |
created_at / updated_at |
string |
ISO 8601 UTC timestamps |
tax_rate.deleted sends only the identifier:
{
"data": {
"id": 1
},
"meta": {
"event": "tax_rate.deleted",
"timestamp": "2026-01-15T14:30:00Z",
"event_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"occurred_at": "2026-01-15T14:30:00Z",
"resource_type": "tax_rate",
"resource_id": 1,
"resource_version": null,
"schema_version": 1
}
}
Tax Rule Events
tax_rule.created and tax_rule.updated include the full tax rule object:
{
"data": {
"id": 5,
"customer_tax_profile_id": 1,
"item_tax_code_id": 2,
"tax_rate_id": 1,
"priority": 10,
"is_active": true,
"created_at": "2026-01-15T14:30:00Z",
"updated_at": "2026-01-15T14:30:00Z"
},
"meta": {
"event": "tax_rule.created",
"timestamp": "2026-01-15T14:30:00Z",
"event_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"occurred_at": "2026-01-15T14:30:00Z",
"resource_type": "tax_rule",
"resource_id": 5,
"resource_version": "2026-01-15T14:30:00Z",
"schema_version": 1
}
}
| Field |
Type |
Description |
id |
integer |
Tax rule identifier |
customer_tax_profile_id |
integer |
Customer tax profile matched by the rule |
item_tax_code_id |
integer |
Item tax code matched by the rule |
tax_rate_id |
integer |
Tax rate applied when the rule matches |
priority |
integer |
Higher priority rules win when several match |
is_active |
boolean |
Whether the rule is active |
created_at / updated_at |
string |
ISO 8601 UTC timestamps |
tax_rule.deleted sends only the identifier:
{
"data": {
"id": 5
},
"meta": {
"event": "tax_rule.deleted",
"timestamp": "2026-01-15T14:30:00Z",
"event_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"occurred_at": "2026-01-15T14:30:00Z",
"resource_type": "tax_rule",
"resource_id": 5,
"resource_version": null,
"schema_version": 1
}
}
CatalogueItem Archive & Restore Events
catalogue_item.archived and catalogue_item.restored are lifecycle transitions on an existing catalogue item and carry only its identifier. Fetch the current state from GET /api/v1/catalogue_items/{id} if you need the full record.
{
"data": {
"id": 42
},
"meta": {
"event": "catalogue_item.archived",
"timestamp": "2026-01-15T14:30:00Z",
"event_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
"occurred_at": "2026-01-15T14:30:00Z",
"resource_type": "catalogue_item",
"resource_id": 42,
"resource_version": null,
"schema_version": 1
}
}
| Field |
Type |
Description |
id |
integer |
Catalogue item identifier |
Activity reminders
activity.overdue publishes the activity DTO directly in data when open work receives its daily overdue nudge. activity.deleted also includes the captured activity DTO in data, allowing recipients to identify its title, owner and subject after deletion. Activity create, update and completion payloads use the same envelope.
Activity payloads blank participants[].account_name and subject.name when the webhook recipient lacks account identity access. The identifiers remain available. This redaction applies to deletion snapshots too.
Repeating activity events
Each materialised occurrence emits activity.created with its own activity identifier and recurrence_parent_id. Dragging or resizing an occurrence emits activity.updated through the activity update action. Splitting this and following emits activity.updated for the anchor that stops, activity.deleted for the scheduled occurrences being replaced, and activity.created for the replacements. Activity payloads include recurrence_rule, recurrence_until, recurrence_count and recurrence_timezone. Each occurrence completes independently and emits the usual completion or reopen event.