Read the catalogue
Run php artisan signals:events --plugin for the names accepted by listen(). Use --webhook or --workflow to filter other audiences, --family=rental. for a name prefix, and --json for machine-readable rows including samples. Combined audience options intersect their results. The audience columns show effective visibility. System-protected events are not offered to plugins, webhooks or workflows, whatever their configured flags say. Workflow visibility is authoring metadata; it does not by itself guarantee an executable workflow trigger.
The unfiltered command includes all configured events, including system-protected entries. It also includes non-protected runtime registrations, even when all audience flags are false. System-protected runtime registrations are omitted. This generated reference uses only config/events.php; installed plugins cannot change its output. Samples are synthetic configuration examples with declared sensitive paths removed, not database records. A missing sample is shown as no; it does not mean the event has no payload.
listen() and outbound webhooks subscribe by the same event names, using their effective audience visibility. See Hook payloads for the listener envelope. Regenerate with php artisan signals:events --docs; generation ignores runtime filters.
account
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
account.address.created |
|
no |
no |
no |
yes |
no |
account.address.deleted |
|
no |
no |
no |
yes |
no |
account.address.updated |
|
no |
no |
no |
yes |
no |
account.anonymised |
Account anonymised; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
account.archived |
Account archived; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
account.communication_preferences.updated |
|
no |
no |
no |
yes |
no |
account.created |
Account created; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
account.credit_override_granted |
|
no |
yes |
no |
no |
no |
account.deleted |
Account deleted; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
account.email.created |
|
no |
no |
no |
yes |
no |
account.email.deleted |
|
no |
no |
no |
yes |
no |
account.email.updated |
|
no |
no |
no |
yes |
no |
account.lawful_basis_assigned |
|
no |
no |
no |
yes |
no |
account.link.created |
|
no |
no |
no |
yes |
no |
account.link.deleted |
|
no |
no |
no |
yes |
no |
account.link.updated |
|
no |
no |
no |
yes |
no |
account.membership.created |
|
no |
no |
no |
yes |
no |
account.merged |
Account merged; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
account.phone.created |
|
no |
no |
no |
yes |
no |
account.phone.deleted |
|
no |
no |
no |
yes |
no |
account.phone.updated |
|
no |
no |
no |
yes |
no |
account.privacy_artifact_downloaded |
|
no |
no |
no |
yes |
no |
account.privacy_artifact_revoked |
|
no |
no |
no |
yes |
no |
account.privacy_case_approved |
|
no |
no |
no |
yes |
no |
account.privacy_case_created |
|
no |
no |
no |
yes |
no |
account.privacy_case_verified |
|
no |
no |
no |
yes |
no |
account.privacy_hold_placed |
|
no |
no |
no |
yes |
no |
account.privacy_hold_released |
|
no |
no |
no |
yes |
no |
account.relationship.created |
|
no |
no |
no |
yes |
no |
account.relationship.deleted |
|
no |
no |
no |
yes |
no |
account.relationship.updated |
|
no |
no |
no |
yes |
no |
account.restored |
Account restored; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
account.retention_review_created |
|
no |
no |
no |
yes |
no |
account.type_change_rejected |
|
no |
no |
no |
yes |
no |
account.type_converted |
|
no |
no |
no |
yes |
no |
account.updated |
Account updated; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
account.vat_validated |
Account VAT validated; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
account.anonymised sample
{
"account": {
"id": 1
},
"subject": {
"id": 1
}
}
account.archived sample
{
"account": {
"id": 1
},
"subject": {
"id": 1
}
}
account.created sample
{
"account": {
"id": 1
},
"subject": {
"id": 1
}
}
account.deleted sample
{
"account": {
"id": 1
},
"subject": {
"id": 1
}
}
account.merged sample
{
"account": {
"id": 1
},
"subject": {
"id": 1
}
}
account.restored sample
{
"account": {
"id": 1
},
"subject": {
"id": 1
}
}
account.updated sample
{
"account": {
"id": 1
},
"subject": {
"id": 1
}
}
account.vat_validated sample
{
"account": {
"id": 1
},
"subject": {
"id": 1
}
}
activity
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
activity.completed |
Activity completed; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
activity.created |
Activity created; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
activity.deleted |
Activity deleted; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
activity.overdue |
Activity overdue; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
activity.reopened |
Activity reopened; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
activity.updated |
Activity updated; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
activity.completed sample
{
"activity": {
"id": 1
},
"subject": {
"id": 1
}
}
activity.created sample
{
"activity": {
"id": 1
},
"subject": {
"id": 1
}
}
activity.deleted sample
{
"activity": {
"id": 1
},
"subject": {
"id": 1
}
}
activity.overdue sample
{
"activity": {
"id": 1
},
"subject": {
"id": 1
}
}
activity.reopened sample
{
"activity": {
"id": 1
},
"subject": {
"id": 1
}
}
activity.updated sample
{
"activity": {
"id": 1
},
"subject": {
"id": 1
}
}
address
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
address.created |
Address created; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
address.deleted |
Address deleted; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
address.updated |
Address updated; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
address.created sample
{
"address": {
"id": 1
},
"subject": {
"id": 1
}
}
address.deleted sample
{
"address": {
"id": 1
},
"subject": {
"id": 1
}
}
address.updated sample
{
"address": {
"id": 1
},
"subject": {
"id": 1
}
}
api_token
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
api_token.created |
|
no |
no |
no |
yes |
no |
api_token.revoked |
|
no |
no |
no |
yes |
no |
api_token.updated |
|
no |
no |
no |
yes |
no |
approval
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
approval.actioned |
Approval decision recorded on an approval request; evaluated for the request, with the approved subject authorised by its own event family. |
yes |
yes |
yes |
no |
yes |
approval.assigned |
|
yes |
yes |
yes |
no |
no |
approval.chain_archived |
|
yes |
yes |
yes |
no |
no |
approval.chain_deleted |
|
yes |
yes |
yes |
no |
no |
approval.chain_restored |
|
yes |
yes |
yes |
no |
no |
approval.changes_requested |
|
yes |
yes |
yes |
no |
no |
approval.completed |
|
yes |
yes |
yes |
no |
no |
approval.delegated |
|
yes |
yes |
yes |
no |
no |
approval.delegation_expired |
|
yes |
yes |
yes |
no |
no |
approval.delegation_revoked |
|
yes |
yes |
yes |
no |
no |
approval.escalated |
|
yes |
yes |
yes |
no |
no |
approval.escalation_replaced |
|
yes |
yes |
yes |
no |
no |
approval.expired |
|
yes |
yes |
yes |
no |
no |
approval.reassigned |
|
yes |
yes |
yes |
no |
no |
approval.reminded |
|
yes |
yes |
yes |
no |
no |
approval.requested |
|
yes |
yes |
yes |
no |
no |
approval.stage_resolved |
|
yes |
yes |
yes |
no |
no |
approval.stale |
|
yes |
yes |
yes |
no |
no |
approval.actioned sample
{
"approval_request": {
"id": 1
},
"approvable": {
"type": "rental",
"id": 1
},
"subject": {
"id": 1
}
}
asset
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
asset.created |
Asset added to stock; evaluated for the asset it records. |
yes |
yes |
yes |
no |
yes |
asset.deleted |
A asset is deleted. |
yes |
yes |
yes |
no |
yes |
asset.updated |
Asset details changed; evaluated for the asset it records. |
yes |
yes |
yes |
no |
yes |
asset.created sample
{
"asset": {
"id": 1
},
"subject": {
"id": 1
}
}
asset.deleted sample
{
"asset": {
"id": 1,
"catalogue_item_id": 1,
"warehouse_id": 1
},
"subject": {
"id": 1,
"type": "asset"
},
"changed_fields": []
}
asset.updated sample
{
"asset": {
"id": 1
},
"subject": {
"id": 1
}
}
asset_cost
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
asset_cost.created |
Asset cost recorded; evaluated for the asset it is charged to. |
yes |
yes |
yes |
no |
yes |
asset_cost.deleted |
Asset cost removed; evaluated for the asset it was charged to. |
yes |
yes |
yes |
no |
yes |
asset_cost.updated |
Asset cost amended; evaluated for the asset it is charged to. |
yes |
yes |
yes |
no |
yes |
asset_cost.created sample
{
"asset_cost": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
asset_cost.deleted sample
{
"asset_cost": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
asset_cost.updated sample
{
"asset_cost": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
asset_ledger_entry
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
asset_ledger_entry.created |
Stock movement recorded; evaluated for the asset it moves. |
yes |
yes |
yes |
no |
yes |
asset_ledger_entry.deleted |
Stock movement reversed; evaluated for the asset it moved. |
yes |
yes |
yes |
no |
yes |
asset_ledger_entry.created sample
{
"asset_ledger_entry": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
asset_ledger_entry.deleted sample
{
"asset_ledger_entry": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
asset_retirement
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
asset_retirement.created |
Asset retired from the fleet; evaluated for the asset it disposes. |
yes |
yes |
yes |
no |
yes |
asset_retirement.reinstated |
Retired asset reinstated; evaluated for the asset it returns to stock. |
yes |
yes |
yes |
no |
yes |
asset_retirement.voided |
Asset retirement voided; evaluated for the asset it disposed. |
yes |
yes |
yes |
no |
yes |
asset_retirement.created sample
{
"asset_retirement": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
asset_retirement.reinstated sample
{
"asset_retirement": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
asset_retirement.voided sample
{
"asset_retirement": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
assignment
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
assignment.created |
|
yes |
no |
no |
no |
no |
assignment.creating |
|
yes |
no |
no |
no |
no |
assignment.query |
|
yes |
no |
no |
no |
no |
assignment.status_changed |
|
yes |
no |
no |
no |
no |
assignment_route_stop
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
assignment_route_stop.created |
A new assignment route stop is added. |
yes |
yes |
yes |
no |
yes |
assignment_route_stop.deleted |
A assignment route stop is deleted. |
yes |
yes |
yes |
no |
yes |
assignment_route_stop.reordered |
|
yes |
yes |
yes |
no |
no |
assignment_route_stop.updated |
A assignment route stop's details change. |
yes |
yes |
yes |
no |
yes |
assignment_route_stop.created sample
{
"assignment_route_stop": {
"id": 1,
"resource_assignment_id": 1,
"position": 1,
"stop_type": "Example stop type"
},
"subject": {
"id": 1,
"type": "assignment_route_stop"
},
"changed_fields": []
}
assignment_route_stop.deleted sample
{
"assignment_route_stop": {
"id": 1,
"resource_assignment_id": 1,
"position": 1,
"stop_type": "Example stop type"
},
"subject": {
"id": 1,
"type": "assignment_route_stop"
},
"changed_fields": []
}
assignment_route_stop.updated sample
{
"assignment_route_stop": {
"id": 1,
"resource_assignment_id": 1,
"position": 1,
"stop_type": "Example stop type"
},
"subject": {
"id": 1,
"type": "assignment_route_stop"
},
"changed_fields": [
"position"
]
}
attachment
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
attachment.created |
|
yes |
yes |
yes |
no |
no |
attachment.deleted |
|
yes |
yes |
yes |
no |
no |
auth
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
auth.magic_link_consumed |
|
no |
no |
no |
yes |
no |
auth.magic_link_login |
|
no |
no |
no |
yes |
no |
auth.magic_link_requested |
|
no |
no |
no |
yes |
no |
auth.sso_login |
|
no |
no |
no |
yes |
no |
auth.two_factor_recovered |
|
no |
no |
no |
yes |
no |
availability
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
availability.changed |
|
yes |
yes |
yes |
no |
no |
base_currency_identity
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
base_currency_identity.backfilled |
|
no |
no |
no |
yes |
no |
base_currency_identity.refreshed |
|
no |
no |
no |
yes |
no |
billing_run
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
billing_run.completed |
|
yes |
yes |
yes |
no |
no |
billing_run.created |
|
yes |
yes |
yes |
no |
no |
bundle_rule
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
bundle_rule.created |
A new bundle rule is added. |
yes |
yes |
yes |
no |
yes |
bundle_rule.deleted |
A bundle rule is deleted. |
yes |
yes |
yes |
no |
yes |
bundle_rule.updated |
A bundle rule's details change. |
yes |
yes |
yes |
no |
yes |
bundle_rule.created sample
{
"bundle_rule": {
"id": 1,
"name": "Example bundle rule"
},
"subject": {
"id": 1,
"type": "bundle_rule"
},
"changed_fields": []
}
bundle_rule.deleted sample
{
"bundle_rule": {
"id": 1,
"name": "Example bundle rule"
},
"subject": {
"id": 1,
"type": "bundle_rule"
},
"changed_fields": []
}
bundle_rule.updated sample
{
"bundle_rule": {
"id": 1,
"name": "Example bundle rule"
},
"subject": {
"id": 1,
"type": "bundle_rule"
},
"changed_fields": [
"name"
]
}
cache
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
cache.domain.invalidated |
|
no |
no |
no |
yes |
no |
catalogue_item
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
catalogue_item.archived |
|
yes |
yes |
yes |
no |
no |
catalogue_item.created |
A new catalogue item is added. |
yes |
yes |
yes |
no |
yes |
catalogue_item.deleted |
A catalogue item is deleted. |
yes |
yes |
yes |
no |
yes |
catalogue_item.flightcase_config.updated |
|
yes |
yes |
yes |
no |
no |
catalogue_item.identity_repaired |
|
no |
no |
no |
yes |
no |
catalogue_item.merged |
|
yes |
yes |
yes |
no |
no |
catalogue_item.restored |
A deleted catalogue item is brought back. |
yes |
yes |
yes |
no |
yes |
catalogue_item.tags_synced |
|
no |
no |
no |
yes |
no |
catalogue_item.updated |
A catalogue item's details change. |
yes |
yes |
yes |
no |
yes |
catalogue_item.created sample
{
"catalogue_item": {
"id": 1,
"name": "Example catalogue item"
},
"subject": {
"id": 1,
"type": "catalogue_item"
},
"changed_fields": []
}
catalogue_item.deleted sample
{
"catalogue_item": {
"id": 1,
"name": "Example catalogue item"
},
"subject": {
"id": 1,
"type": "catalogue_item"
},
"changed_fields": []
}
catalogue_item.restored sample
{
"catalogue_item": {
"id": 1,
"name": "Example catalogue item"
},
"subject": {
"id": 1,
"type": "catalogue_item"
},
"changed_fields": []
}
catalogue_item.updated sample
{
"catalogue_item": {
"id": 1,
"name": "Example catalogue item"
},
"subject": {
"id": 1,
"type": "catalogue_item"
},
"changed_fields": [
"name"
]
}
catalogue_item_group
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
catalogue_item_group.created |
A new catalogue item group is added. |
yes |
yes |
yes |
no |
yes |
catalogue_item_group.deleted |
A catalogue item group is deleted. |
yes |
yes |
yes |
no |
yes |
catalogue_item_group.updated |
A catalogue item group's details change. |
yes |
yes |
yes |
no |
yes |
catalogue_item_group.created sample
{
"catalogue_item_group": {
"id": 1,
"name": "Example catalogue item group"
},
"subject": {
"id": 1,
"type": "catalogue_item_group"
},
"changed_fields": []
}
catalogue_item_group.deleted sample
{
"catalogue_item_group": {
"id": 1,
"name": "Example catalogue item group"
},
"subject": {
"id": 1,
"type": "catalogue_item_group"
},
"changed_fields": []
}
catalogue_item_group.updated sample
{
"catalogue_item_group": {
"id": 1,
"name": "Example catalogue item group"
},
"subject": {
"id": 1,
"type": "catalogue_item_group"
},
"changed_fields": [
"name"
]
}
catalogue_item_price
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
catalogue_item_price.created |
A new catalogue item price is added. |
yes |
yes |
yes |
no |
yes |
catalogue_item_price.deleted |
A catalogue item price is deleted. |
yes |
yes |
yes |
no |
yes |
catalogue_item_price.updated |
A catalogue item price's details change. |
yes |
yes |
yes |
no |
yes |
catalogue_item_price.created sample
{
"catalogue_item_price": {
"id": 1,
"catalogue_item_id": 1,
"rate_specification_id": 1,
"price": "1.00",
"currency": "GBP"
},
"subject": {
"id": 1,
"type": "catalogue_item_price"
},
"changed_fields": []
}
catalogue_item_price.deleted sample
{
"catalogue_item_price": {
"id": 1,
"catalogue_item_id": 1,
"rate_specification_id": 1,
"price": "1.00",
"currency": "GBP"
},
"subject": {
"id": 1,
"type": "catalogue_item_price"
},
"changed_fields": []
}
catalogue_item_price.updated sample
{
"catalogue_item_price": {
"id": 1,
"catalogue_item_id": 1,
"rate_specification_id": 1,
"price": "1.00",
"currency": "GBP"
},
"subject": {
"id": 1,
"type": "catalogue_item_price"
},
"changed_fields": [
"catalogue_item_id"
]
}
catalogue_item_supplier
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
catalogue_item_supplier.created |
A new catalogue item supplier is added. |
yes |
yes |
yes |
no |
yes |
catalogue_item_supplier.deleted |
A catalogue item supplier is deleted. |
yes |
yes |
yes |
no |
yes |
catalogue_item_supplier.updated |
A catalogue item supplier's details change. |
yes |
yes |
yes |
no |
yes |
catalogue_item_supplier.created sample
{
"catalogue_item_supplier": {
"id": 1,
"catalogue_item_id": 1,
"supplier_id": 1,
"supplier_sku": "Example supplier sku"
},
"subject": {
"id": 1,
"type": "catalogue_item_supplier"
},
"changed_fields": []
}
catalogue_item_supplier.deleted sample
{
"catalogue_item_supplier": {
"id": 1,
"catalogue_item_id": 1,
"supplier_id": 1,
"supplier_sku": "Example supplier sku"
},
"subject": {
"id": 1,
"type": "catalogue_item_supplier"
},
"changed_fields": []
}
catalogue_item_supplier.updated sample
{
"catalogue_item_supplier": {
"id": 1,
"catalogue_item_id": 1,
"supplier_id": 1,
"supplier_sku": "Example supplier sku"
},
"subject": {
"id": 1,
"type": "catalogue_item_supplier"
},
"changed_fields": [
"catalogue_item_id"
]
}
catalogue_tag
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
catalogue_tag.created |
|
no |
no |
no |
yes |
no |
catalogue_tag.deleted |
|
no |
no |
no |
yes |
no |
catalogue_tag.updated |
|
no |
no |
no |
yes |
no |
certification
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
certification.expiring |
|
no |
no |
no |
yes |
no |
communication_draft
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
communication_draft.approved |
Drafted customer communication approved; evaluated for the draft it records. |
yes |
yes |
yes |
no |
yes |
communication_draft.created |
Customer communication drafted for approval; evaluated for the draft it records. |
yes |
yes |
yes |
no |
yes |
communication_draft.discarded |
Drafted customer communication discarded; evaluated for the draft it records. |
yes |
yes |
yes |
no |
yes |
communication_draft.sent |
Approved customer communication sent; evaluated for the draft it records. |
yes |
yes |
yes |
no |
yes |
communication_draft.approved sample
{
"communication_draft": {
"id": 1
},
"subject": {
"id": 1
}
}
communication_draft.created sample
{
"communication_draft": {
"id": 1
},
"subject": {
"id": 1
}
}
communication_draft.discarded sample
{
"communication_draft": {
"id": 1
},
"subject": {
"id": 1
}
}
communication_draft.sent sample
{
"communication_draft": {
"id": 1
},
"subject": {
"id": 1
}
}
communication_log
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
communication_log.status_changed |
|
no |
no |
no |
yes |
no |
communication_template
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
communication_template.created |
A new communication template is added. |
yes |
yes |
yes |
no |
yes |
communication_template.deleted |
A communication template is deleted. |
yes |
yes |
yes |
no |
yes |
communication_template.updated |
A communication template's details change. |
yes |
yes |
yes |
no |
yes |
communication_template.created sample
{
"communication_template": {
"id": 1,
"name": "Example communication template"
},
"subject": {
"id": 1,
"type": "communication_template"
},
"changed_fields": []
}
communication_template.deleted sample
{
"communication_template": {
"id": 1,
"name": "Example communication template"
},
"subject": {
"id": 1,
"type": "communication_template"
},
"changed_fields": []
}
communication_template.updated sample
{
"communication_template": {
"id": 1,
"name": "Example communication template"
},
"subject": {
"id": 1,
"type": "communication_template"
},
"changed_fields": [
"name"
]
}
conflict
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
conflict.detected |
|
yes |
no |
no |
no |
no |
conversation
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
conversation.created |
Conversation created; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
conversation.deleted |
Conversation deleted; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
conversation.mentioned |
Conversation mentioned; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
conversation.updated |
Conversation updated; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
conversation.created sample
{
"conversation": {
"id": 1
},
"subject": {
"id": 1
}
}
conversation.deleted sample
{
"conversation": {
"id": 1
},
"subject": {
"id": 1
}
}
conversation.mentioned sample
{
"conversation": {
"id": 1
},
"subject": {
"id": 1
}
}
conversation.updated sample
{
"conversation": {
"id": 1
},
"subject": {
"id": 1
}
}
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
conversation_comment.created |
Conversation comment created; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
conversation_comment.deleted |
Conversation comment deleted; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
conversation_comment.updated |
Conversation comment updated; evaluated for its owning account. |
yes |
yes |
yes |
no |
yes |
conversation_comment.created sample
{
"conversation_comment": {
"id": 1
},
"subject": {
"id": 1
}
}
conversation_comment.deleted sample
{
"conversation_comment": {
"id": 1
},
"subject": {
"id": 1
}
}
conversation_comment.updated sample
{
"conversation_comment": {
"id": 1
},
"subject": {
"id": 1
}
}
country
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
country.activated |
|
no |
no |
no |
yes |
no |
country.deactivated |
|
no |
no |
no |
yes |
no |
credit_note
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
credit_note.applied |
Credit note applied to an invoice; evaluated for its owning invoice. |
yes |
yes |
yes |
no |
yes |
credit_note.draft_created |
Credit note raised as a draft; evaluated for its owning invoice. |
yes |
yes |
yes |
no |
yes |
credit_note.issued |
Credit note issued; evaluated for its owning invoice. |
yes |
yes |
yes |
no |
yes |
credit_note.updated |
Credit note amended; evaluated for its owning invoice. |
yes |
yes |
yes |
no |
yes |
credit_note.voided |
Credit note voided; evaluated for its owning invoice. |
yes |
yes |
yes |
no |
yes |
credit_note.applied v2 sample
{
"schema_version": 2,
"event": "credit_note.applied",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "credit_notes",
"id": 2,
"revision": null
},
"related": [],
"data": {
"id": 2
}
}
credit_note.applied sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
credit_note.draft_created v2 sample
{
"schema_version": 2,
"event": "credit_note.draft_created",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "credit_notes",
"id": 2,
"revision": null
},
"related": [],
"data": {
"id": 2
}
}
credit_note.draft_created sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
credit_note.issued v2 sample
{
"schema_version": 2,
"event": "credit_note.issued",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "credit_notes",
"id": 2,
"revision": null
},
"related": [],
"data": {
"id": 2
}
}
credit_note.issued sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
credit_note.updated v2 sample
{
"schema_version": 2,
"event": "credit_note.updated",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "credit_notes",
"id": 2,
"revision": null
},
"related": [],
"data": {
"id": 2
}
}
credit_note.updated sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
credit_note.voided v2 sample
{
"schema_version": 2,
"event": "credit_note.voided",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "credit_notes",
"id": 2,
"revision": null
},
"related": [],
"data": {
"id": 2
}
}
credit_note.voided sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
currency
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
currency.created |
|
yes |
yes |
yes |
no |
no |
currency.deleted |
|
yes |
yes |
yes |
no |
no |
currency.updated |
|
yes |
yes |
yes |
no |
no |
custom_field
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
custom_field.created |
|
no |
no |
no |
yes |
no |
custom_field.deleted |
|
no |
no |
no |
yes |
no |
custom_field.updated |
|
no |
no |
no |
yes |
no |
custom_field_group
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
custom_field_group.created |
|
no |
no |
no |
yes |
no |
custom_field_group.deleted |
|
no |
no |
no |
yes |
no |
custom_field_group.updated |
|
no |
no |
no |
yes |
no |
customer_tax_profile
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
customer_tax_profile.created |
|
yes |
yes |
yes |
no |
no |
customer_tax_profile.deleted |
|
yes |
yes |
yes |
no |
no |
customer_tax_profile.updated |
|
yes |
yes |
yes |
no |
no |
dashboard
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
dashboard.share.published |
|
no |
no |
no |
yes |
no |
dashboard.share.republished |
|
no |
no |
no |
yes |
no |
dashboard.share.unpublished |
|
no |
no |
no |
yes |
no |
demand
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
demand.unmet |
|
yes |
no |
no |
no |
no |
demo
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
demo.clear_refused |
|
no |
no |
no |
yes |
no |
discount_group
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
discount_group.created |
A new discount group is added. |
yes |
yes |
yes |
no |
yes |
discount_group.deleted |
A discount group is deleted. |
yes |
yes |
yes |
no |
yes |
discount_group.updated |
A discount group's details change. |
yes |
yes |
yes |
no |
yes |
discount_group.created sample
{
"discount_group": {
"id": 1,
"name": "Example discount group"
},
"subject": {
"id": 1,
"type": "discount_group"
},
"changed_fields": []
}
discount_group.deleted sample
{
"discount_group": {
"id": 1,
"name": "Example discount group"
},
"subject": {
"id": 1,
"type": "discount_group"
},
"changed_fields": []
}
discount_group.updated sample
{
"discount_group": {
"id": 1,
"name": "Example discount group"
},
"subject": {
"id": 1,
"type": "discount_group"
},
"changed_fields": [
"name"
]
}
discount_rule
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
discount_rule.created |
A new discount rule is added. |
yes |
yes |
yes |
no |
yes |
discount_rule.deleted |
A discount rule is deleted. |
yes |
yes |
yes |
no |
yes |
discount_rule.updated |
A discount rule's details change. |
yes |
yes |
yes |
no |
yes |
discount_rule.created sample
{
"discount_rule": {
"id": 1,
"discount_group_id": 1,
"discount_percent": "1.00",
"rule_scope": "Example rule scope"
},
"subject": {
"id": 1,
"type": "discount_rule"
},
"changed_fields": []
}
discount_rule.deleted sample
{
"discount_rule": {
"id": 1,
"discount_group_id": 1,
"discount_percent": "1.00",
"rule_scope": "Example rule scope"
},
"subject": {
"id": 1,
"type": "discount_rule"
},
"changed_fields": []
}
discount_rule.updated sample
{
"discount_rule": {
"id": 1,
"discount_group_id": 1,
"discount_percent": "1.00",
"rule_scope": "Example rule scope"
},
"subject": {
"id": 1,
"type": "discount_rule"
},
"changed_fields": [
"discount_group_id"
]
}
dispatch
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
dispatch.stage_advanced |
|
yes |
yes |
yes |
no |
no |
document
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
document.approval_requested |
Document shared with the customer for approval; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.approved |
Customer approved a shared document; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.created |
Document generated; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.declined |
Customer declined a shared document; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.emailed |
Document emailed to a recipient; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.finalised |
Document finalised; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.link_shared |
|
no |
no |
no |
no |
no |
document.pdf_generated |
Document PDF rendered; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.portal_question |
Customer asked a question from the document portal; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.printed |
|
no |
no |
no |
no |
no |
document.public_link_accessed |
Public document link opened for the first time; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.public_link_configured |
Public document link expiry or PIN reconfigured; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.public_link_created |
Public document link created or rotated; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.public_link_revoked |
Public document link revoked; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.voided |
Document voided; evaluated for the document it records. |
yes |
yes |
yes |
no |
yes |
document.approval_requested sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.approved sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.created sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.declined sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.emailed sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.finalised sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.pdf_generated sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.portal_question sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.public_link_accessed sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.public_link_configured sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.public_link_created sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.public_link_revoked sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document.voided sample
{
"document": {
"id": 1
},
"subject": {
"id": 1
}
}
document_sequence
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
document_sequence.reset |
|
yes |
yes |
yes |
no |
no |
document_sequence.updated |
|
yes |
yes |
yes |
no |
no |
document_template
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
document_template.created |
A new document template is added. |
yes |
yes |
yes |
no |
yes |
document_template.deleted |
A document template is deleted. |
yes |
yes |
yes |
no |
yes |
document_template.restored |
A deleted document template is brought back. |
yes |
yes |
yes |
no |
yes |
document_template.set_as_default |
|
yes |
yes |
yes |
no |
no |
document_template.updated |
A document template's details change. |
yes |
yes |
yes |
no |
yes |
document_template.created sample
{
"document_template": {
"id": 1,
"name": "Example document template"
},
"subject": {
"id": 1,
"type": "document_template"
},
"changed_fields": []
}
document_template.deleted sample
{
"document_template": {
"id": 1,
"name": "Example document template"
},
"subject": {
"id": 1,
"type": "document_template"
},
"changed_fields": []
}
document_template.restored sample
{
"document_template": {
"id": 1,
"name": "Example document template"
},
"subject": {
"id": 1,
"type": "document_template"
},
"changed_fields": []
}
document_template.updated sample
{
"document_template": {
"id": 1,
"name": "Example document template"
},
"subject": {
"id": 1,
"type": "document_template"
},
"changed_fields": [
"name"
]
}
email_layout
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
email_layout.created |
A new email layout is added. |
yes |
yes |
yes |
no |
yes |
email_layout.deleted |
A email layout is deleted. |
yes |
yes |
yes |
no |
yes |
email_layout.set_as_default |
|
yes |
yes |
yes |
no |
no |
email_layout.updated |
A email layout's details change. |
yes |
yes |
yes |
no |
yes |
email_layout.created sample
{
"email_layout": {
"id": 1,
"key": "Example email layout",
"name": "Example email layout"
},
"subject": {
"id": 1,
"type": "email_layout"
},
"changed_fields": []
}
email_layout.deleted sample
{
"email_layout": {
"id": 1,
"key": "Example email layout",
"name": "Example email layout"
},
"subject": {
"id": 1,
"type": "email_layout"
},
"changed_fields": []
}
email_layout.updated sample
{
"email_layout": {
"id": 1,
"key": "Example email layout",
"name": "Example email layout"
},
"subject": {
"id": 1,
"type": "email_layout"
},
"changed_fields": [
"key"
]
}
email_template
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
email_template.created |
A new email template is added. |
yes |
yes |
yes |
no |
yes |
email_template.deleted |
A email template is deleted. |
yes |
yes |
yes |
no |
yes |
email_template.reset |
|
yes |
yes |
yes |
no |
no |
email_template.updated |
A email template's details change. |
yes |
yes |
yes |
no |
yes |
email_template.created sample
{
"email_template": {
"id": 1,
"key": "Example email template",
"name": "Example email template"
},
"subject": {
"id": 1,
"type": "email_template"
},
"changed_fields": []
}
email_template.deleted sample
{
"email_template": {
"id": 1,
"key": "Example email template",
"name": "Example email template"
},
"subject": {
"id": 1,
"type": "email_template"
},
"changed_fields": []
}
email_template.updated sample
{
"email_template": {
"id": 1,
"key": "Example email template",
"name": "Example email template"
},
"subject": {
"id": 1,
"type": "email_template"
},
"changed_fields": [
"key"
]
}
equipment_test
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
equipment_test.auto_repair_rejected |
|
no |
no |
no |
yes |
no |
equipment_test.completed |
Equipment test completed; evaluated for the asset it was performed on. |
yes |
yes |
yes |
no |
yes |
equipment_test.created |
A new equipment test is added. |
yes |
yes |
yes |
no |
yes |
equipment_test.deleted |
A equipment test is deleted. |
yes |
yes |
yes |
no |
yes |
equipment_test.dispatch_acknowledged |
|
no |
no |
no |
yes |
no |
equipment_test.due |
|
no |
no |
no |
yes |
no |
equipment_test.failed |
Equipment test failed; evaluated for the asset it was performed on. |
yes |
yes |
yes |
no |
yes |
equipment_test.overdue |
|
no |
no |
no |
yes |
no |
equipment_test.updated |
A equipment test's details change. |
yes |
yes |
yes |
no |
yes |
equipment_test.completed sample
{
"equipment_test_result": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
equipment_test.created sample
{
"equipment_test": {
"id": 1,
"name": "Example equipment test"
},
"subject": {
"id": 1,
"type": "equipment_test"
},
"changed_fields": []
}
equipment_test.deleted sample
{
"equipment_test": {
"id": 1,
"name": "Example equipment test"
},
"subject": {
"id": 1,
"type": "equipment_test"
},
"changed_fields": []
}
equipment_test.failed sample
{
"equipment_test_result": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
equipment_test.updated sample
{
"equipment_test": {
"id": 1,
"name": "Example equipment test"
},
"subject": {
"id": 1,
"type": "equipment_test"
},
"changed_fields": [
"name"
]
}
equipment_test_certificate
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
equipment_test_certificate.issued |
Equipment test certificate issued; evaluated for the asset it certifies. |
yes |
yes |
yes |
no |
yes |
equipment_test_certificate.issued sample
{
"equipment_test_result": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
equipment_test_result
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
equipment_test_result.created |
Equipment test result recorded; evaluated for the asset it was performed on. |
yes |
yes |
yes |
no |
yes |
equipment_test_result.deleted |
Equipment test result removed; evaluated for the asset it was performed on. |
yes |
yes |
yes |
no |
yes |
equipment_test_result.updated |
Equipment test result amended; evaluated for the asset it was performed on. |
yes |
yes |
yes |
no |
yes |
equipment_test_result.voided |
Equipment test result voided; evaluated for the asset it was performed on. |
yes |
yes |
no |
no |
yes |
equipment_test_result.created sample
{
"equipment_test_result": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
equipment_test_result.deleted sample
{
"equipment_test_result": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
equipment_test_result.updated sample
{
"equipment_test_result": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
equipment_test_result.voided sample
{
"equipment_test_result": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
evidence_fact
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
evidence_fact.applied |
|
no |
no |
no |
yes |
no |
evidence_fact.dismissed |
|
no |
no |
no |
yes |
no |
evidence_fact.held |
|
no |
no |
no |
yes |
no |
evidence_fact.proposed |
|
no |
no |
no |
yes |
no |
evidence_fact.suggested |
|
no |
no |
no |
yes |
no |
evidence_fact.verified |
|
no |
no |
no |
yes |
no |
exchange_rate
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
exchange_rate.created |
|
yes |
yes |
yes |
no |
no |
exchange_rate.deleted |
|
yes |
yes |
yes |
no |
no |
exchange_rate.updated |
|
yes |
yes |
yes |
no |
no |
export
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
export.cancelled |
|
yes |
no |
yes |
no |
no |
export.completed |
|
yes |
yes |
yes |
no |
no |
export.created |
|
yes |
no |
yes |
no |
no |
export.deleted |
|
yes |
yes |
yes |
no |
no |
export.failed |
|
yes |
yes |
yes |
no |
no |
external_connection_grant
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
external_connection_grant.approved |
|
no |
no |
no |
yes |
no |
external_connection_grant.revoked |
|
no |
no |
no |
yes |
no |
facility
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
facility.created |
A new facility is added. |
yes |
yes |
yes |
no |
yes |
facility.deleted |
A facility is deleted. |
yes |
yes |
yes |
no |
yes |
facility.updated |
A facility's details change. |
yes |
yes |
yes |
no |
yes |
facility.created sample
{
"facility": {
"id": 1,
"name": "Example facility"
},
"subject": {
"id": 1,
"type": "facility"
},
"changed_fields": []
}
facility.deleted sample
{
"facility": {
"id": 1,
"name": "Example facility"
},
"subject": {
"id": 1,
"type": "facility"
},
"changed_fields": []
}
facility.updated sample
{
"facility": {
"id": 1,
"name": "Example facility"
},
"subject": {
"id": 1,
"type": "facility"
},
"changed_fields": [
"name"
]
}
flightcase
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
flightcase.checkin_verified |
Flightcase check-in verified; evaluated for the flightcase it clears. |
yes |
yes |
yes |
no |
yes |
flightcase.contents_overrun |
|
no |
no |
no |
yes |
no |
flightcase.created |
Flightcase created; evaluated for the flightcase it opens. |
yes |
yes |
yes |
no |
yes |
flightcase.dispatched |
Flightcase dispatched on a rental; evaluated for the flightcase it sends out. |
yes |
yes |
yes |
no |
yes |
flightcase.dissolved |
Flightcase dissolved; evaluated for the flightcase it empties. |
yes |
yes |
yes |
no |
yes |
flightcase.item.packed |
Item packed into a flightcase; evaluated for the flightcase it was packed into. |
yes |
yes |
yes |
no |
yes |
flightcase.item.transferred |
Item transferred between flightcases; evaluated for the destination flightcase it arrived in. |
yes |
yes |
yes |
no |
yes |
flightcase.item.unpacked |
Item unpacked from a flightcase; evaluated for the flightcase it left. |
yes |
yes |
yes |
no |
yes |
flightcase.nested |
Flightcase nested inside another; evaluated for the nested child flightcase. |
yes |
yes |
yes |
no |
yes |
flightcase.repack.item |
|
no |
no |
no |
yes |
no |
flightcase.repack.started |
Flightcase repack on return started; evaluated for the flightcase it repacks into. |
yes |
yes |
yes |
no |
yes |
flightcase.returned |
Flightcase returned from a rental; evaluated for the flightcase it books back in. |
yes |
yes |
yes |
no |
yes |
flightcase.sealed |
Flightcase sealed; evaluated for the flightcase it closes. |
yes |
yes |
yes |
no |
yes |
flightcase.unsealed |
Flightcase unsealed; evaluated for the flightcase it reopens. |
yes |
yes |
yes |
no |
yes |
flightcase.updated |
Flightcase updated; evaluated for the flightcase it changes. |
yes |
yes |
yes |
no |
yes |
flightcase.checkin_verified sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.created sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.dispatched sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.dissolved sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.item.packed sample
{
"flightcase_item": {
"id": 1,
"flightcase_id": 1
},
"subject": {
"id": 1
}
}
flightcase.item.transferred sample
{
"flightcase_item": {
"id": 1,
"flightcase_id": 1
},
"subject": {
"id": 1
}
}
flightcase.item.unpacked sample
{
"flightcase_item": {
"id": 1,
"flightcase_id": 1
},
"subject": {
"id": 1
}
}
flightcase.nested sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.repack.started sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.returned sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.sealed sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.unsealed sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
flightcase.updated sample
{
"flightcase": {
"id": 1
},
"subject": {
"id": 1
}
}
identifier_generation_rule
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
identifier_generation_rule.created |
|
no |
no |
no |
yes |
no |
identifier_generation_rule.deleted |
|
no |
no |
no |
yes |
no |
identifier_generation_rule.updated |
|
no |
no |
no |
yes |
no |
import
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
import.batch.cancelled |
|
yes |
no |
yes |
no |
no |
import.batch.commit_started |
|
yes |
no |
yes |
no |
no |
import.batch.committed |
|
yes |
yes |
yes |
no |
no |
import.batch.failed |
|
yes |
yes |
yes |
no |
no |
import.batch.parsing |
|
yes |
yes |
yes |
no |
no |
import.batch.paused |
|
yes |
yes |
yes |
no |
no |
import.batch.profile_applied |
|
yes |
no |
yes |
no |
no |
import.batch.queued |
|
yes |
no |
yes |
no |
no |
import.batch.resumed |
|
yes |
no |
yes |
no |
no |
import.batch.validated |
|
yes |
yes |
yes |
no |
no |
import.plan.completed |
|
yes |
no |
yes |
no |
no |
import.plan.created |
|
yes |
no |
yes |
no |
no |
import.plan.execution_started |
|
yes |
no |
yes |
no |
no |
import.plan.failed |
|
yes |
yes |
yes |
no |
no |
import.plan.paused |
|
yes |
no |
yes |
no |
no |
import.plan.resumed |
|
yes |
no |
yes |
no |
no |
import.plan.started |
|
yes |
yes |
yes |
no |
no |
import.plan.step_completed |
|
yes |
yes |
yes |
no |
no |
import.plan.undone |
|
yes |
no |
yes |
no |
no |
import_profile
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
import_profile.created |
|
no |
no |
no |
yes |
no |
import_profile.deleted |
|
no |
no |
no |
yes |
no |
import_profile.shared |
|
no |
no |
no |
yes |
no |
import_profile.updated |
|
no |
no |
no |
yes |
no |
inbound_webhook_source
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
inbound_webhook_source.active_toggled |
|
no |
no |
no |
yes |
no |
inbound_webhook_source.created |
|
no |
no |
no |
yes |
no |
inbound_webhook_source.deleted |
|
no |
no |
no |
yes |
no |
inbound_webhook_source.secret_rotated |
|
no |
no |
no |
yes |
no |
inbound_webhook_source.updated |
|
no |
no |
no |
yes |
no |
invoice
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
invoice.created |
Invoice created; evaluated for the invoice it records. |
yes |
yes |
yes |
no |
yes |
invoice.deleted |
|
no |
no |
no |
yes |
no |
invoice.issued |
Invoice issued to the customer; evaluated for the invoice it records. |
yes |
yes |
yes |
no |
yes |
invoice.item_added |
|
no |
no |
no |
yes |
no |
invoice.item_removed |
|
no |
no |
no |
yes |
no |
invoice.item_updated |
|
no |
no |
no |
yes |
no |
invoice.items_reordered |
|
no |
no |
no |
yes |
no |
invoice.overdue |
Invoice passed its due date unpaid; evaluated for the invoice it records. |
yes |
yes |
yes |
no |
yes |
invoice.portal_payment_received |
|
yes |
yes |
yes |
no |
no |
invoice.updated |
|
no |
no |
no |
yes |
no |
invoice.voided |
Invoice voided; evaluated for the invoice it records. |
yes |
yes |
yes |
no |
yes |
invoice.created v2 sample
{
"schema_version": 2,
"event": "invoice.created",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
invoice.created sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
invoice.issued v2 sample
{
"schema_version": 2,
"event": "invoice.issued",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
invoice.issued sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
invoice.overdue v2 sample
{
"schema_version": 2,
"event": "invoice.overdue",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
invoice.overdue sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
invoice.voided v2 sample
{
"schema_version": 2,
"event": "invoice.voided",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
invoice.voided sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
invoice_payment
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
invoice_payment.updated |
Recorded payment amended; evaluated for its owning invoice. |
yes |
yes |
yes |
no |
yes |
invoice_payment.updated v2 sample
{
"schema_version": 2,
"event": "invoice_payment.updated",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "payments",
"id": 2,
"revision": null
},
"related": [],
"data": {
"id": 2
}
}
invoice_payment.updated sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
item_tax_code
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
item_tax_code.created |
|
yes |
yes |
yes |
no |
no |
item_tax_code.deleted |
|
yes |
yes |
yes |
no |
no |
item_tax_code.updated |
|
yes |
yes |
yes |
no |
no |
kit_component
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
kit_component.created |
A new kit component is added. |
yes |
yes |
yes |
no |
yes |
kit_component.deleted |
A kit component is deleted. |
yes |
yes |
yes |
no |
yes |
kit_component.updated |
A kit component's details change. |
yes |
yes |
yes |
no |
yes |
kit_component.created sample
{
"kit_component": {
"id": 1,
"component_name": "Example component name",
"catalogue_item_id": 1,
"component_catalogue_item_id": 1,
"quantity": "1.00"
},
"subject": {
"id": 1,
"type": "kit_component"
},
"changed_fields": []
}
kit_component.deleted sample
{
"kit_component": {
"id": 1,
"component_name": "Example component name",
"catalogue_item_id": 1,
"component_catalogue_item_id": 1,
"quantity": "1.00"
},
"subject": {
"id": 1,
"type": "kit_component"
},
"changed_fields": []
}
kit_component.updated sample
{
"kit_component": {
"id": 1,
"component_name": "Example component name",
"catalogue_item_id": 1,
"component_catalogue_item_id": 1,
"quantity": "1.00"
},
"subject": {
"id": 1,
"type": "kit_component"
},
"changed_fields": [
"quantity"
]
}
language
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
language.activated |
|
no |
no |
no |
yes |
no |
language.created |
|
no |
no |
no |
yes |
no |
language.deactivated |
|
no |
no |
no |
yes |
no |
language.deleted |
|
no |
no |
no |
yes |
no |
language.set_default |
|
no |
no |
no |
yes |
no |
language.strings_imported |
|
no |
no |
no |
yes |
no |
language_string
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
language_string.updated |
|
no |
no |
no |
yes |
no |
list_entry
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
list_entry.created |
A new list entry is added. |
yes |
yes |
yes |
no |
yes |
list_entry.deleted |
A list entry is deleted. |
yes |
yes |
yes |
no |
yes |
list_entry.updated |
A list entry's details change. |
yes |
yes |
yes |
no |
yes |
list_entry.created sample
{
"list_entry": {
"id": 1,
"name": "Example list entry"
},
"subject": {
"id": 1,
"type": "list_entry"
},
"changed_fields": []
}
list_entry.deleted sample
{
"list_entry": {
"id": 1,
"name": "Example list entry"
},
"subject": {
"id": 1,
"type": "list_entry"
},
"changed_fields": []
}
list_entry.updated sample
{
"list_entry": {
"id": 1,
"name": "Example list entry"
},
"subject": {
"id": 1,
"type": "list_entry"
},
"changed_fields": [
"name"
]
}
live_filter
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
live_filter.cloned |
|
no |
no |
no |
yes |
no |
live_filter.created |
|
no |
no |
no |
yes |
no |
live_filter.default_changed |
|
no |
no |
no |
yes |
no |
live_filter.deleted |
|
no |
no |
no |
yes |
no |
live_filter.pinned |
|
no |
no |
no |
yes |
no |
live_filter.updated |
|
no |
no |
no |
yes |
no |
notification_preference
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
notification_preference.created |
|
no |
no |
no |
yes |
no |
notification_preference.updated |
|
no |
no |
no |
yes |
no |
notification_setting
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
notification_setting.updated |
|
no |
no |
no |
yes |
no |
oauth_identity
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
oauth_identity.controlled_relink |
|
no |
no |
no |
yes |
no |
oauth_identity.created |
|
no |
no |
no |
yes |
no |
option_list
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
option_list.created |
A new option list is added. |
yes |
yes |
yes |
no |
yes |
option_list.deleted |
A option list is deleted. |
yes |
yes |
yes |
no |
yes |
option_list.updated |
A option list's details change. |
yes |
yes |
yes |
no |
yes |
option_list.created sample
{
"option_list": {
"id": 1,
"name": "Example option list"
},
"subject": {
"id": 1,
"type": "option_list"
},
"changed_fields": []
}
option_list.deleted sample
{
"option_list": {
"id": 1,
"name": "Example option list"
},
"subject": {
"id": 1,
"type": "option_list"
},
"changed_fields": []
}
option_list.updated sample
{
"option_list": {
"id": 1,
"name": "Example option list"
},
"subject": {
"id": 1,
"type": "option_list"
},
"changed_fields": [
"name"
]
}
ownership
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
ownership.transferred |
|
no |
no |
no |
yes |
no |
password
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
password.reset |
|
no |
no |
no |
yes |
no |
payment
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
payment.recorded |
Payment recorded against an invoice; evaluated for its owning invoice. |
yes |
yes |
yes |
no |
yes |
payment.refunded |
Refund recorded against an invoice; evaluated for its owning invoice. |
yes |
yes |
yes |
no |
yes |
payment.recorded v2 sample
{
"schema_version": 2,
"event": "payment.recorded",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "payments",
"id": 2,
"revision": null
},
"related": [],
"data": {
"id": 2
}
}
payment.recorded sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
payment.refunded v2 sample
{
"schema_version": 2,
"event": "payment.refunded",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "invoice:1",
"subject": {
"entity": "invoices",
"id": 1,
"revision": 1
},
"document": {
"entity": "payments",
"id": 2,
"revision": null
},
"related": [],
"data": {
"id": 2
}
}
payment.refunded sample
{
"invoice": {
"id": 1
},
"subject": {
"id": 1
}
}
plugin
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
plugin.capability_consent_granted |
|
no |
no |
no |
yes |
no |
plugin.capability_consent_revoked |
|
no |
no |
no |
yes |
no |
plugin.capability_expansion_denied |
|
no |
no |
no |
yes |
no |
plugin.data_access_denied |
|
no |
no |
no |
yes |
no |
plugin.data_read |
|
no |
no |
no |
yes |
no |
plugin.data_updated |
|
no |
no |
no |
yes |
no |
plugin.disabled |
|
no |
no |
no |
yes |
no |
plugin.enabled |
|
no |
no |
no |
yes |
no |
plugin.installed |
|
no |
no |
no |
yes |
no |
plugin.installed_from_registry |
|
no |
no |
no |
yes |
no |
plugin.preflight_rejected |
|
no |
no |
no |
yes |
no |
plugin.settings_updated |
|
no |
no |
no |
yes |
no |
plugin.uninstalled |
|
no |
no |
no |
yes |
no |
plugin.updated |
|
no |
no |
no |
yes |
no |
plugin.updated_from_registry |
|
no |
no |
no |
yes |
no |
plugin.uploaded |
|
no |
no |
no |
yes |
no |
purchase_order
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
purchase_order.cancelled |
Purchase order cancelled; evaluated for the purchase order it records. |
yes |
yes |
yes |
no |
yes |
purchase_order.created |
Purchase order created; evaluated for the purchase order it records. |
yes |
yes |
yes |
no |
yes |
purchase_order.deleted |
Draft purchase order deleted; evaluated for the purchase order it records. |
yes |
yes |
yes |
no |
yes |
purchase_order.received |
Purchase order receipt recorded; evaluated for the purchase order it records. |
yes |
yes |
yes |
no |
yes |
purchase_order.sent |
Purchase order sent to the supplier; evaluated for the purchase order it records. |
yes |
yes |
yes |
no |
yes |
purchase_order.updated |
Purchase order updated; evaluated for the purchase order it records. |
yes |
yes |
yes |
no |
yes |
purchase_order.cancelled v2 sample
{
"schema_version": 2,
"event": "purchase_order.cancelled",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "purchase_order:1",
"subject": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"document": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
purchase_order.cancelled sample
{
"purchase_order": {
"id": 1
},
"subject": {
"id": 1
}
}
purchase_order.created v2 sample
{
"schema_version": 2,
"event": "purchase_order.created",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "purchase_order:1",
"subject": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"document": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
purchase_order.created sample
{
"purchase_order": {
"id": 1
},
"subject": {
"id": 1
}
}
purchase_order.deleted sample
{
"purchase_order": {
"id": 1
},
"subject": {
"id": 1
}
}
purchase_order.received v2 sample
{
"schema_version": 2,
"event": "purchase_order.received",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "purchase_order:1",
"subject": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"document": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
purchase_order.received sample
{
"purchase_order": {
"id": 1
},
"subject": {
"id": 1
}
}
purchase_order.sent v2 sample
{
"schema_version": 2,
"event": "purchase_order.sent",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "purchase_order:1",
"subject": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"document": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
purchase_order.sent sample
{
"purchase_order": {
"id": 1
},
"subject": {
"id": 1
}
}
purchase_order.updated v2 sample
{
"schema_version": 2,
"event": "purchase_order.updated",
"event_id": "verbs:100",
"occurred_at": "2026-11-09T12:00:00Z",
"actor_type": "user",
"ref": "purchase_order:1",
"subject": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"document": {
"entity": "purchase_orders",
"id": 1,
"revision": 1
},
"related": [],
"data": {
"id": 1
}
}
purchase_order.updated sample
{
"purchase_order": {
"id": 1
},
"subject": {
"id": 1
}
}
purchase_order_document
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
purchase_order_document.created |
|
yes |
yes |
yes |
no |
no |
rate_band
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
rate_band.created |
A new rate band is added. |
yes |
yes |
yes |
no |
yes |
rate_band.deleted |
A rate band is deleted. |
yes |
yes |
yes |
no |
yes |
rate_band.updated |
A rate band's details change. |
yes |
yes |
yes |
no |
yes |
rate_band.created sample
{
"rate_band": {
"id": 1,
"name": "Example rate band"
},
"subject": {
"id": 1,
"type": "rate_band"
},
"changed_fields": []
}
rate_band.deleted sample
{
"rate_band": {
"id": 1,
"name": "Example rate band"
},
"subject": {
"id": 1,
"type": "rate_band"
},
"changed_fields": []
}
rate_band.updated sample
{
"rate_band": {
"id": 1,
"name": "Example rate band"
},
"subject": {
"id": 1,
"type": "rate_band"
},
"changed_fields": [
"name"
]
}
rate_specification
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
rate_specification.created |
A new rate specification is added. |
yes |
yes |
yes |
no |
yes |
rate_specification.deleted |
A rate specification is deleted. |
yes |
yes |
yes |
no |
yes |
rate_specification.updated |
A rate specification's details change. |
yes |
yes |
yes |
no |
yes |
rate_specification.created sample
{
"rate_specification": {
"id": 1,
"name": "Example rate specification"
},
"subject": {
"id": 1,
"type": "rate_specification"
},
"changed_fields": []
}
rate_specification.deleted sample
{
"rate_specification": {
"id": 1,
"name": "Example rate specification"
},
"subject": {
"id": 1,
"type": "rate_specification"
},
"changed_fields": []
}
rate_specification.updated sample
{
"rate_specification": {
"id": 1,
"name": "Example rate specification"
},
"subject": {
"id": 1,
"type": "rate_specification"
},
"changed_fields": [
"name"
]
}
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
related_item.created |
A new related item is added. |
yes |
yes |
yes |
no |
yes |
related_item.deleted |
A related item is deleted. |
yes |
yes |
yes |
no |
yes |
related_item.updated |
A related item's details change. |
yes |
yes |
yes |
no |
yes |
related_item.created sample
{
"related_item": {
"id": 1,
"related_name": "Example related name",
"catalogue_item_id": 1,
"related_catalogue_item_id": 1,
"quantity": "1.00"
},
"subject": {
"id": 1,
"type": "related_item"
},
"changed_fields": []
}
related_item.deleted sample
{
"related_item": {
"id": 1,
"related_name": "Example related name",
"catalogue_item_id": 1,
"related_catalogue_item_id": 1,
"quantity": "1.00"
},
"subject": {
"id": 1,
"type": "related_item"
},
"changed_fields": []
}
related_item.updated sample
{
"related_item": {
"id": 1,
"related_name": "Example related name",
"catalogue_item_id": 1,
"related_catalogue_item_id": 1,
"quantity": "1.00"
},
"subject": {
"id": 1,
"type": "related_item"
},
"changed_fields": [
"quantity"
]
}
rental
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
rental.agreed_price_cleared |
A rental event occurred: Agreed Price Cleared. |
yes |
yes |
yes |
no |
no |
rental.agreed_price_set |
A rental event occurred: Agreed Price Set. |
yes |
yes |
yes |
no |
no |
rental.asset_allocated |
A rental event occurred: Asset Allocated. |
yes |
yes |
yes |
no |
no |
rental.asset_checked |
A rental event occurred: Asset Checked. |
yes |
yes |
yes |
no |
no |
rental.asset_deallocated |
A rental event occurred: Asset Deallocated. |
yes |
yes |
yes |
no |
no |
rental.asset_dispatched |
A rental event occurred: Asset Dispatched. |
yes |
yes |
yes |
no |
no |
rental.asset_flightcase_cleared |
A rental event occurred: Asset Flightcase Cleared. |
yes |
yes |
yes |
no |
no |
rental.asset_flightcase_set |
A rental event occurred: Asset Flightcase Set. |
yes |
yes |
yes |
no |
no |
rental.asset_lost |
|
no |
no |
no |
yes |
no |
rental.asset_on_hire |
A rental event occurred: Asset On Hire. |
yes |
yes |
yes |
no |
no |
rental.asset_preparation_reverted |
A rental event occurred: Asset Preparation Reverted. |
yes |
yes |
yes |
no |
no |
rental.asset_prepared |
A rental event occurred: Asset Prepared. |
yes |
yes |
yes |
no |
no |
rental.asset_returned |
A rental event occurred: Asset Returned. |
yes |
yes |
yes |
no |
no |
rental.asset_status_changed |
An assigned asset changes lifecycle status. |
yes |
yes |
yes |
no |
yes |
rental.asset_substituted |
A rental event occurred: Asset Substituted. |
yes |
yes |
yes |
no |
no |
rental.assigned_to_project |
A rental event occurred: Assigned to project. |
yes |
yes |
yes |
no |
yes |
rental.associated |
A rental event occurred: Associated. |
yes |
yes |
yes |
no |
no |
rental.bulk_dispatched |
A rental event occurred: Bulk Dispatched. |
yes |
yes |
yes |
no |
no |
rental.bulk_quantity_adjusted |
A rental event occurred: Bulk Quantity Adjusted. |
yes |
yes |
yes |
no |
no |
rental.bulk_returned |
A rental event occurred: Bulk Returned. |
yes |
yes |
yes |
no |
no |
rental.cloned |
A rental event occurred: Cloned. |
yes |
yes |
yes |
no |
no |
rental.cost_added |
A rental event occurred: Cost Added. |
yes |
yes |
yes |
no |
no |
rental.cost_removed |
A rental event occurred: Cost Removed. |
yes |
yes |
yes |
no |
no |
rental.cost_updated |
A rental event occurred: Cost Updated. |
yes |
yes |
yes |
no |
no |
rental.created |
A rental event occurred: Created. |
yes |
yes |
yes |
no |
no |
rental.deleted |
A rental event occurred: Deleted. |
yes |
yes |
yes |
no |
no |
rental.detached_from_project |
A rental event occurred: Detached from project. |
yes |
yes |
yes |
no |
yes |
rental.discount_group_applied |
A rental event occurred: Discount Group Applied. |
yes |
yes |
yes |
no |
no |
rental.discount_manually_overridden |
A rental event occurred: Discount Manually Overridden. |
yes |
yes |
yes |
no |
no |
rental.discount_reset |
A rental event occurred: Discount Reset. |
yes |
yes |
yes |
no |
no |
rental.dissociated |
A rental event occurred: Dissociated. |
yes |
yes |
yes |
no |
no |
rental.effective_project_changed |
|
no |
no |
no |
yes |
no |
rental.group_agreed_price_cleared |
A rental event occurred: Group Agreed Price Cleared. |
yes |
yes |
yes |
no |
no |
rental.group_agreed_price_set |
A rental event occurred: Group Agreed Price Set. |
yes |
yes |
yes |
no |
no |
rental.late_return |
A rental event occurred: Late Return. |
yes |
yes |
yes |
no |
no |
rental.line_added |
A rental event occurred: Item Added. |
yes |
yes |
yes |
no |
no |
rental.line_agreed_price_discount_set |
|
no |
no |
no |
yes |
no |
rental.line_dates_changed |
|
no |
no |
no |
yes |
no |
rental.line_details_updated |
|
no |
no |
no |
yes |
no |
rental.line_discount_set |
|
no |
no |
no |
yes |
no |
rental.line_optional_toggled |
|
no |
no |
no |
yes |
no |
rental.line_price_overridden |
|
no |
no |
no |
yes |
no |
rental.line_quantity_changed |
|
no |
no |
no |
yes |
no |
rental.line_rate_changed |
|
no |
no |
no |
yes |
no |
rental.line_removed |
A rental event occurred: Item Removed. |
yes |
yes |
yes |
no |
no |
rental.line_renamed |
|
no |
no |
no |
yes |
no |
rental.line_substituted |
|
no |
no |
no |
yes |
no |
rental.line_surcharge_overridden |
|
no |
no |
no |
yes |
no |
rental.lines_reordered |
|
no |
no |
no |
yes |
no |
rental.lines_restructured |
|
no |
no |
no |
yes |
no |
rental.locks_applied |
A rental event occurred: Locks Applied. |
yes |
yes |
yes |
no |
no |
rental.locks_released |
A rental event occurred: Locks Released. |
yes |
yes |
yes |
no |
no |
rental.participant_added |
|
no |
no |
no |
yes |
no |
rental.participant_removed |
|
no |
no |
no |
yes |
no |
rental.participant_updated |
|
no |
no |
no |
yes |
no |
rental.pricing_recalculated |
A rental event occurred: Pricing Recalculated. |
yes |
yes |
yes |
no |
no |
rental.quote_expiring |
A rental event occurred: Quote Expiring. |
yes |
yes |
yes |
no |
no |
rental.restored |
A rental event occurred: Restored. |
yes |
yes |
yes |
no |
no |
rental.state_changed |
The rental moves between document states or returns to an active status. |
yes |
yes |
yes |
no |
yes |
rental.status_changed |
A rental event occurred: Status Changed. |
yes |
yes |
yes |
no |
no |
rental.status_promoted |
A rental event occurred: Status Promoted. |
yes |
yes |
yes |
no |
no |
rental.surcharge_group_toggled |
|
no |
no |
no |
yes |
no |
rental.updated |
A rental event occurred: Updated. |
yes |
yes |
yes |
no |
no |
rental.version_accepted |
A rental event occurred: Version Accepted. |
yes |
yes |
yes |
no |
no |
rental.version_activated |
A rental event occurred: Version Activated. |
yes |
yes |
yes |
no |
no |
rental.version_created |
A rental event occurred: Version Created. |
yes |
yes |
yes |
no |
no |
rental.version_declined |
A rental event occurred: Version Declined. |
yes |
yes |
yes |
no |
no |
rental.version_deleted |
A rental event occurred: Version Deleted. |
yes |
yes |
yes |
no |
no |
rental.version_relabelled |
A rental event occurred: Version Relabelled. |
yes |
yes |
yes |
no |
no |
rental.version_sent |
A rental event occurred: Version Sent. |
yes |
yes |
yes |
no |
no |
rental.version_superseded |
A rental event occurred: Version Superseded. |
yes |
yes |
yes |
no |
no |
rental.asset_status_changed sample
{
"id": 1,
"action": "rental.asset_status_changed",
"assignment_id": 1,
"from": "on_hire",
"to": "allocated"
}
rental.assigned_to_project sample
{
"id": 1,
"action": "rental.assigned_to_project"
}
rental.detached_from_project sample
{
"id": 1,
"action": "rental.detached_from_project"
}
rental.state_changed sample
{
"id": 1,
"action": "rental.state_changed",
"from": "quote",
"to": "order"
}
rental_project
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
rental_project.cost_added |
Rental project cost added; evaluated for the rental project it records. |
yes |
yes |
yes |
no |
yes |
rental_project.cost_removed |
Rental project cost removed; evaluated for the rental project it records. |
yes |
yes |
yes |
no |
yes |
rental_project.cost_updated |
Rental project cost updated; evaluated for the rental project it records. |
yes |
yes |
yes |
no |
yes |
rental_project.created |
Rental project created; evaluated for the rental project it records. |
yes |
yes |
yes |
no |
yes |
rental_project.deleted |
Rental project deleted; evaluated for the rental project it records. |
yes |
yes |
yes |
no |
yes |
rental_project.updated |
Rental project updated; evaluated for the rental project it records. |
yes |
yes |
yes |
no |
yes |
rental_project.cost_added sample
{
"rental_project": {
"id": 1,
"status": "active"
},
"subject": {
"id": 1
}
}
rental_project.cost_removed sample
{
"rental_project": {
"id": 1,
"status": "active"
},
"subject": {
"id": 1
}
}
rental_project.cost_updated sample
{
"rental_project": {
"id": 1,
"status": "active"
},
"subject": {
"id": 1
}
}
rental_project.created sample
{
"rental_project": {
"id": 1,
"status": "active"
},
"subject": {
"id": 1
}
}
rental_project.deleted sample
{
"rental_project": {
"id": 1,
"status": "active"
},
"subject": {
"id": 1
}
}
rental_project.updated sample
{
"rental_project": {
"id": 1,
"status": "active"
},
"subject": {
"id": 1
}
}
repair
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
repair.created |
Repair raised; evaluated for the asset it holds. |
yes |
yes |
yes |
no |
yes |
repair.released |
Repair completed with a disposition; evaluated for the asset it released. |
yes |
yes |
yes |
no |
yes |
repair.updated |
Repair details changed; evaluated for the asset it holds. |
yes |
yes |
yes |
no |
yes |
repair.created sample
{
"repair": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
repair.released sample
{
"repair": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
repair.updated sample
{
"repair": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
report
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
report.asked |
|
no |
no |
no |
no |
no |
report.created |
A new report is added. |
yes |
no |
yes |
no |
yes |
report.deleted |
A report is deleted. |
yes |
no |
yes |
no |
yes |
report.generated |
|
yes |
yes |
yes |
no |
no |
report.public_link_created |
|
no |
no |
no |
no |
no |
report.public_link_revoked |
|
no |
no |
no |
no |
no |
report.schedule.created |
|
no |
no |
no |
no |
no |
report.schedule.deleted |
|
no |
no |
no |
no |
no |
report.schedule.updated |
|
no |
no |
no |
no |
no |
report.updated |
A report's details change. |
yes |
no |
yes |
no |
yes |
report.created sample
{
"report": {
"id": 1,
"key": "Example report",
"name": "Example report"
},
"subject": {
"id": 1,
"type": "report"
},
"changed_fields": []
}
report.deleted sample
{
"report": {
"id": 1,
"key": "Example report",
"name": "Example report"
},
"subject": {
"id": 1,
"type": "report"
},
"changed_fields": []
}
report.updated sample
{
"report": {
"id": 1,
"key": "Example report",
"name": "Example report"
},
"subject": {
"id": 1,
"type": "report"
},
"changed_fields": [
"key"
]
}
resource_assignment
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
resource_assignment.cancelled |
Resource assignment cancelled; evaluated for the resource assignment it records. |
yes |
yes |
yes |
no |
yes |
resource_assignment.completed |
Resource assignment completed; evaluated for the resource assignment it records. |
yes |
yes |
yes |
no |
yes |
resource_assignment.confirmed |
Resource assignment confirmed; evaluated for the resource assignment it records. |
yes |
yes |
yes |
no |
yes |
resource_assignment.created |
Resource assignment created; evaluated for the resource assignment it records. |
yes |
yes |
yes |
no |
yes |
resource_assignment.demand_unmet |
|
yes |
yes |
yes |
no |
no |
resource_assignment.rescheduled |
Resource assignment rescheduled; evaluated for the resource assignment it records. |
yes |
yes |
yes |
no |
yes |
resource_assignment.started |
Resource assignment started; evaluated for the resource assignment it records. |
yes |
yes |
yes |
no |
yes |
resource_assignment.updated |
Resource assignment updated; evaluated for the resource assignment it records. |
yes |
yes |
yes |
no |
yes |
resource_assignment.cancelled sample
{
"resource_assignment": {
"id": 1,
"rental_id": 1,
"rental_project_id": null,
"resource_type": "account",
"resource_id": 1,
"status": "scheduled",
"starts_at": "2026-01-15T12:00:00Z",
"ends_at": "2026-01-15T18:00:00Z"
},
"subject": {
"id": 1
}
}
resource_assignment.completed sample
{
"resource_assignment": {
"id": 1,
"rental_id": 1,
"rental_project_id": null,
"resource_type": "account",
"resource_id": 1,
"status": "scheduled",
"starts_at": "2026-01-15T12:00:00Z",
"ends_at": "2026-01-15T18:00:00Z"
},
"subject": {
"id": 1
}
}
resource_assignment.confirmed sample
{
"resource_assignment": {
"id": 1,
"rental_id": 1,
"rental_project_id": null,
"resource_type": "account",
"resource_id": 1,
"status": "scheduled",
"starts_at": "2026-01-15T12:00:00Z",
"ends_at": "2026-01-15T18:00:00Z"
},
"subject": {
"id": 1
}
}
resource_assignment.created sample
{
"resource_assignment": {
"id": 1,
"rental_id": 1,
"rental_project_id": null,
"resource_type": "account",
"resource_id": 1,
"status": "scheduled",
"starts_at": "2026-01-15T12:00:00Z",
"ends_at": "2026-01-15T18:00:00Z"
},
"subject": {
"id": 1
}
}
resource_assignment.rescheduled sample
{
"resource_assignment": {
"id": 1,
"rental_id": 1,
"rental_project_id": null,
"resource_type": "account",
"resource_id": 1,
"status": "scheduled",
"starts_at": "2026-01-15T12:00:00Z",
"ends_at": "2026-01-15T18:00:00Z"
},
"subject": {
"id": 1
}
}
resource_assignment.started sample
{
"resource_assignment": {
"id": 1,
"rental_id": 1,
"rental_project_id": null,
"resource_type": "account",
"resource_id": 1,
"status": "scheduled",
"starts_at": "2026-01-15T12:00:00Z",
"ends_at": "2026-01-15T18:00:00Z"
},
"subject": {
"id": 1
}
}
resource_assignment.updated sample
{
"resource_assignment": {
"id": 1,
"rental_id": 1,
"rental_project_id": null,
"resource_type": "account",
"resource_id": 1,
"status": "scheduled",
"starts_at": "2026-01-15T12:00:00Z",
"ends_at": "2026-01-15T18:00:00Z"
},
"subject": {
"id": 1
}
}
returns
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
returns.closed |
|
yes |
yes |
yes |
no |
no |
returns.disposition_recorded |
|
yes |
yes |
yes |
no |
no |
returns.exception_dismissed |
|
yes |
yes |
yes |
no |
no |
returns.exception_dispositioned |
|
yes |
yes |
yes |
no |
no |
returns.exception_raised |
|
yes |
yes |
yes |
no |
no |
returns.stage_advanced |
|
yes |
yes |
yes |
no |
no |
role
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
role.created |
|
yes |
yes |
yes |
no |
no |
role.deleted |
|
yes |
yes |
yes |
no |
no |
role.updated |
|
yes |
yes |
yes |
no |
no |
scan
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
scan.recorded |
|
yes |
no |
no |
no |
no |
scan_event
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
scan_event.voided |
|
yes |
yes |
yes |
no |
no |
scan_session
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
scan_session.abandoned |
|
yes |
yes |
yes |
no |
no |
scan_session.completed |
|
yes |
yes |
yes |
no |
no |
scan_session.opened |
|
yes |
yes |
yes |
no |
no |
scan_session.taken_over |
|
yes |
no |
no |
no |
no |
scannable_identifier
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
scannable_identifier.deactivated |
|
yes |
yes |
yes |
no |
no |
scannable_identifier.registered |
|
yes |
yes |
yes |
no |
no |
scheduling_conflict
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
scheduling_conflict.acknowledged |
Scheduling conflict acknowledged; evaluated for the scheduling conflict it records. |
yes |
no |
yes |
no |
yes |
scheduling_conflict.detected |
Scheduling conflict detected; evaluated for the scheduling conflict it records. |
yes |
yes |
yes |
no |
yes |
scheduling_conflict.resolved |
Scheduling conflict resolved; evaluated for the scheduling conflict it records. |
yes |
yes |
yes |
no |
yes |
scheduling_conflict.acknowledged sample
{
"scheduling_conflict": {
"id": 1,
"resource_type": "account",
"resource_id": 1,
"conflict_type": "overlap",
"severity": "conflict",
"status": "detected",
"resource_assignment_ids": [
1,
2
]
},
"subject": {
"id": 1
}
}
scheduling_conflict.detected sample
{
"scheduling_conflict": {
"id": 1,
"resource_type": "account",
"resource_id": 1,
"conflict_type": "overlap",
"severity": "conflict",
"status": "detected",
"resource_assignment_ids": [
1,
2
]
},
"subject": {
"id": 1
}
}
scheduling_conflict.resolved sample
{
"scheduling_conflict": {
"id": 1,
"resource_type": "account",
"resource_id": 1,
"conflict_type": "overlap",
"severity": "conflict",
"status": "detected",
"resource_assignment_ids": [
1,
2
]
},
"subject": {
"id": 1
}
}
service
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
service.created |
A new service is added. |
yes |
yes |
yes |
no |
yes |
service.deleted |
A service is deleted. |
yes |
yes |
yes |
no |
yes |
service.updated |
A service's details change. |
yes |
yes |
yes |
no |
yes |
service.created sample
{
"service": {
"id": 1,
"catalogue_item_id": 1,
"catalogue_item": {
"id": 1,
"name": "Example service"
},
"min_resources": 1,
"max_resources": 1
},
"subject": {
"id": 1,
"type": "service"
},
"changed_fields": []
}
service.deleted sample
{
"service": {
"id": 1,
"catalogue_item_id": 1,
"catalogue_item": {
"id": 1,
"name": "Example service"
},
"min_resources": 1,
"max_resources": 1
},
"subject": {
"id": 1,
"type": "service"
},
"changed_fields": []
}
service.updated sample
{
"service": {
"id": 1,
"catalogue_item_id": 1,
"catalogue_item": {
"id": 1,
"name": "Example service"
},
"min_resources": 1,
"max_resources": 1
},
"subject": {
"id": 1,
"type": "service"
},
"changed_fields": [
"min_resources"
]
}
settings
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
settings.updated |
|
yes |
yes |
yes |
no |
no |
shortage
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
shortage.acknowledged |
|
yes |
yes |
yes |
no |
no |
shortage.cleared |
|
yes |
yes |
yes |
no |
no |
shortage.detected |
|
yes |
yes |
yes |
no |
no |
shortage.escalated |
|
yes |
yes |
yes |
no |
no |
shortage.resolution.cancelled |
|
yes |
yes |
yes |
no |
no |
shortage.resolution.confirmed |
|
yes |
yes |
yes |
no |
no |
shortage.resolution.created |
|
yes |
yes |
yes |
no |
no |
shortage.resolution.failed |
|
yes |
yes |
yes |
no |
no |
shortage.resolution.fulfilled |
|
yes |
yes |
yes |
no |
no |
shortage.resolution.in_progress |
|
yes |
yes |
yes |
no |
no |
shortage.resolution.partially_fulfilled |
|
yes |
yes |
yes |
no |
no |
shortage.waitlist.created |
|
yes |
yes |
yes |
no |
no |
shortage.waitlist.expired |
|
yes |
yes |
yes |
no |
no |
shortage.waitlist.matched |
|
yes |
yes |
yes |
no |
no |
stock_check
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
stock_check.cancelled |
Stock check cancelled; evaluated for the stock check it abandons. |
yes |
yes |
yes |
no |
yes |
stock_check.closed |
Stock check closed for processing; evaluated for the stock check it closes counting on. |
yes |
yes |
yes |
no |
yes |
stock_check.completed |
Stock check completed; evaluated for the stock check it applied. |
yes |
yes |
yes |
no |
yes |
stock_check.count_recorded |
|
no |
no |
no |
yes |
no |
stock_check.count_reset |
|
no |
no |
no |
yes |
no |
stock_check.created |
Stock check created; evaluated for the stock check it opens. |
yes |
yes |
yes |
no |
yes |
stock_check.discrepancy_dismissed |
Stock check discrepancy dismissed; evaluated for the stock check it belongs to. |
yes |
yes |
yes |
no |
yes |
stock_check.discrepancy_resolved |
Stock check discrepancy resolved; evaluated for the stock check it belongs to. |
yes |
yes |
yes |
no |
yes |
stock_check.recounted |
|
no |
no |
no |
yes |
no |
stock_check.reopened |
Stock check reopened to counting; evaluated for the stock check it reopens. |
yes |
yes |
yes |
no |
yes |
stock_check.sign_off_cleared |
Stock check sign-off cleared; evaluated for the stock check it reopens for signature. |
yes |
yes |
yes |
no |
yes |
stock_check.signed_off |
Stock check signed off; evaluated for the stock check it attests. |
yes |
yes |
yes |
no |
yes |
stock_check.updated |
Stock check header updated; evaluated for the stock check it changes. |
yes |
yes |
yes |
no |
yes |
stock_check.cancelled sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.closed sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.completed sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.created sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.discrepancy_dismissed sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.discrepancy_resolved sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.reopened sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.sign_off_cleared sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.signed_off sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
stock_check.updated sample
{
"stock_check": {
"id": 1
},
"subject": {
"id": 1
}
}
surcharge
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
surcharge.created |
A new surcharge is added. |
yes |
yes |
yes |
no |
yes |
surcharge.deleted |
A surcharge is deleted. |
yes |
yes |
yes |
no |
yes |
surcharge.updated |
A surcharge's details change. |
yes |
yes |
yes |
no |
yes |
surcharge.created sample
{
"surcharge": {
"id": 1,
"name": "Example surcharge"
},
"subject": {
"id": 1,
"type": "surcharge"
},
"changed_fields": []
}
surcharge.deleted sample
{
"surcharge": {
"id": 1,
"name": "Example surcharge"
},
"subject": {
"id": 1,
"type": "surcharge"
},
"changed_fields": []
}
surcharge.updated sample
{
"surcharge": {
"id": 1,
"name": "Example surcharge"
},
"subject": {
"id": 1,
"type": "surcharge"
},
"changed_fields": [
"name"
]
}
surcharge_group
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
surcharge_group.created |
A new surcharge group is added. |
yes |
yes |
yes |
no |
yes |
surcharge_group.deleted |
A surcharge group is deleted. |
yes |
yes |
yes |
no |
yes |
surcharge_group.updated |
A surcharge group's details change. |
yes |
yes |
yes |
no |
yes |
surcharge_group.created sample
{
"surcharge_group": {
"id": 1,
"name": "Example surcharge group"
},
"subject": {
"id": 1,
"type": "surcharge_group"
},
"changed_fields": []
}
surcharge_group.deleted sample
{
"surcharge_group": {
"id": 1,
"name": "Example surcharge group"
},
"subject": {
"id": 1,
"type": "surcharge_group"
},
"changed_fields": []
}
surcharge_group.updated sample
{
"surcharge_group": {
"id": 1,
"name": "Example surcharge group"
},
"subject": {
"id": 1,
"type": "surcharge_group"
},
"changed_fields": [
"name"
]
}
tax_category
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
tax_category.created |
|
yes |
yes |
yes |
no |
no |
tax_category.deleted |
|
yes |
yes |
yes |
no |
no |
tax_category.updated |
|
yes |
yes |
yes |
no |
no |
tax_rate
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
tax_rate.created |
|
yes |
yes |
yes |
no |
no |
tax_rate.deleted |
|
yes |
yes |
yes |
no |
no |
tax_rate.updated |
|
yes |
yes |
yes |
no |
no |
tax_rule
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
tax_rule.created |
|
yes |
yes |
yes |
no |
no |
tax_rule.deleted |
|
yes |
yes |
yes |
no |
no |
tax_rule.updated |
|
yes |
yes |
yes |
no |
no |
tax_zone
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
tax_zone.created |
|
yes |
yes |
yes |
no |
no |
tax_zone.deleted |
|
yes |
yes |
yes |
no |
no |
tax_zone.updated |
|
yes |
yes |
yes |
no |
no |
update
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
update.completed |
|
yes |
yes |
yes |
no |
no |
update.failed |
|
yes |
yes |
yes |
no |
no |
update.started |
|
yes |
yes |
yes |
no |
no |
usage_reading
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
usage_reading.deleted |
Usage reading removed; evaluated for the asset it metered. |
yes |
yes |
yes |
no |
yes |
usage_reading.recorded |
Usage reading recorded; evaluated for the asset it meters. |
yes |
yes |
yes |
no |
yes |
usage_reading.deleted sample
{
"usage_reading": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
usage_reading.recorded sample
{
"usage_reading": {
"id": 1,
"asset_id": 1
},
"subject": {
"id": 1
}
}
user
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
user.created |
|
yes |
yes |
yes |
no |
no |
user.deactivated |
|
yes |
yes |
yes |
no |
no |
user.deleted |
|
yes |
yes |
yes |
no |
no |
user.invitation_accepted |
|
no |
no |
no |
yes |
no |
user.password_reset |
|
no |
no |
no |
yes |
no |
user.reactivated |
|
no |
no |
no |
yes |
no |
user.two_factor_disabled |
|
no |
no |
no |
yes |
no |
user.two_factor_enabled |
|
no |
no |
no |
yes |
no |
user.two_factor_recovery_code_consumed |
|
no |
no |
no |
yes |
no |
user.two_factor_recovery_codes_regenerated |
|
no |
no |
no |
yes |
no |
user.two_factor_setup_started |
|
no |
no |
no |
yes |
no |
user.updated |
|
yes |
yes |
yes |
no |
no |
vehicle
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
vehicle.assigned |
|
yes |
yes |
yes |
no |
no |
vehicle.assignment_updated |
|
yes |
yes |
yes |
no |
no |
vehicle.created |
A new vehicle is added. |
yes |
yes |
yes |
no |
yes |
vehicle.deleted |
A vehicle is deleted. |
yes |
yes |
yes |
no |
yes |
vehicle.unassigned |
|
yes |
yes |
yes |
no |
no |
vehicle.updated |
A vehicle's details change. |
yes |
yes |
yes |
no |
yes |
vehicle.created sample
{
"vehicle": {
"id": 1,
"name": "Example vehicle",
"number": "Example vehicle"
},
"subject": {
"id": 1,
"type": "vehicle"
},
"changed_fields": []
}
vehicle.deleted sample
{
"vehicle": {
"id": 1,
"name": "Example vehicle",
"number": "Example vehicle"
},
"subject": {
"id": 1,
"type": "vehicle"
},
"changed_fields": []
}
vehicle.updated sample
{
"vehicle": {
"id": 1,
"name": "Example vehicle",
"number": "Example vehicle"
},
"subject": {
"id": 1,
"type": "vehicle"
},
"changed_fields": [
"name"
]
}
virtual_stock
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
virtual_stock.overrun |
|
no |
no |
no |
yes |
no |
virtual_stock_intake
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
virtual_stock_intake.cancelled |
|
yes |
yes |
yes |
no |
no |
virtual_stock_intake.confirmed |
|
yes |
yes |
yes |
no |
no |
virtual_stock_intake.created |
A new virtual stock intake is added. |
yes |
yes |
yes |
no |
yes |
virtual_stock_intake.deleted |
A virtual stock intake is deleted. |
yes |
yes |
yes |
no |
yes |
virtual_stock_intake.receipt_reverted |
|
no |
no |
no |
yes |
no |
virtual_stock_intake.received |
|
yes |
yes |
yes |
no |
no |
virtual_stock_intake.returned |
|
yes |
yes |
yes |
no |
no |
virtual_stock_intake.updated |
A virtual stock intake's details change. |
yes |
yes |
yes |
no |
yes |
virtual_stock_intake.created sample
{
"virtual_stock_intake": {
"id": 1,
"number": "Example virtual stock intake"
},
"subject": {
"id": 1,
"type": "virtual_stock_intake"
},
"changed_fields": []
}
virtual_stock_intake.deleted sample
{
"virtual_stock_intake": {
"id": 1,
"number": "Example virtual stock intake"
},
"subject": {
"id": 1,
"type": "virtual_stock_intake"
},
"changed_fields": []
}
virtual_stock_intake.updated sample
{
"virtual_stock_intake": {
"id": 1,
"number": "Example virtual stock intake"
},
"subject": {
"id": 1,
"type": "virtual_stock_intake"
},
"changed_fields": [
"number"
]
}
warehouse
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
warehouse.created |
A new warehouse is added. |
yes |
yes |
yes |
no |
yes |
warehouse.deleted |
A warehouse is deleted. |
yes |
yes |
yes |
no |
yes |
warehouse.updated |
A warehouse's details change. |
yes |
yes |
yes |
no |
yes |
warehouse.created sample
{
"warehouse": {
"id": 1,
"name": "Example warehouse"
},
"subject": {
"id": 1,
"type": "warehouse"
},
"changed_fields": []
}
warehouse.deleted sample
{
"warehouse": {
"id": 1,
"name": "Example warehouse"
},
"subject": {
"id": 1,
"type": "warehouse"
},
"changed_fields": []
}
warehouse.updated sample
{
"warehouse": {
"id": 1,
"name": "Example warehouse"
},
"subject": {
"id": 1,
"type": "warehouse"
},
"changed_fields": [
"name"
]
}
warehouse_transfer
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
warehouse_transfer.cancelled |
Warehouse transfer cancelled; evaluated for the transfer it abandons. |
yes |
yes |
yes |
no |
yes |
warehouse_transfer.created |
Warehouse transfer created; evaluated for the transfer it opens. |
yes |
yes |
yes |
no |
yes |
warehouse_transfer.dispatched |
Warehouse transfer dispatched from its origin warehouse; evaluated for the transfer it moves. |
yes |
yes |
yes |
no |
yes |
warehouse_transfer.line_received |
|
no |
no |
no |
yes |
no |
warehouse_transfer.received |
Warehouse transfer received at its destination warehouse; evaluated for the transfer it closes. |
yes |
yes |
yes |
no |
yes |
warehouse_transfer.updated |
Warehouse transfer updated; evaluated for the transfer it changes. |
yes |
yes |
yes |
no |
yes |
warehouse_transfer.cancelled sample
{
"warehouse_transfer": {
"id": 1
},
"subject": {
"id": 1
}
}
warehouse_transfer.created sample
{
"warehouse_transfer": {
"id": 1
},
"subject": {
"id": 1
}
}
warehouse_transfer.dispatched sample
{
"warehouse_transfer": {
"id": 1
},
"subject": {
"id": 1
}
}
warehouse_transfer.received sample
{
"warehouse_transfer": {
"id": 1
},
"subject": {
"id": 1
}
}
warehouse_transfer.updated sample
{
"warehouse_transfer": {
"id": 1
},
"subject": {
"id": 1
}
}
webhook
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
webhook.created |
|
no |
no |
no |
yes |
no |
webhook.deleted |
|
no |
no |
no |
yes |
no |
webhook.secret_rotated |
|
no |
no |
no |
yes |
no |
webhook.updated |
|
no |
no |
no |
yes |
no |
workflow
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
workflow.activated |
|
no |
no |
no |
yes |
no |
workflow.created |
|
no |
no |
no |
yes |
no |
workflow.custom.rental_signal |
A workflow-only signal emitted to another workflow. |
no |
no |
yes |
no |
no |
workflow.deactivated |
|
no |
no |
no |
yes |
no |
workflow.deleted |
|
no |
no |
no |
yes |
no |
workflow.duplicated |
|
yes |
yes |
yes |
no |
no |
workflow.published |
|
no |
no |
no |
yes |
no |
workflow.run_cancelled |
|
no |
yes |
no |
no |
no |
workflow.run_completed |
|
no |
yes |
no |
no |
no |
workflow.run_failed |
|
no |
yes |
no |
no |
no |
workflow.run_sensitive_data_revealed |
|
no |
no |
no |
yes |
no |
workflow.updated |
|
no |
no |
no |
yes |
no |
workflow_communication_artifact
| Event |
Description |
Plugin |
Webhook |
Workflow |
System protected |
Sample |
workflow_communication_artifact.retrieved |
|
no |
no |
no |
yes |
no |