SDK events and notifications

client.events follows changes in a workspace as they happen, and client.notifications sends and reads messages for the people in it. Every change in a workspace is written to a log, and events.subscribe listens to it.

const stop = client.events.subscribe((event) => {
  console.log(event.type);
});

// later
stop();

subscribe returns a function that stops listening. The connection recovers by itself if it drops.

Shape of an event

Each event has a type, a sequence number that only increases, the actor that caused it and occurredAt. Common types:

Type	When
`record.created`, `record.updated`, `record.deleted`	A record changed.
`metadata.changed`	The data model changed.
`module.applied`	A module was installed or updated.
`module.event`	A module received an event from an outside service.
`workflow.run`	A workflow ran.
`task.changed`, `document.changed`	A task or a document changed.

The change feed lists every type.

Resume after a restart

Store the sequence of the last event handled. After a restart, pass it as after to receive only later events.

client.events.subscribe(handle, { after: lastSequence });

onStatus reports the state of the connection: connecting, open, reconnecting or closed.

Notifications

notifications is the signed-in person’s own inbox, and the way to notify others.

await client.notifications.send({
  title: 'Invoice paid',
  to: { roles: ['admin'] },
});

const { items } = await client.notifications.list({ unread: true });

to is all, a list of roles, a list of users, or me. markRead, markUnread, markAllRead and delete manage received notifications.

Change feed over HTTP: the same stream for any language.
Workflows and tasks: act on events without code.

SDK

CLI

HTTP API

SDK events and notifications

Shape of an event

Resume after a restart

Notifications

​Subscribe to live events

​Shape of an event

​Resume after a restart

​Notifications

​Related

Subscribe to live events

Shape of an event

Resume after a restart

Notifications

Related