From fbefe8424f907dbfb267fda33b244ec933f91d70 Mon Sep 17 00:00:00 2001 From: Desentso Date: Thu, 17 Jul 2025 00:53:45 +0300 Subject: [PATCH 1/8] Start adding Produktly source docs --- .../catalog/cloud-apps/produktly/index.md | 113 ++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 src/connections/sources/catalog/cloud-apps/produktly/index.md diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md new file mode 100644 index 0000000000..b3244bca07 --- /dev/null +++ b/src/connections/sources/catalog/cloud-apps/produktly/index.md @@ -0,0 +1,113 @@ +# šŸ’„ 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. + +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. + + - 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 + +## Stream + +> (delete after reading) Clarify the type of Segment events your integration will send. + +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. + +> (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 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 | + + +## 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: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. \ No newline at end of file From d29d7bd5d9d0cadff085d076f25fd82ca2c819b7 Mon Sep 17 00:00:00 2001 From: Desentso Date: Thu, 17 Jul 2025 21:28:34 +0300 Subject: [PATCH 2/8] Add event properties, Add Produktly description, Remove guidance comments --- .../catalog/cloud-apps/produktly/index.md | 173 +++++++++++------- 1 file changed, 107 insertions(+), 66 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md index b3244bca07..d9d3540aad 100644 --- a/src/connections/sources/catalog/cloud-apps/produktly/index.md +++ b/src/connections/sources/catalog/cloud-apps/produktly/index.md @@ -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 --- -> (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. @@ -54,39 +21,35 @@ 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ā€} 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 | @@ -94,13 +57,93 @@ The table below lists events that Produktly sends to Segment. These events appea 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 @@ -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. 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. \ No newline at end of file From 6b3e66675c011732cdeff5c1caea7269558774ee Mon Sep 17 00:00:00 2001 From: Desentso Date: Tue, 22 Jul 2025 18:40:18 +0300 Subject: [PATCH 3/8] Change event names to Proper Case --- .../catalog/cloud-apps/produktly/index.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md index d9d3540aad..ad7fffc677 100644 --- a/src/connections/sources/catalog/cloud-apps/produktly/index.md +++ b/src/connections/sources/catalog/cloud-apps/produktly/index.md @@ -36,20 +36,20 @@ The table below lists events that Produktly sends to Segment. These events appea | 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 | +| `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 | From 29d9b62d779876786f393d105ae677f5e5239d8b Mon Sep 17 00:00:00 2001 From: Desentso Date: Tue, 22 Jul 2025 18:43:45 +0300 Subject: [PATCH 4/8] Update properties to snake case --- .../catalog/cloud-apps/produktly/index.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md index ad7fffc677..e6d05eec4e 100644 --- a/src/connections/sources/catalog/cloud-apps/produktly/index.md +++ b/src/connections/sources/catalog/cloud-apps/produktly/index.md @@ -61,87 +61,87 @@ The table below list the properties included in the events listed above. | Property Name | Description | | ----------------- | ------------------------ | -| `tourId` | Id of the tour | +| `tour_id` | Id of the tour | #### tour_start | Property Name | Description | | ----------------- | ------------------------ | -| `tourId` | Id of the tour | +| `tour_id` | Id of the tour | #### tour_auto_start | Property Name | Description | | ----------------- | ------------------------ | -| `tourId` | Id of the tour | +| `tour_id` | Id of the tour | #### tour_continue | Property Name | Description | | ----------------- | ------------------------ | -| `tourId` | Id of the tour | +| `tour_id` | Id of the tour | #### tour_finish | Property Name | Description | | ----------------- | ------------------------ | -| `tourId` | Id of the tour | +| `tour_id` | Id of the tour | #### tour_step | Property Name | Description | | ----------------- | ------------------------ | -| `tourId` | Id of the tour | +| `tour_id` | 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 | +| `checklist_id` | 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 | +| `checklist_id` | Id of the checklist | #### smart_tip_available | Property Name | Description | | ----------------- | ------------------------ | -| `smartTipId` | Id of the smart tip | +| `smart_tip_id` | Id of the smart tip | #### smart_tip_open | Property Name | Description | | ----------------- | ------------------------ | -| `smartTipId` | Id of the smart tip | +| `smart_tip_id` | Id of the smart tip | #### announcement_shown | Property Name | Description | | ----------------- | ------------------------ | -| `announcementId` | Id of the announcement | +| `announcement_id` | Id of the announcement | #### announcement_action_clicked | Property Name | Description | | ----------------- | ------------------------ | -| `announcementId` | Id of the announcement | +| `announcement_id` | Id of the announcement | #### announcement_closed | Property Name | Description | | ----------------- | ------------------------ | -| `announcementId` | Id of the announcement | +| `announcement_id` | Id of the announcement | #### nps_widget_shown | Property Name | Description | | ----------------- | ------------------------ | -| `npsWidgetId` | Id of the NPS widget | +| `nps_widget_id` | Id of the NPS widget | From 91a54fa931de547e8bad8244f37ff73890192d11 Mon Sep 17 00:00:00 2001 From: Desentso Date: Tue, 22 Jul 2025 18:54:00 +0300 Subject: [PATCH 5/8] Update event properties titles to Proper Case --- .../catalog/cloud-apps/produktly/index.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md index e6d05eec4e..8bc12ffbb7 100644 --- a/src/connections/sources/catalog/cloud-apps/produktly/index.md +++ b/src/connections/sources/catalog/cloud-apps/produktly/index.md @@ -57,87 +57,87 @@ The table below lists events that Produktly sends to Segment. These events appea The table below list the properties included in the events listed above. -#### tour_available +#### Tour Available | Property Name | Description | | ----------------- | ------------------------ | | `tour_id` | Id of the tour | -#### tour_start +#### Tour Start | Property Name | Description | | ----------------- | ------------------------ | | `tour_id` | Id of the tour | -#### tour_auto_start +#### Tour Auto Start | Property Name | Description | | ----------------- | ------------------------ | | `tour_id` | Id of the tour | -#### tour_continue +#### Tour Continue | Property Name | Description | | ----------------- | ------------------------ | | `tour_id` | Id of the tour | -#### tour_finish +#### Tour Finish | Property Name | Description | | ----------------- | ------------------------ | | `tour_id` | Id of the tour | -#### tour_step +#### Tour Step | Property Name | Description | | ----------------- | ------------------------ | | `tour_id` | 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 +#### Checklist Step Completed | Property Name | Description | | ----------------- | ------------------------ | | `checklist_id` | Id of the checklist | | `metadata` | Object that contains `stepId` of the checklist that was completed | -#### checklist_finished +#### Checklist Finished | Property Name | Description | | ----------------- | ------------------------ | | `checklist_id` | Id of the checklist | -#### smart_tip_available +#### Smart Tip Available | Property Name | Description | | ----------------- | ------------------------ | | `smart_tip_id` | Id of the smart tip | -#### smart_tip_open +#### Smart Tip Open | Property Name | Description | | ----------------- | ------------------------ | | `smart_tip_id` | Id of the smart tip | -#### announcement_shown +#### Announcement Shown | Property Name | Description | | ----------------- | ------------------------ | | `announcement_id` | Id of the announcement | -#### announcement_action_clicked +#### Announcement Action Clicked | Property Name | Description | | ----------------- | ------------------------ | | `announcement_id` | Id of the announcement | -#### announcement_closed +#### Announcement Closed | Property Name | Description | | ----------------- | ------------------------ | | `announcement_id` | Id of the announcement | -#### nps_widget_shown +#### Nps Widget Shown | Property Name | Description | | ----------------- | ------------------------ | From 994b430de50c8ce4e7aca61754a7664d092e5847 Mon Sep 17 00:00:00 2001 From: Olli Date: Wed, 23 Jul 2025 20:40:58 +0300 Subject: [PATCH 6/8] Apply suggestions from code review Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../sources/catalog/cloud-apps/produktly/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md index 8bc12ffbb7..d30f5d61fd 100644 --- a/src/connections/sources/catalog/cloud-apps/produktly/index.md +++ b/src/connections/sources/catalog/cloud-apps/produktly/index.md @@ -2,7 +2,7 @@ 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. +[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 can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations. @@ -18,16 +18,16 @@ This source is maintained by Produktly. For any issues with the source, [contact 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" +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 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. +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 From 96d9d85d318f73c7e01677935c813cc0aec85a69 Mon Sep 17 00:00:00 2001 From: Olli Date: Wed, 23 Jul 2025 20:44:36 +0300 Subject: [PATCH 7/8] Apply suggestions from code review (that differ from template) Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../catalog/cloud-apps/produktly/index.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md index d30f5d61fd..8c44254de5 100644 --- a/src/connections/sources/catalog/cloud-apps/produktly/index.md +++ b/src/connections/sources/catalog/cloud-apps/produktly/index.md @@ -4,20 +4,20 @@ 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. 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 can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations. +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:support@produktly.com). ## 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. +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 from the Segment UI. +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**. @@ -25,7 +25,7 @@ This source is maintained by Produktly. For any issues with the source, [contact ## 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 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. @@ -55,7 +55,7 @@ The table below lists events that Produktly sends to Segment. These events appea ## Event Properties -The table below list the properties included in the events listed above. +See the list of event properties. #### Tour Available @@ -145,10 +145,10 @@ The table below list the properties included in the events listed above. -## Adding Destinations +## Adding destinations -Now that your Source is set up, you can connect it with Destinations. +Once 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. +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:support@produktly.com). From 4a85a791583ac67d9b7e44d29bb3374896fd8505 Mon Sep 17 00:00:00 2001 From: Olli Date: Wed, 23 Jul 2025 20:45:47 +0300 Subject: [PATCH 8/8] Update event properties to single list Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../catalog/cloud-apps/produktly/index.md | 79 +------------------ 1 file changed, 2 insertions(+), 77 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/produktly/index.md b/src/connections/sources/catalog/cloud-apps/produktly/index.md index 8c44254de5..b07dae6c79 100644 --- a/src/connections/sources/catalog/cloud-apps/produktly/index.md +++ b/src/connections/sources/catalog/cloud-apps/produktly/index.md @@ -57,90 +57,15 @@ The table below lists events that Produktly sends to Segment. These events appea See the list of event properties. -#### Tour Available | Property Name | Description | | ----------------- | ------------------------ | | `tour_id` | Id of the tour | - -#### Tour Start - -| Property Name | Description | -| ----------------- | ------------------------ | -| `tour_id` | Id of the tour | - -#### Tour Auto Start - -| Property Name | Description | -| ----------------- | ------------------------ | -| `tour_id` | Id of the tour | - -#### Tour Continue - -| Property Name | Description | -| ----------------- | ------------------------ | -| `tour_id` | Id of the tour | - -#### Tour Finish - -| Property Name | Description | -| ----------------- | ------------------------ | -| `tour_id` | Id of the tour | - -#### Tour Step - -| Property Name | Description | -| ----------------- | ------------------------ | -| `tour_id` | 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 | -| ----------------- | ------------------------ | +| `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` | Object that contains `stepId` of the checklist that was completed | - -#### Checklist Finished - -| Property Name | Description | -| ----------------- | ------------------------ | -| `checklist_id` | Id of the checklist | - -#### Smart Tip Available - -| Property Name | Description | -| ----------------- | ------------------------ | +| `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 | - -#### Smart Tip Open - -| Property Name | Description | -| ----------------- | ------------------------ | -| `smart_tip_id` | Id of the smart tip | - -#### Announcement Shown - -| Property Name | Description | -| ----------------- | ------------------------ | -| `announcement_id` | Id of the announcement | - -#### Announcement Action Clicked - -| Property Name | Description | -| ----------------- | ------------------------ | | `announcement_id` | Id of the announcement | - -#### Announcement Closed - -| Property Name | Description | -| ----------------- | ------------------------ | -| `announcement_id` | Id of the announcement | - -#### Nps Widget Shown - -| Property Name | Description | -| ----------------- | ------------------------ | | `nps_widget_id` | Id of the NPS widget |