Stream the Organization events

GET /v1/events/stream

Answers text/event-stream: every record event of the credential's environment as it is relayed, at least once, each an EventStreamMessage whose SSE id is the event id. types, families and filter_id select as on the log. Resume with Last-Event-ID or after (the header wins), or start from since, within 72 hours (a target); an older resume point is sent one resume_gap first, and the client pages GET /v1/events. since beside either resume point is invalid_request. Up to three connections per credential (a target); a fourth answers 429 stream_limit_reached. A keepalive comment line every 15 seconds (a target).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the events:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -N "$VOCAL_API/v1/events/stream" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Accept: text/event-stream"

const response = await fetch(`${process.env.VOCAL_API}/v1/events/stream`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    Accept: 'text/event-stream',
  },
});
console.log(response.status);
for await (const chunk of response.body) {
  process.stdout.write(chunk);
}

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/events/stream",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Accept": "text/event-stream",
    },
    stream=True,
)
print(response.status_code)
for line in response.iter_lines(decode_unicode=True):
    print(line)

Parameters

Responses