Skip to content

Commit 0e96bd3

Browse files
forstisabellatcgilbert
forstisabella
and
tcgilbert
authored
Apply suggestions from code review
Co-authored-by: Thomas Gilbert <[email protected]>
1 parent e2c4a95 commit 0e96bd3

File tree

1 file changed

+23
-21
lines changed
  • src/connections/sources/catalog/cloud-apps/userguiding

1 file changed

+23
-21
lines changed

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

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
---
22
title: UserGuiding Source
3+
id: VShGHAfvlr
4+
hidden: true
5+
beta: true
36
---
47

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..
8+
[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.
69

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.
810

911
This source is maintained by UserGuiding. For any issues with the source, [contact their Support team](mailto:[email protected]).
1012

@@ -14,38 +16,38 @@ This source is maintained by UserGuiding. For any issues with the source, [conta
1416
2. Search for "UserGuiding" in the Sources Catalog, select UserGuiding, and click **Add Source**.
1517
3. On the next screen, give the Source a name configure any other settings.
1618

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).
19+
- 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. UserGuiding_Prod, UserGuiding_Staging, UserGuiding_Dev).
1820

1921
4. Click **Add Source** to save your settings.
2022
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.
23+
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.
2224

2325
## Stream
2426

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.
27+
UserGuiding uses a 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 as a schema in your data warehouse so you can query using SQL.
2628

2729
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.
2830

2931
## Events
3032

3133
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.
3234

33-
| Event Name | Description |
35+
| UserGuiding Event Name | Description |
3436
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | |
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 |
37+
| Guide started | It means that a user previews the first step of a Guide |
38+
| Guide completed | It means that the user has completed all steps of a Guide |
39+
| Hotspot interacted | 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) |
40+
| Checklist item trigger | It means that the user triggers a Checklist Guide |
41+
| Checklist item url click | It means that the user clicks a URL item on a Checklist |
42+
| Checklist completed | It means that the user completed a Checklist |
43+
| Resource center guide trigger | It means that the user triggered a Resource Center Guide |
44+
| Resource center checklist guide trigger | It means that a Guide in a Checklist put in a Resource Center as a module is triggered by a user |
45+
| Resource center checklist item url click | It means that a URL item in a Checklist put in a Resource Center as a module is clicked by a user |
46+
| Resource center external URL click | It means that a user clicks an external URL in a Resource Center |
47+
| Resource center article link click | It means that a user clicks a search article in a Resource Center |
48+
| Resource center survey trigger | It means that a user has triggered a survey in a Resource Center |
49+
| Survey shown | It means a survey was shown to a user |
50+
| Survey question answer | It means a survey question was answered by a user |
4951

5052

5153
## Event Properties
@@ -83,7 +85,7 @@ The table below list the properties included in the events listed above.
8385

8486
## Adding Destinations
8587

86-
Now that your Source is set up, you can connect it with Destinations.
88+
Now that your Source is set up, you can connect it to Destinations.
8789

8890
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.
8991

0 commit comments

Comments
 (0)