Jul 16, 2025 · Jul 17, 2025 · Jul 22, 2025 · Jul 22, 2025 · Jul 22, 2025 · Jul 23, 2025
diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md
 # 💥 Segment Partner Source Documentation Template

 > Hi Partners 👋🏼
 >
 > Welcome to Segment - glad to have you on board! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product.
 >
 > Here are the guidelines we want you to have in mind when writing out your documentation:
 >
 > - Be succinct and simple in your writing. Reduce text bloat where possible.
 > - Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner).
 > - Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation.
 >
 > - Screenshots/Images are generally discouraged unless absolutely necessary
 >
 > The below template intends to provide a standardized structure. To submit your documentation, complete the following steps:
 >
 > 1. Fork and clone the `segment-docs` repo locally
 > 2. Create a new branch (e.g., partner-name/source)
 > 3. Create an `index.md` file in the following path `src/connections/sources/catalog/cloud-apps/{source-slug}/index.md
 > 4. Copy the template below into your `index.md` file, and edit it to be in line with how your integration operates
 > 5. Add, commit, and push your code, then submit a pull request to the `segment-docs` repo
 >
 > If a section does not apply to your integration, feel free to remove. Please don’t create separate sections unless absolutely necessary. In most cases, creating a H3 (###) sub-heading under an existing section is the best option!
 >
 > If you have any questions in the meantime, please reach out to our team at partner-support@segment.com.

 ## Template begins here...
 ---
 title: Produktly Source
 ---

 > (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.

 [Produktly](https://produktly/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations.
 [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.

 > (delete after reading) Update your company name and support email address.

 This source is maintained by Produktly. For any issues with the source, [contact the Produktly Support team](mailto:support@produktly.com).

 ## Getting started

 > (delete after reading) Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey.

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

 > (delete after reading) Clarify the type of Segment events your integration will send.
 ## 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.

 > (delete after reading) Clarify how your integration includes user identifiers in your event payloads, the example below is from Klaviyo:

 The default behavior is for Klaviyo to pass the userId associated with the email recipient as the userId. There are cases in which Klaviyo does not have an associated userId, in which case the email address will be passed in as the anonymousId.
 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.

 > (delete after reading) For each of the below sections, populate the event and properties that a customer would expect to receive in their downstream tools from your Event Source.

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

 | Property Name   | Description               |
 | --------------- | ------------------------- |
 | `email_id`      | ID of the email           |
 | `from_id`       | Sender email ID           |
 | `email_subject` | Subject line of the email |
 | `link`          | URL of the link clicked   |

 #### 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

 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:support@produktly.com).

 > (delete after reading) Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team.
Original file line number	Diff line number	Diff line change
		@@ -1,48 +1,15 @@
		# 💥 Segment Partner Source Documentation Template

		> Hi Partners 👋🏼
		>
		> Welcome to Segment - glad to have you on board! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product.
		>
		> Here are the guidelines we want you to have in mind when writing out your documentation:
		>
		> - Be succinct and simple in your writing. Reduce text bloat where possible.
		> - Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner).
		> - Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation.
		>
		> - Screenshots/Images are generally discouraged unless absolutely necessary
		>
		> The below template intends to provide a standardized structure. To submit your documentation, complete the following steps:
		>
		> 1. Fork and clone the `segment-docs` repo locally
		> 2. Create a new branch (e.g., partner-name/source)
		> 3. Create an `index.md` file in the following path `src/connections/sources/catalog/cloud-apps/{source-slug}/index.md
		> 4. Copy the template below into your `index.md` file, and edit it to be in line with how your integration operates
		> 5. Add, commit, and push your code, then submit a pull request to the `segment-docs` repo
		>
		> If a section does not apply to your integration, feel free to remove. Please don’t create separate sections unless absolutely necessary. In most cases, creating a H3 (###) sub-heading under an existing section is the best option!
		>
		> If you have any questions in the meantime, please reach out to our team at partner-support@segment.com.

		## Template begins here...
		---
		title: Produktly Source
stayseesong marked this conversation as resolved. Show resolvedHide resolved
		---

		> (delete after reading) Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.

		[Produktly](https://produktly/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} provides self-serve predictive analytics for growth marketers, leveraging machine learning to automate audience insights and recommendations.
		[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.
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved

		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.
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved

		> (delete after reading) Update your company name and support email address.

		This source is maintained by Produktly. For any issues with the source, [contact the Produktly Support team](mailto:support@produktly.com).

		## Getting started

		> (delete after reading) Include clear, succinct steps including hyperlinks to where customers can locate the place in your app to enter their Segment writekey.

		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.
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved
		3. On the next screen, give the Source a name configure any other settings.
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved
Expand All		@@ -54,53 +21,129 @@ This source is maintained by Produktly. For any issues with the source, [contact
		6. Log in to your Produktly account - navigate to [Integrations](https://produktly.com/app/integrations){:target="_blank”}
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved
		7. Click on "Segment"
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved
		8. Paste the write key in the "Segment write key" field
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved
		9. Click on "Activate"
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved

		## Stream

		> (delete after reading) Clarify the type of Segment events your integration will send.
		## 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.
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved

		> (delete after reading) Clarify how your integration includes user identifiers in your event payloads, the example below is from Klaviyo:

		The default behavior is for Klaviyo to pass the userId associated with the email recipient as the userId. There are cases in which Klaviyo does not have an associated userId, in which case the email address will be passed in as the anonymousId.
		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.
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved

		> (delete after reading) For each of the below sections, populate the event and properties that a customer would expect to receive in their downstream tools from your Event Source.

		## 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 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.
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved

		\| Property Name \| Description \|
		\| --------------- \| ------------------------- \|
		\| `email_id` \| ID of the email \|
		\| `from_id` \| Sender email ID \|
		\| `email_subject` \| Subject line of the email \|
		\| `link` \| URL of the link clicked \|

		#### 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
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved

Expand All		@@ -109,5 +152,3 @@ 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.
Desentso marked this conversation as resolved. OutdatedShow resolvedHide resolved

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

		> (delete after reading) Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team.