Segment

Use Segment to connect Synap to hundreds of other tools and platforms.

is a fantastic platform and one we highly recommend. Segment unifies all of your data and makes sure its ready to go into other tools in the right way. Using segments means you don't need to installing different codes onto your website / portals in order to connect it to other tools.

A really common integration is connecting Synap (Source see ) to a chat widget like (Destination see ) you can also :

Analytical tools such as Google Analytics, Mixpanel & Localytics
💬 Support/Engagement platforms such as Intercom, Aircall, Mailchimp & Salesforce
📣 Advertisement tools such as Facebook & Google Ads

If you already have a Segment account, create a new source for Synap add in the URL. Once the source is set up, copy the Write key

Head over to Settings > Integrations. From here you'll see a box to input your Segment Write key.

Event Data

Identify

Attributes attached to the user will show in Segment as EI- see below for an example of an Identify call payload.

{
  "userId": "QsogF1GDFZ",
  "traits": {
    "EI-Role": "Health and Safety Manager",
    "createdAt": "new Date('2021-11-26T10:09:52.447Z')",
    "email": "homer_simpson@spfield.com",
    "emailVerified": false,
    "firstName": "Homer",
    "lastName": "Simpson",
    "marketingEmailsConsent": "removed",
    "name": "Homer Simpson",
    "profilePicture": "https://upload.wikimedia.org/wikipedia/en/0/02/Homer_Simpson_2006.png"
  }
}

Track

Began test is an example of a Track event, it is linked to the user using their userId these events tend to exclude titles and rely on testId and attemptId Note: an attemptId is a users unique attempt on a particular testId

{
  "event": "Began Test",
  "integrations": {},
  "messageId": "node-xxxxxxxxxx",
  "originalTimestamp": "2022-01-18T18:37:43.245Z",
  "properties": {
    "Quiz Mode": "test",
    "attemptId": "rae6sql3AD",
    "testId": "RG70wQdFDl"
  },
  "receivedAt": "2022-01-18T18:37:43.872Z",
  "sentAt": "2022-01-18T18:37:43.246Z",
  "timestamp": "2022-01-18T18:37:43.871Z",
  "type": "track",
  "userId": "QsogF1GDFZ"
}

Page

Page calls will show the page path and unique URL. Synap content pages will always contain an identifier in the url ie:

/collections/
/assignment/
/quiz/
/insights/

{
  "name": "Springfield Portal",
  "path": "/quiz/a/rae6sql3AD",
  "referrer": "",
  "search": "?title=Springfield%Exam",
  "title": "Springfield Summer Exam",
  "url": "https://portal.synap.ac/quiz/a/rae6sql3AD?title=Springfield%Exam"
}

PreviousExample Workflows NextTest & Question Analytics

Last updated 1 year ago

Was this helpful?

{ "userId": "QsogF1GDFZ", "traits": { "EI-Role": "Health and Safety Manager", "createdAt": "new Date('2021-11-26T10:09:52.447Z')", "email": "homer_simpson@spfield.com", "emailVerified": false, "firstName": "Homer", "lastName": "Simpson", "marketingEmailsConsent": "removed", "name": "Homer Simpson", "profilePicture": "https://upload.wikimedia.org/wikipedia/en/0/02/Homer_Simpson_2006.png" } }

{ "event": "Began Test", "integrations": {}, "messageId": "node-xxxxxxxxxx", "originalTimestamp": "2022-01-18T18:37:43.245Z", "properties": { "Quiz Mode": "test", "attemptId": "rae6sql3AD", "testId": "RG70wQdFDl" }, "receivedAt": "2022-01-18T18:37:43.872Z", "sentAt": "2022-01-18T18:37:43.246Z", "timestamp": "2022-01-18T18:37:43.871Z", "type": "track", "userId": "QsogF1GDFZ" }

{ "name": "Springfield Portal", "path": "/quiz/a/rae6sql3AD", "referrer": "", "search": "?title=Springfield%Exam", "title": "Springfield Summer Exam", "url": "https://portal.synap.ac/quiz/a/rae6sql3AD?title=Springfield%Exam" }