Skip to main content
GET
Check workspace event notifications

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.

Query Parameters

cursor
string

Opaque nextCursor from the preceding poll. Omit to establish a new checkpoint.

Maximum string length: 512
limit
integer
default:25
Required range: 1 <= x <= 100
conversationId
string

Only notifications associated with this conversation.

Maximum string length: 128
eventTypes
string

Comma-separated supported event types. Keep filters unchanged while resuming.

Maximum string length: 1024

Response

A bounded notification page or an initial checkpoint.

data
object[]
required
Maximum array length: 100
nextCursor
string
required
hasMore
boolean
required
pollAfterSeconds
enum<integer>
required
Available options:
3