Sign in
Events

List Events

Retrieves a list of events for the tenant, supporting cursor navigation (details TBD) and filtering.

get/{tenant_id}/events

Query parameters

string
OR
string[]

Filter events by destination ID(s).

status'success' | 'failed'

Filter events by delivery status.

nextstring

Cursor for next page of results

prevstring

Cursor for previous page of results

limitinteger

Number of items per page (default 100, max 1000)

startstring date-time

Start time filter (RFC3339 format)

endstring date-time

End time filter (RFC3339 format)

Response

A paginated list of events.

countinteger required

Total number of items across all pages

nextstring required

Cursor for next page (empty string if no next page)

prevstring required

Cursor for previous page (empty string if no previous page)

Example response

{
  "count": 42,
  "data": [
    {
      "id": "evt_123",
      "destination_id": "des_456",
      "topic": "user.created",
      "time": "2024-01-01T00:00:00Z",
      "successful_at": "2024-01-01T00:00:00Z",
      "metadata": {
        "source": "crm"
      },
      "status": "success",
      "data": {
        "user_id": "userid",
        "status": "active"
      }
    }
  ]
}

Changes