RudderStack event stream

Setup Steps

1. Add Accoil as a Destination

In the RudderStack dashboard:

Navigate to Destinations > Add Destination
Search for Accoil Analytics
Assign a name and enter your Accoil API Key (found under Workspace > Settings > Account Settings > General in Accoil)
Save and enable the destination

Supported Message Types

Event Type	Supported
`identify`	✅
`track`	✅
`page`	✅ (as `track`)
`screen`	✅ (as `track`)
`group`	✅
`alias`	❌
`record`	❌

Event Mapping Details

`identify` Events

Used to identify users and send associated traits.

rudderanalytics.identify("user-123", {
  email: "[email protected]",
  name: "Alex Keener",
  createdAt: "2023-05-12T08:00:00Z",
  role: "admin",
  accountStatus: "trial"
});

Field	Required	Notes
`userId`	✅	Unique user identifier
`traits`	Optional	Sent as-is to Accoil
`timestamp`	✅	Automatically handled by RudderStack (ISO 8601 or UNIX format)

Supported Traits (Recommended)

Trait	Purpose
`email`	Primary user identity (used in UI)
`name`	Display name in Accoil
`createdAt`	Enables tenure tracking
`role`	Useful for filtering and segmentation
`accountStatus`	Useful for lifecycle segmentation (`trial`, `paid`, etc.)

`track` Events

Captures product activity by event name. Event properties are not persisted—only the event name and timestamp are used for engagement metrics.

rudderanalytics.track("Feature Used", {
  feature: "Reports Dashboard"
});

Field	Required	Notes
`event`	✅	Event name
`userId`	✅	Must match an identified user
`timestamp`	✅	Automatically handled by RudderStack

`group` Events

Used to associate users with accounts and send account-level traits.

rudderanalytics.group("account-456", {
  name: "Acme Inc.",
  industry: "Fintech",
  employees: 120,
  plan: "Enterprise",
  status: "paid",
  mrr: 100000, // in cents
  createdAt: "2022-01-15T09:00:00Z"
});

Field	Required	Notes
`groupId`	✅	Unique account identifier
`userId`	✅	Links the user to the account
`traits`	Optional	Sent as-is to Accoil
`timestamp`	✅	Automatically handled by RudderStack

Supported Group Traits (Recommended)

Trait	Purpose
`name`	Account name used in UI
`status`	Account state (e.g., `free`, `trial`, `paid`)
`plan`	Subscription tier (`starter`, `pro`, `enterprise`)
`mrr`	Monthly recurring revenue (pass in cents)
`createdAt`	Enables account tenure tracking

`page` Events

Sent as track events to Accoil. Useful for pageview analytics.

rudderanalytics.page("Cart", "Cart Viewed");

Field	Required	Notes
`name`	✅	Page name
`userId`	✅	From previous `identify` call
`timestamp`	✅	Auto-added

`screen` Events (Mobile)

Also sent as track events. Use to monitor screen views in mobile apps.

[[RSClient sharedInstance] screen:@"Main"
                properties:@{@"category" : @"Home"}];

Field	Required	Notes
`name`	✅	Screen name
`userId`	✅	From previous `identify` call
`timestamp`	✅	Auto-added

Data Handling Notes

Accoil does not persist custom properties from track events.
Traits from identify and group events are stored and used for segmentation, dashboards, and recipes.
Ensure consistent use of userId and groupId across your events.
Timestamps are automatically included and required for all events.

Troubleshooting

Issue	Check
Events not showing	Confirm API Key is correct
Missing accounts	Ensure `group` calls are sent properly
No user traits	Verify `identify` events are structured
Data looks incomplete	Validate timestamps and required fields