BrambleHelp
ReferenceMail, Calendar & Contacts API

Live updates

Server-sent events when a mailbox changes, and keeping the connection alive.

MethodPathSummary
GET/api/eventsLive mailbox changes (server-sent events)
GET/api/pushKeep the live connection alive

#Live mailbox changes (server-sent events)

GET/api/events

Server-Sent Events: "changed" when the INBOX changes (IMAP IDLE on a connection of its own), so new mail shows without polling.

Address
https://<your-org>.brambleit.cloud/mail/api/events
Requires
Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Mail.

Query parameters

NameTypeDescription
mbany

Response

An empty body.

Example request

JavaScript
// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/mail/api/events', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Keep the live connection alive

GET/api/push
Address
https://<your-org>.brambleit.cloud/mail/api/push
Requires
Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Mail.

Query parameters

NameTypeDescription
mbany
pingnumber

Response

An empty body.

Example request

JavaScript
// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/mail/api/push', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();