Skip to content

Commit e2c4a95

Browse files
ozan-koksalozan-koksal
committed
Added userguiding documentation
1 parent 85aa50e commit e2c4a95

File tree

1 file changed

+90
-0
lines changed
  • src/connections/sources/catalog/cloud-apps/userguiding

1 file changed

+90
-0
lines changed

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

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
title: UserGuiding Source
3+
---
4+
5+
[UserGuiding](https://userguiding.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a product adoption platform that helps product teams automate in-app experiences that turn new users into champions..
6+
7+
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
8+
9+
This source is maintained by UserGuiding. For any issues with the source, [contact their Support team](mailto:[email protected]).
10+
11+
## Getting started
12+
13+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
14+
2. Search for "UserGuiding" in the Sources Catalog, select UserGuiding, and click **Add Source**.
15+
3. On the next screen, give the Source a name configure any other settings.
16+
17+
- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name 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).
18+
19+
4. Click **Add Source** to save your settings.
20+
5. Copy the Write key from the Segment UI.
21+
6. Log in to your UserGuiding account - navigate to Settings > Integrations > Segment Integration and paste the key in the API Key textbox in the *Userguiding as a source* section to connect.
22+
23+
## Stream
24+
25+
UserGuiding uses our stream Source component to send Segment event data. It uses a server-side `track` method 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.
26+
27+
UserGuiding sends user identifiers in the `user_id` attribute in the event payload. This is the same identifier that is used in the `identify` call to UserGuiding.
28+
29+
## Events
30+
31+
The table below lists events that UserGuiding sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. UserGuiding includes the `userId` if available.
32+
33+
| Event Name | Description |
34+
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | |
35+
| Guide started (userguiding) | It means that a user previews the first step of a Guide |
36+
| Guide completed (userguiding) | It means that the user has completed all steps of a Guide |
37+
| Hotspot interacted (userguiding) | It means that the user interacted with a Hotspot group and saw a Hotspot as content. (remember, Hotspot groups can have multiple Hotspots as contents) |
38+
| Checklist item trigger (userguiding | It means that the user triggers a Checklist Guide |
39+
| Checklist item url click (userguiding) | It means that the user clicks a URL item on a Checklist |
40+
| Checklist completed (userguiding) | It means that the user completed a Checklist |
41+
| Resource center guide trigger (userguiding) | It means that the user triggered a Resource Center Guide |
42+
| Resource center checklist guide trigger (userguiding) | It means that a Guide in a Checklist put in a Resource Center as a module is triggered by a user |
43+
| Resource center checklist item url click (userguiding) | It means that a URL item in a Checklist put in a Resource Center as a module is clicked by a user |
44+
| Resource center external URL click (userguiding) | It means that a user clicks an external URL in a Resource Center |
45+
| Resource center article link click (userguiding) | It means that a user clicks a search article in a Resource Center |
46+
| Resource center survey trigger (userguiding) | It means that a user has triggered a survey in a Resource Center |
47+
| Survey shown (userguiding) | It means a survey was shown to a user |
48+
| Survey question answer (userguiding) | It means a survey question was answered by a user |
49+
50+
51+
## Event Properties
52+
53+
The table below list the properties included in the events listed above.
54+
55+
| Property Name | Description | Type |
56+
| -------------------- | ------------------------- | ---- |
57+
| `user_id` | User identifier | str |
58+
| `guideId` | Email event type | int |
59+
| `guideName` | Prospect user ID | str |
60+
| `pageUrl` | ID of the email | str |
61+
| `hotspotGroupId` | Sender email ID | int |
62+
| `hotspotGroupName` | Subject line of the email | str |
63+
| `hotspotId` | Subject line of the email | int |
64+
| `hotspotTitle` | Subject line of the email | str |
65+
| `checklistName` | URL of the link clicked | str |
66+
| `checklistId` | URL of the link clicked | int |
67+
| `checklistItemUrl` | URL of the link clicked | str |
68+
| `resourceCenterName` | URL of the link clicked | str |
69+
| `resourceCenterID` | URL of the link clicked | int |
70+
| `resourceCenterId` | URL of the link clicked | int |
71+
| `externalUrl` | URL of the link clicked | str |
72+
| `articleLink` | URL of the link clicked | str |
73+
| `surveyId` | URL of the link clicked | int |
74+
| `surveyName` | URL of the link clicked | str |
75+
| `questionId` | URL of the link clicked | str |
76+
| `questionName` | URL of the link clicked | str |
77+
| `score` | URL of the link clicked | int |
78+
| `surveyQuestion` | URL of the link clicked | str |
79+
| `emojiScore` | URL of the link clicked | str |
80+
| `choices` | URL of the link clicked | str |
81+
| `feedback` | URL of the link clicked | str |
82+
83+
84+
## Adding Destinations
85+
86+
Now that your Source is set up, you can connect it with Destinations.
87+
88+
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](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
89+
90+
If there are any issues with how the events are arriving to Segment, [contact the UserGuiding support team](mailto:[email protected]).

0 commit comments

Comments
 (0)