Appearance
Events
Apps and the platform emit events when something happens. Processes start from them, and apps subscribe to them through their manifest (events.consumes).
Names follow app.entity.verb, past tense.
| App | Events |
|---|---|
| CRM | crm.deal.created, crm.deal.won |
| Documents | docs.document.uploaded, docs.document.validated, docs.document.needs_review, docs.document.approved, docs.document.rejected, docs.document.changes_requested |
| Billing | billing.invoice.created, billing.invoice.finalized, billing.invoice.sent, billing.invoice.paid, billing.invoice.overdue, billing.invoice.voided, billing.payment.succeeded, billing.payment.failed, billing.refund.created, billing.subscription.created, billing.subscription.canceled |
| Work | work.board.created |
| Processes | process.run.started, process.task.created, process.automation.changed |
Using events
Start a process from an event with an
eventtrigger, optionally filtered on payload fields:json{ "type": "event", "event": "docs.document.validated", "filter": { "type_id": "01J…" } }React in your app: list the events in your manifest's
events.consumes; the subscription is created when a workspace installs the app.
Outbound webhooks
Delivering events to an external URL (signed webhooks) is on the roadmap. Until then, apps receive events through their manifest subscription, and integrations can poll the relevant list endpoints.