RudderStack Event Specification
Learn the fields and properties associated with the standard RudderStack API methods.
The RudderStack Event Spec outlines how to send event data to RudderStack’s APIs and the proper format to capture events using RudderStack’s SDKs.
The RudderStack Event Spec supports multiple API calls that make it easy to identify users and track their specific actions as events. Using the correct format to capture events ensures that RudderStack can automatically forward those events to any of our supported destinations.
Supported API calls
The RudderStack API spec supports the following calls, each gathering important data about the user:
API call | Description |
---|
Identify | The user’s identity |
Page | Web page details of the user’s current page |
Screen | App screen details |
Track | Details of user actions (for example, Clicks, Sign ups, and Purchases) |
Group | Group or organization details |
Alias | Merge identities to a known user |
Merge | Perform identity resolution by associating different identifiers to a given customer profile in the warehouse (Deprecated) |
Reset | Resets the information related to the previously identified user |
Refer to the corresponding
SDK documentation for the implementation specifics of the above calls.
How the API calls work
Here’s a quick overview of how the API calls work:
- A customer interacts with your website/app triggering an event.
- When an API is called, the event data is sent to the RudderStack backend.
- RudderStack transforms the event data into a destination-specific format.
- The transformed data is then sent to all requested destinations.
The event data is collected in JSON and includes the Common Fields along with API-specific fields.
It is strongly recommended large integer values be passed as strings. This ensures that the values are correctly transmitted to all systems (including various downstream destinations) without any issues.
RudderStack follows the RFC 7159 standard which has an upper limit of 253 for integers. If the values passed exceed this number, you may lose precision. Furthermore, certain downstream destinations have their own limitations on parsing large integer values.
Industry Specs
Questions? Contact us by email or on
Slack