v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Event

Poller Sink Stream Events

Iterate over a stream of events.

The sink must be of type poller to use the poller endpoint.

get/api/v1/stream/{stream_id}/sink/{sink_id}/events

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

The Stream's ID or UID.

sink_idstring required

The StreamSink's ID or UID.

Example:unique-identifier

The StreamSink's ID or UID.

Query parameters

limitinteger

Limit the number of returned items

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

The iterator returned from a prior invocation

afterstring date-time nullable

Response

iteratorstring required
doneboolean required

Example response

{
  "data": [
    {
      "eventType": "user.signup"
    }
  ]
}