Hear what changes

GET

/events

const url = 'https://example.com/events';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/events \
  --cookie bottle.session_token=<bottle.session_token>

Server-sent events. A change event is { path, method, at }: a request that changed something under that path in this business. Clients re-read what they were showing rather than trusting a payload. presence (who is on which page), cursor (where someone is pointing on the rounds map) and planning (who is planning which day) carry what they say, since there is nothing to re-read. The tenant may be given as ?tenantId= because a browser EventSource cannot set headers. A comment is sent every 25 seconds to keep the connection open through proxies. Sessions only.

Authorizations

sessionCookie
tenant:read
apiKey
tenant:read

Responses

200

Text/event-stream

text/event-stream

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or a key rather than a person

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}