-
Notifications
You must be signed in to change notification settings - Fork 379
Add Produktly source docs #7773
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Desentso
wants to merge
9
commits into
segmentio:develop
Choose a base branch
from
Desentso:produktly-source-docs
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
fbefe84
Start adding Produktly source docs
Desentso d29d7bd
Add event properties, Add Produktly description, Remove guidance comm…
Desentso 6b3e666
Change event names to Proper Case
Desentso 29d9b62
Update properties to snake case
Desentso 91a54fa
Update event properties titles to Proper Case
Desentso 994b430
Apply suggestions from code review
Desentso 96d9d85
Apply suggestions from code review (that differ from template)
Desentso 4a85a79
Update event properties to single list
Desentso 3b40785
Update src/connections/sources/catalog/cloud-apps/produktly/index.md
stayseesong File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
80 changes: 80 additions & 0 deletions
80
src/connections/sources/catalog/cloud-apps/produktly/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
--- | ||
title: Produktly Source | ||
id: i7L2r4pbJr | ||
--- | ||
|
||
[Produktly](https://produktly/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is an all-in-one platform for product-led growth. Produktly provides a suite of tools such as product tours, checklists, feedback widgets, NPS, announcements, changelogs, roadmaps and much more, that drive growth by helping you improve onboarding, effectively communicate with customers, and by helping you gather actionable feedback. | ||
|
||
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which enables you to export data into your Segment warehouse, and also federate the exported data into your other enabled Segment Destinations. | ||
|
||
This source is maintained by Produktly. For any issues with the source, [contact the Produktly Support team](mailto:[email protected]). | ||
|
||
## Getting started | ||
|
||
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**. | ||
2. Search for *Produktly* in the Sources Catalog, select **Produktly**, and click **Add Source**. | ||
3. Give the Source a name and configure any other settings. | ||
|
||
- 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). | ||
|
||
4. Click **Add Source** to save your settings. | ||
5. Copy the Write key. | ||
6. Log in to your Produktly account and navigate to [Integrations](https://produktly.com/app/integrations){:target="_blank”}. | ||
7. Click **Segment**. | ||
8. Paste the write key in **Segment write key**. | ||
9. Click **Activate**. | ||
|
||
## Stream | ||
|
||
Produktly uses Segment's 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 are available in a schema in your data warehouse so you can query using SQL. | ||
|
||
Produktly passes the associated userId when you're using [the identifyUser feature](https://produktly.com/docs/docs/integration/identify-users){:target="_blank”}. If the user is not identified then a Produktly generated UUID will be used instead. This UUID will stay the same for the user as long as they are using the same browser. | ||
|
||
|
||
## Events | ||
|
||
The table below lists events that Produktly sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. Produktly includes the `userId` if available. | ||
|
||
| Event Name | Description | | ||
| ----------------------------- | ------------------------------------------- | | ||
| `Tour Available` | Tour was available for user | | ||
| `Tour Start` | Tour was started by user | | ||
| `Tour Auto Start` | Tour was automatically started | | ||
| `Tour Continue` | Tour was continued by user | | ||
| `Tour Finish` | Tour was finished by user | | ||
| `Tour Step` | User saw a specific step of a tour | | ||
| `Checklist Step Completed` | User completed a step of a checklist | | ||
| `Checklist Finished` | User completed all the steps in a checklist | | ||
| `Smart Tip Available` | Smart tip was available for user | | ||
| `Smart Tip Open` | Smart tip was opened | | ||
| `Announcement Shown` | Announcement was shown to user | | ||
| `Announcement Action Clicked` | User clicked on announcement action | | ||
| `Announcement Closed` | Announcement was closed by user | | ||
| `Nps Widget Shown` | NPS widget was shown to user | | ||
|
||
|
||
|
||
## Event Properties | ||
|
||
See the list of event properties. | ||
|
||
|
||
| Property Name | Description | | ||
| ----------------- | ------------------------ | | ||
| `tour_id` | Id of the tour | | ||
| `metadata` | (For the `Tour Step` event) Object that contains `stepIndex` of the tour that was viewed, and `type` either "next" or "previous" telling whether the user moved forward or backwards | | ||
| `checklist_id` | Id of the checklist | | ||
| `metadata` | (For the `Checklist Step Completed` event) Object that contains `stepId` of the checklist that was completed | | ||
| `smart_tip_id` | Id of the smart tip | | ||
| `announcement_id` | Id of the announcement | | ||
| `nps_widget_id` | Id of the NPS widget | | ||
|
||
|
||
|
||
## Adding destinations | ||
|
||
Once your Source is set up, you can connect it with Destinations. | ||
|
||
Log in to 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. | ||
|
||
If there are any issues with how the events are arriving to Segment, [contact the Produktly support team](mailto:[email protected]). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.