Skip to content

Commit 78ebd66

Browse files
jpguptajpgupta
committed
Add more detail
1 parent 1af97cd commit 78ebd66

File tree

1 file changed

+42
-3
lines changed
  • src/connections/sources/catalog/cloud-apps/synap

1 file changed

+42
-3
lines changed

‎src/connections/sources/catalog/cloud-apps/synap/index.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ beta: true
66

77
[Synap](https://synap.ac){:target="_blank”} is an online exam platform specialising in the delivery of high stakes exams, assessments and online learning. Synap is used by a wide range of companies and educational institutions to deliver high quality, robust assessments.
88

9-
This source is maintained by Synap. For any issues with the source, contact Synap via the live chat widget available on your portal, or get in touch with your account manager. Synap also provides more detailed documentation with specific guides and best-practices [here](https://academy.synap.ac/doc/integrations/segment){:target="_blank”}.
9+
This source is maintained by Synap. For any issues with the source, contact Synap via the live chat widget available on your portal, or get in touch with your account manager. Synap also provides more [detailed documentation](https://academy.synap.ac/doc/integrations/segment){:target="_blank”} with specific guides and best-practices.
1010

1111
## Getting started
1212

@@ -22,11 +22,12 @@ This source is maintained by Synap. For any issues with the source, contact Syna
2222

2323
## Stream
2424

25-
Synap uses our stream Source component to send Segment event data. It uses a server-side Identify, Track, Page and Group methods 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 that you can query using SQL.
25+
Synap uses our stream Source component to send Segment event data. On the client-side, it uses Segment's Identify and Page events. On the server-side it also uses Identify as well as Track events. These events are then available in any destination that accepts client or server-side events, and available in a schema in your data warehouse that you can query using SQL.
2626

2727
Synap identifies users based on their Synap User ID, which is sent as the userId in Segment events.
2828

2929
## Events
30+
3031
The table below lists events that Synap sends to Segment. These events appear as tables in your warehouse, and as regular events in other destinations. Synap includes the userId, if available.
3132

3233
| Event Name | Description |
@@ -41,10 +42,48 @@ The table below lists events that Synap sends to Segment. These events appear as
4142
| User Logged In | User explicitly logged in to Synap |
4243
| User Session Restored | User opened Synap after a period of in activity |
4344

45+
To find the list of properties associated with the events, please refer to the [Synap Segment Documentation](https://academy.synap.ac/doc/integrations/segment){:target="_blank”}. Some of our events, notably those related to Test and Question submission, have relatively large payloads and you may wish to review the [Synap Test and Question Analytics Schemas](https://academy.synap.ac/doc/integrations/segment/test-and-question-analytics){:target="_blank"}
46+
47+
## Identify
48+
49+
Synap sends an identify() message to Segment which consists of the userId and the user traits.
50+
51+
| Field | Type | Description |
52+
| ------- | ------ | --------------------------------------------------------------------------------------------------------- |
53+
| userId | string | Unique identifier for the user in Synap |
54+
| context | object | User [context](https://segment.com/docs/connections/spec/common/#context) |
55+
| traits | object | Custom [traits](https://segment.com/docs/connections/spec/common/#traits) of the user (See Traits Object) |
56+
57+
### Identify Traits
58+
59+
| Name | Type | Description |
60+
| ---------------------- | ----------------------------------- | ----------------------------------------------------------------------- |
61+
| createdAt | date | The date this user's account was created |
62+
| email | string | The user's email address |
63+
| emailVerified | boolean | Whether or not the user has verified their email address |
64+
| firstName | string | The user's first name |
65+
| lastName | string | The user's last name |
66+
| marketingEmailsConsent | "removed", "pending" or "confirmed" | Enumeration representing the user's consent to receive marketing emails |
67+
| name | string | The user's full name |
68+
| profilePicture | string | a URL pointing to the user's profile picture, if provided |
69+
70+
71+
## Page
72+
73+
Page calls will show the page path and unique URL
74+
75+
| Property | Example | Description |
76+
| -------- | ----------------------------------------------- | ---------------------------------------- |
77+
| name | Springfield Portal | The name of the page |
78+
| path | /quiz/a/abc123 | The relative path to the page |
79+
| search | ?mode=test | Any query string parameters from the URL |
80+
| title | Springfield Summer Exam | The title of the page |
81+
| url | https://portal.synap.ac/quiz/a/abc123?mode=test | The full URL of the page |
82+
4483
## Adding Destinations
4584

4685
Now that your source is set up, you can connect it to destinations.
4786

4887
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 tool, and refer to the destination docs for each tool for troubleshooting.
4988

50-
If there are any issues with how the events are arriving to Segment, contact the Synap support team.
89+
If there are any issues with how the events are arriving to Segment, contact the Synap support team via the live chat widget which is available to all Admin users of your portal.

0 commit comments

Comments
 (0)