Events

List all events

Changed on

Returns a list of events sorted by creation date, with the most recently created event appearing first. The event list includes data from up to the last 30 days.

Each event’s data is rendered according to the API version at the time of its creation, as specified by the api_version attribute in the event object, rather than the current API version.

get/events

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/events
  • Auth
    HTTP bearer

Query parameters

created_afterstring date-time

Filter events created after this date (limited to the last 30 days)

order_direction'asc' | 'desc'

Order direction of the events list asc or desc (default: desc)

version'v1' | 'v2'

API version of the events to return v1 or v2 (default: based on registered webhook endpoint versions)

pageinteger

The page of results to return. Defaults to 1 if not provided.

page_sizeinteger

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Response

OK

pageinteger required

The current page of the results

page_sizeinteger required

The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size

total_countinteger required

The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.

has_next_pageboolean

Whether there are more pages available after this page

has_previous_pageboolean

Whether there are more pages available before this page

Example response

{
  "items": [
    {
      "id": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "created": "2024-12-01T00:00:00Z",
      "data": {
        "options": {
          "property_name_case_insensitive": true
        }
      }
    }
  ],
  "page": 1,
  "page_size": 20,
  "total_count": 1
}

Changes

  • 998f7cb004abRevision changes
    • warning

      deleted the header request parameter X-Platform-Id

  • 751269b628e8Revision changes
    • breaking

      the query request parameter order_direction was restricted to a list of enum values

    • breaking

      the query request parameter version was restricted to a list of enum values

    • warning

      for the query request parameter order_direction, the type of property allOf[OrderDirectionEnumParameter]/ changed from object to string

    • warning

      for the query request parameter version, the type of property allOf[WebhookVersionEnumParameter]/ changed from object to string

    • info

      added the new enum value asc to the query request parameter order_direction

    • info

      added the new enum value desc to the query request parameter order_direction

    • info

      added the new enum value v1 to the query request parameter version

    • info

      added the new enum value v2 to the query request parameter version

    • info

      added the enum value asc to the property allOf[OrderDirectionEnumParameter]/ of the query request parameter order_direction

    • info

      added the enum value desc to the property allOf[OrderDirectionEnumParameter]/ of the query request parameter order_direction

    • info

      added the enum value v1 to the property allOf[WebhookVersionEnumParameter]/ of the query request parameter version

    • info

      added the enum value v2 to the property allOf[WebhookVersionEnumParameter]/ of the query request parameter version

    • info

      for the query request parameter order_direction, the type was generalized from no type to string

    • info

      for the query request parameter version, the type was generalized from no type to string