Module segment::message

Representations of the messages which may be sent to Segment’s tracking API.

All Segment messages support a few common fields:

• Details related to user identification are captured by this library through the User enum.

• Some user traits and event properties are specified through the Segment spec – these are standardized members which, if followed, will be converted to the native equivalent of each tool.

  • Standardized event names and properties are specified in Segment’s semantic events docs.
  • Standardized user traits are specified in Segment’s identify traits docs.
  • Standardized group traits are specified in Segment’s group traits docs.

• All Segment messages support a context field containing additional contextual details. This field is exposed in this library as context. The data in context is standardized, and is documented in Segment’s context docs.

• All Segment messages support an integrations field that enables simple routing at the event collection layer. See Segment’s integrations docs for how to use this field.

Structs

• Alias
  An alias event.
• Batch
  A batch of events.
• Group
  A group event.
• Identify
  An identify event.
• Page
  A page event.
• Screen
  A screen event.
• Track
  A track event.

Enums

• BatchMessage
  An enum containing all messages which may be placed inside a batch.
• Message
  An enum containing all values which may be sent to Segment’s tracking API.
• User
  User ID information.