v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Message

Poller Poll

Reads the stream of created messages for an application, filtered on the Sink's event types and Channels.

get/api/v1/app/{app_id}/poller/{sink_id}

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

sink_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Query parameters

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

event_typestring nullable

Filters messages sent with this event type (optional).

Example:user.signup

Filters messages sent with this event type (optional).

channelstring nullable

Filters messages sent with this channel (optional).

Example:project_1337

Filters messages sent with this channel (optional).

afterstring date-time nullable

Response

iteratorstring required

doneboolean required

Example response

{
  "data": [
    {
      "eventId": "unique-identifier",
      "eventType": "user.signup",
      "payload": {
        "type": "user.created",
        "email": "test@example.com",
        "username": "test_user"
      },
      "channels": [
        "project_123",
        "group_2"
      ],
      "id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "tags": [
        "project_1337"
      ]
    }
  ]
}