A job is created, a reading goes out of range, a form is submitted. With events, your module announces it the moment it happens. Other parts of the platform can react: an agent triages the new record, a schedule kicks off, and every open screen updates itself. No refresh button, no polling every few seconds.
Publishing and listening
Your module publishes events in its own name, such as jobs.job_created, with a small payload (usually the record's id). Then:
| Who listens | What happens |
|---|---|
| Screens | Open pages of your module update as soon as an event arrives. |
| Triggers | An event can start your agent or a job. See Schedules and triggers. |
| Your module's code | It can react to events from outside, such as changes to the workspace's settings. |
A screen only receives events if the person holds the module's view permission. By default it gets the ids, not the full record, and fetches the details through your module's normal permission checks.
Live rooms for screens several people watch at once
Events go one way. Sometimes people act together: a shared walkthrough, a live board several people edit, a game at the team lunch. For that there are live rooms:
- Everyone in a room sees every message in the same order.
- People see who joins and leaves.
- Your module decides who may join which room.
Nothing in a room is stored. After a reconnect, a screen asks someone else in the room for the current state.
Limits and rate
| Events | Live rooms |
|---|---|
| 64 KB per event | 16 KB per message |
| 1,200 events per workspace per minute | 30 messages a second per person |
| 8 live connections per person | 16 people per room, 200 rooms per workspace |
Rooms close briefly when the platform is updated, and screens reconnect on their own.
Ask the Module Builder
For developers
"events": {"publishes": ["job_created"], "stream_permission": "JOBS.READ"}await event_bus.publish(tenant_id, "jobs.job_created", {"id": job_id})Platform.events.subscribe('JOBS', {
events: ['jobs.job_created'],
onEvent: () => reload(),
onStatus: s => s === 'live' ? stopPolling() : startPolling(),
});Your own namespace (your module code in lowercase) needs no declaration; another module's is refused.
Good to know
- Events are metered and rate-limited, so publish what matters, not every keystroke.
- Need an answer back? Events don't reply. Call a service instead.
- Testing a trigger? A Workspace Admin can send a test event with Fire event under System settings › Schedules.