TRtrackstarhq
Events

Get Events

Changed on

Returns a feed of events for your organization, newest first: failed installs, connection lifecycle changes, sync activity, and schedule state changes. Narrow the feed with the integration, connection, customer, event type, and time filters. A start_date is required.

get/events

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/events
  • Auth
    none required

Query parameters

integration_namestring nullable
Example:shipbob

Filter events by integration name.

integration_typestring nullable
Example:wms

Filter events by integration type.

connection_idstring nullable
Example:07b344db-0304-4866-9ae1-ac8af5292a28

Filter events by connection id.

customer_idstring nullable
Example:customer_id

An identifier for your end customer.

type'install_failed' | 'connection_error' | 'schedule_stuck' | 'schedule_unstuck' | 'on_demand_sync_stuck' | 'connection_created' | 'connection_reinstalled' | 'connection_deleted' | 'connection_disabled' | 'connection_enabled' | 'schedule_paused' | 'schedule_unpaused' | 'on_demand_sync_started' | 'on_demand_sync_completed' | 'on_demand_sync_cancelled' | 'historical_sync_completed' nullable
Example:install_failed

Filter events by type.

start_datestring date-time required
Example:2024-01-01T00:00:00Z

Only return events at or after this time (ISO 8601).

end_datestring date-time nullable
Example:2024-01-31T23:59:59Z

Only return events at or before this time (ISO 8601).

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

Response

Successful response

next_tokenstring nullable required

See pagination for more details.

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "install_failed",
      "integration_name": "shipbob",
      "integration_type": "wms",
      "customer_id": "cust_123",
      "connection_id": "07b344db-0304-4866-9ae1-ac8af5292a28",
      "message": "Invalid credentials.",
      "created_at": "2024-01-15T12:00:00Z"
    }
  ],
  "next_token": "next_token"
}

Changes