|
| 1 | +--- |
| 2 | +title: [Synap] Source |
| 3 | +--- |
| 4 | + |
| 5 | +[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. |
| 6 | + |
| 7 | +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”}. |
| 8 | + |
| 9 | +## Getting started |
| 10 | + |
| 11 | +1. From your workspace's `/sources` page, click `Add source`. |
| 12 | + |
| 13 | +2. Search for and choose Synap. |
| 14 | + |
| 15 | +3. Copy the Write key from the Segment UI |
| 16 | + |
| 17 | +4. Login to your Synap portal as an admin, and go to `/portal-dashboard/settings/integrations`. To navigate to this page via the UI, first click on the 'gears' icon near the bottom left hand side of the screen, then look for the Integrations menu item |
| 18 | + |
| 19 | +5. Paste your write key into the Segment Write Key box and click Save - this will verify and save your API key. |
| 20 | + |
| 21 | +## Stream |
| 22 | + |
| 23 | +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, so you can query using SQL. |
| 24 | + |
| 25 | +Synap identifies users based on their Synap User ID, which will be sent as the userId in Segment events. |
| 26 | + |
| 27 | +Events |
| 28 | +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. |
| 29 | + |
| 30 | +| Event Name | Description | |
| 31 | +| ---------------------- | ----------------------------------------------------------------- | |
| 32 | +| Began Test | User starts a test | |
| 33 | +| Submitted Test | User finishes ('submits') a test (may or may not require marking) | |
| 34 | +| Completed Test | When a Test has been 'completed' (including marking) | |
| 35 | +| Collection Item Viewed | User views a Collection Item | |
| 36 | +| User Registered | User registered an Account | |
| 37 | +| Assignment Started | User starts an Assignment | |
| 38 | +| Exam User Registered | User is enrolled for an Exam | |
| 39 | +| User Logged In | User explicitly logged in to Synap | |
| 40 | +| User Session Restored | User opened Synap after a period of in activity | |
| 41 | + |
| 42 | +## Adding Destinations |
| 43 | + |
| 44 | +Now that your Source is set up, you can connect it with Destinations. |
| 45 | + |
| 46 | +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. |
| 47 | + |
| 48 | +If there are any issues with how the events are arriving to Segment, contact the Synap support team. |
0 commit comments