Skip to content

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.

Sign up for GitHub

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
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Add Produktly source docs #7773

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbefe84
Start adding Produktly source docs
Desentso Jul 16, 2025
d29d7bd
Add event properties, Add Produktly description, Remove guidance comm…
Desentso Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 154 additions & 0 deletions src/connections/sources/catalog/cloud-apps/produktly/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
---
title: Produktly Source
---

[Produktly](https://produktly/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is an all-in-one platform for product-led growth. We provide a suite tools such as product tours, checklists, feedback widgets, NPS, announcements, changelogs, roadmaps and much more, that drive growth by helping you improving onboarding, effectively communicate with customers and by helping you gather actionable feedback.

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.

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. On the next screen, give the Source a name 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 from the Segment UI.
6. Log in to your Produktly account - navigate to [Integrations](https://produktly.com/app/integrations){:target="_blank”}
7. Click on "Segment"
8. Paste the write key in the "Segment write key" field
9. Click on "Activate"

## Stream

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

Produktly will pass the associated userId when you are 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

The table below list the properties included in the events listed above.

#### tour_available

| Property Name | Description |
| ----------------- | ------------------------ |
| `tourId` | Id of the tour |

#### tour_start

| Property Name | Description |
| ----------------- | ------------------------ |
| `tourId` | Id of the tour |

#### tour_auto_start

| Property Name | Description |
| ----------------- | ------------------------ |
| `tourId` | Id of the tour |

#### tour_continue

| Property Name | Description |
| ----------------- | ------------------------ |
| `tourId` | Id of the tour |

#### tour_finish

| Property Name | Description |
| ----------------- | ------------------------ |
| `tourId` | Id of the tour |

#### tour_step

| Property Name | Description |
| ----------------- | ------------------------ |
| `tourId` | Id of the tour |
| `metadata` | 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_step_completed

| Property Name | Description |
| ----------------- | ------------------------ |
| `checklistId` | Id of the checklist |
| `metadata` | Object that contains `stepId` of the checklist that was completed |

#### checklist_finished

| Property Name | Description |
| ----------------- | ------------------------ |
| `checklistId` | Id of the checklist |

#### smart_tip_available

| Property Name | Description |
| ----------------- | ------------------------ |
| `smartTipId` | Id of the smart tip |

#### smart_tip_open

| Property Name | Description |
| ----------------- | ------------------------ |
| `smartTipId` | Id of the smart tip |

#### announcement_shown

| Property Name | Description |
| ----------------- | ------------------------ |
| `announcementId` | Id of the announcement |

#### announcement_action_clicked

| Property Name | Description |
| ----------------- | ------------------------ |
| `announcementId` | Id of the announcement |

#### announcement_closed

| Property Name | Description |
| ----------------- | ------------------------ |
| `announcementId` | Id of the announcement |

#### nps_widget_shown

| Property Name | Description |
| ----------------- | ------------------------ |
| `npsWidgetId` | Id of the NPS widget |



## Adding Destinations

Now that your Source is set up, you can connect it with Destinations.

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.

If there are any issues with how the events are arriving to Segment, [contact the Produktly support team](mailto:[email protected]).