Skip to main content
GET
Consume the next events for an agent trigger subscription (short-poll)

Authorizations

Authorization
string
header
required

A whk_-prefixed API key (opaque; not a JWT).

Path Parameters

triggerId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

cursor
string | null

Opaque resume cursor from a prior call's nextCursor.

limit
integer

Max events to return (1–200).

Required range: x <= 200
includeBody
boolean

Attach the bounded inline event body to each event (default true).

maxBodyBytes
integer

Per-event inline body byte cap (server-capped at 65536).

Required range: x <= 65536

Response

Success.

events
object[]
required
nextCursor
string | null
required
caughtUp
boolean
required