Getting Started
Prerequisites
- You are a customer of Segment, have a project with them, and have a Write Key (which you can find in your project setup guide or settings)
- You are a customer of Boomtrain and have an App ID (provided by Boomtrain)
Steps
- Enter in your workspace slug, project name, and partner slug (boomtrain) in the URL below:
https://segment.com/WORKSPACESLUG/sources/PROJECTNAME/integrations/PARTNERSLUG
(E.g. https://segment.com/jacob-workspace/sources/testproject/integrations/boomtrain)
- Click Settings, and enter your App ID (from Boomtrain) into the API Key field
- Click Save Changes, and then Enable Integration (bottom)
- If you haven’t, follow the Quickstart guide by Segment to get analytics.js on your webpage
Documentation
When you turn on Boomtrain in Segment, this is what happens:
- The Boomtrain snippet will start asynchronously loading Boomtrain's Javascript library onto your page.
- Once loaded, the Boomtrain Javascript library will automatically start sending events to the Boomtrain system indicating that the current page has been viewed.
- When users visit pages on your site, the "viewed" events sent to the Boomtrain system will trigger ingestion of your content and processing by our machine learning algorithms.
- To start sending custom events and user data, use the Javascript methods described below.
Identify
When you call identify
on analytics.js, we call identify
on the Boomtrain Javascript library with the userId
, and person.set
on the Boomtrain Javascript Library with the traits
object. A userId
must be specified (first parameter) and a email
property within the traits
object (second parameter) must be specified. For additional details about the Boomtrain identify
and person.set
methods see this article and this article on the Boomtrain Developer Documentation.
analytics.identify(
'{{email}}',
{
'email':'{{email}}',
'property':'value'
}
);
Track
When you call track
, we will send the event
you specify to the track
method on the Boomtrain Javascript library, along with the properties you provide. For additional details about the Boomtrain track
method see this article on the Boomtrain Developer Documentation.
analytics.track(
'shared',
{
'media':'email'
}
);
Settings
Segment lets you change these settings on the Integrations page, without having to touch any code.
App ID
The App ID for your app can be taken from the integration guide provided by Boomtrain to your company. For additional information about your App ID or integration details, contact your Boomtrain CSM or [email protected].
If you have any questions, or suggestions on we can improve this documentation, feel free to contact us.