Skip to content

Update index.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,23 @@ _**NOTE:** The Unlocking Simulation Source is currently in beta, which means tha

1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
2. Search for "Unlocking Simulation" in the Sources Catalog, select Unlocking Simulation, and click **Add Source**.
3. On the next screen, give the Source a nickname configure any other settings.
3. On the next screen, give the Source a nickname and configure any other settings.

- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).

4. Click **Add Source** to save your settings.
5. Copy the Write key from the Segment UI and log in to your Unlocking Simulation account - navigate to Settings > Integrations > Segment Integration and paste the key to connect.
5. Copy the Write key from the Segment UI and log in to your Unlocking Simulation account - click on Manage Sources to add your Segment Source details including the Write key.

## Stream

Unlocking Simulation uses our stream Source component to send Segment event data. It uses server-side (`track`, `identify`, `page`, `group`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
Unlocking Simulation uses our stream Source component to send Segment event data. It uses server-side (`track`, `identify`, and `group`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.

As part of the simulated events, Unlocking Simulation generates fake userIds and emails and includes them in the relevant traits and track events.


## Events

The events generated into Segment are based on what you configure within Unlocking Simulation. If, for example, you have set up Unlocking Simulation to generate a "Login" event for each new user on a daily basis, then that event will be generated into Segment.
The events generated into Segment are based on what you configure within Unlocking Simulation. If, for example, you have set up Unlocking Simulation to generate a "Login" event for each user, then that event will be generated into Segment.


## Event Properties
Expand All @@ -50,6 +50,5 @@ Now that your Source is set up, you can connect it with Destinations.

Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.

If there are any issues with how the events are arriving to Segment, [contact the Unlocking Simulation support team](mailto:support@Unlocking Simulation.com).

If there are any issues with how the events are arriving to Segment, [contact the Unlocking Simulation support team](mailto:support@unlockinggrowth.co).