Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Events

Events

Reads the stream of operational webhook events for this environment.

get/api/v1/events

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

event_typesstring[] nullable

Filter response based on the event type

Filter response based on the event type

[
  "user.signup"
]
channelsstring[] nullable

Filter response based on the event type.

Filter response based on the event type.

[
  "project_1337"
]
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"
      ]
    }
  ]
}