Docs

Segment

Send guidance events to Segment, and use your Segment traits and events to target guidance.

The Segment connection works both ways. Set it up in Settings → Integrations → Segment.

Send events to Segment

Every few minutes, Cueston sends new guidance events to your Segment source as track calls, with the same userId and anonymousId your app uses. Analyse guidance in your warehouse, or trigger journeys from it.

  1. Paste your source's write key and pick its region (US or EU).
  2. Choose the events to send, and turn on Forward events to Segment.
  3. Send test event, then look for "Cueston Test Event" in Segment's debugger.
Segment eventSent when
Cueston Guidance ShownA tour, tooltip or banner was shown
Cueston Guidance CompletedSomeone finished a tour or acted on guidance
Cueston Guidance DismissedSomeone closed or skipped guidance

Properties are snake_case: content_type, content_id, content_name, step_index, step_id, reason (dismiss or skip), session_id, url and source: "cueston". Each event's messageId is unique, so Segment drops duplicates. Failed batches are retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 12 hours.

Receive traits and events from Segment

identify calls update each person's traits; track calls count as behaviour you can target, like "performed Report Exported at least 3 times".

  1. Create the inbound token. Copy the endpoint URL and the Authorization header value; the header is shown only once, and replacing it stops the old one.
  2. In Segment, add a Webhooks (Actions) destination to the source that tracks your app.
  3. Add mappings for Identify and Track that send the whole event (POST, JSON) to the endpoint URL, with the Authorization header.
  4. Send a test event from Segment. It shows up in Settings within a minute.

The endpoint takes single Segment messages or { "batch": [...] } with up to 500 messages, up to 1 MB per request. page and screen calls are kept as they are; group and alias are ignored. Messages are de-duplicated on messageId, so Segment's retries are harmless. It accepts up to 1,200 requests a minute per connection.

On this page