Skip to content
HeyX API

List Customer Timeline Events

Required scope: customer_activity:read

Use this endpoint to read a customer’s activity timeline: the audit and lifecycle events recorded against the customer, newest first. Each event exposes its eventType, the entityType and entityId it concerns, a safe human-readable summary, and when it occurredAt.

Pass an optional transactionId to restrict the timeline to a single transaction on the customer.

Entries are limited by the API key member’s audit and order visibility, so the timeline may be partial. The raw event payload is not exposed; the summary string is the safe, bounded description of each event.

Generated Reference
POST /public-api/publicapi.v1.Customer/ListCustomerTimelineEvents

Lists a customer's activity timeline: audit and lifecycle events recorded against the customer. Entries are limited by the API key member's audit and order visibility, so the timeline may be partial. Read-only.

Request ListCustomerTimelineEventsRequest
Response ListCustomerTimelineEventsResponse

ListCustomerTimelineEventsRequest

Field Type Description
customer_id string Customer whose activity timeline is returned.
transaction_id optional string Restrict the timeline to a single transaction on the customer.

ListCustomerTimelineEventsResponse

Field Type Description
events repeated CustomerTimelineEvent Timeline events the API key's member may see, newest first.

Related Types

CustomerTimelineEvent

Field Type Description
id string Stable identifier of the timeline event.
event_type string Machine-readable event type, for example "comment_created".
entity_type string Type of the entity the event concerns, for example "customer" or "order".
entity_id string Identifier of the entity the event concerns, when one applies.
summary string Short human-readable summary of the event, safe to display. Empty when the event recorded no summary.
occurred_at int64 Unix timestamp in seconds when the event occurred.
transaction_id optional string Transaction the event belongs to, when it was recorded within one.

Request

Section titled “Request”
{
  "customerId": "be85f4d1-b680-4964-bf62-9828fdf4ce04"
}

Example

Section titled “Example”
Terminal window
curl https://portal.heyx.app/public-api/publicapi.v1.Customer/ListCustomerTimelineEvents \
  -H "Authorization: Bearer hx_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"customerId": "be85f4d1-b680-4964-bf62-9828fdf4ce04"}'

Response

Section titled “Response”
{
  "events": [
    {
      "id": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
      "eventType": "comment_created",
      "entityType": "comment",
      "entityId": "a2ec8aef-691a-4e9d-b4fd-52e255883c6c",
      "summary": "Alex Example added a comment",
      "occurredAt": 1735689600
    }
  ]
}
HeyX API