Skip to main content
GET
Stream Workspace Events

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Query Parameters

stream_id
string<uuid> | null
source_type
string | null
Maximum string length: 64
kind
string | null

An event kind, or a prefix ending in .* (order.*).

Maximum string length: 255
sender
string | null
Maximum string length: 512
session_key
string | null
Maximum string length: 512
result
enum<string> | null

What the platform did with it.

Available options:
queued,
processing,
handled,
error,
no_handlers,
skipped
since
string<date-time> | null

Received at or after.

until
string<date-time> | null

Received before.

platform
boolean
default:true

False leaves out the platform's own events (source type platform); the first page's counts still include them.

Response

Successful Response