From e4fc531003cecbd1dbf14643452acd693ba3e92c Mon Sep 17 00:00:00 2001 From: Thomas Gilbert Date: Thu, 19 Sep 2024 11:20:13 -0400 Subject: [PATCH 1/3] add docs for new contentstack destinations --- .../catalog/actions-contentstack/index.md | 44 +++++++++++++++++++ .../catalog/contentstack-web/index.md | 44 +++++++++++++++++++ 2 files changed, 88 insertions(+) create mode 100644 src/connections/destinations/catalog/actions-contentstack/index.md create mode 100644 src/connections/destinations/catalog/contentstack-web/index.md diff --git a/src/connections/destinations/catalog/actions-contentstack/index.md b/src/connections/destinations/catalog/actions-contentstack/index.md new file mode 100644 index 0000000000..3396e360c8 --- /dev/null +++ b/src/connections/destinations/catalog/actions-contentstack/index.md @@ -0,0 +1,44 @@ +--- +title: Contentstack Cloud Destination +id: 664ce7bdc820c71f7e3ff031 +--- + +> info "This destination sends data in cloud-mode" +> This destination transmits data from Segment to Contentstack server-side. Contentstack supports both device-mode and cloud-mode destinations. Learn more about the device-mode web destiantion [here](docs/connections/destinations/catalog/contentstack-web). + +[Contentstack](https://www.contentstack.com/?utm_source=segment&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a headless CMS that allows you to build digital experiences using a modular approach. This integration allows you to sync data from Segment to your Contentstack Personalize project, enabling dynamic and personalized content delivery. + +This destination is maintained by Contentstack. For any issues with the destination, [contact their Support team](https://www.contentstack.com/customers/support){:target="_blank”}. + +## Prerequisites + +- Contentstack account with Personalize enabled +- A Contentstack Personalize project created in your Contentstack organization. + +## Before you begin + +- **Contentstack Personalize Project**: Create a Contentstack Personalize project within your organization and link your Contentstack stack to enable variant functionality. +- **Attributes & Audiences**: Define attributes and create audiences based on those attributes within your Contentstack Personalize project. +- **Events**: Define and create the events that you want to track and sync with your Contentstack Personalize project. + +## Getting started + +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Contentstack". +2. Select Contentstack and click **Add Destination**. +3. Select an existing Source to connect to Contentstack. +4. Go to the Contentstack account and find the following parameters to input as settings in the Segment destiantion settings: + - **Personalize Project ID**: Enter the unique ID of your Contentstack Personalize project. + - **Personalize Edge API Base URL**: Enter the base URL of your Contentstack Personalize API. You can find this URL in the Contentstack documentation. + +{% include components/actions-fields.html %} + +## Send Events to Segment + +Start sending the payload of events to Segment using track or identify calls. This will not only send events to Segment but will forward the selected values to Contentstack Personalization. +- Note: Ensure your event payloads align with the mapping configuration you created for the Contentstack destination in Segment. + +## Receive Personalized Content + +As per your events/payloads, your Contentstack Personalize project should now start receiving events for understanding the users associated with your mapped values. + +- Note: Ensure the event names and properties you use match those defined in your Contentstack Personalize project. For advanced customization, you can explore the Contentstack Personalize Documentation to further enhance your personalized experiences diff --git a/src/connections/destinations/catalog/contentstack-web/index.md b/src/connections/destinations/catalog/contentstack-web/index.md new file mode 100644 index 0000000000..dce13a3f83 --- /dev/null +++ b/src/connections/destinations/catalog/contentstack-web/index.md @@ -0,0 +1,44 @@ +--- +title: Contentstack Web Destination +id: 66ccaa142d6b2d223bb1ebda +--- + +> info "This destination sends data in device-mode" +> This destination transmits data from the browser directly to Contentstack on the client-side. Contentstack supports both device-mode and cloud-mode destinations. Learn more about the Cloud-mode destiantion [here](docs/connections/destinations/catalog/actions-contentstack). + +[Contentstack](https://www.contentstack.com/?utm_source=segment&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a headless CMS that allows you to build digital experiences using a modular approach. This integration allows you to sync data from Segment to your Contentstack Personalize project, enabling dynamic and personalized content delivery. + +This destination is maintained by Contentstack. For any issues with the destination, [contact their Support team](https://www.contentstack.com/customers/support){:target="_blank”}. + +## Prerequisites + +- Contentstack account with Personalize enabled +- A Contentstack Personalize project created in your Contentstack organization. + +## Before you begin + +- **Contentstack Personalize Project**: Create a Contentstack Personalize project within your organization and link your Contentstack stack to enable variant functionality. +- **Attributes & Audiences**: Define attributes and create audiences based on those attributes within your Contentstack Personalize project. +- **Events**: Define and create the events that you want to track and sync with your Contentstack Personalize project. + +## Getting started + +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Contentstack Web". +2. Select Contentstack Web and click **Add Destination**. +3. Select an existing Source to connect to Contentstack Web. +4. Go to the Contentstack account and find the following parameters to input as settings in the Segment destiantion settings: + - **Personalize Project ID**: Enter the unique ID of your Contentstack Personalize project. + - **Personalize Edge API Base URL**: Enter the base URL of your Contentstack Personalize API. You can find this URL in the Contentstack documentation. + +{% include components/actions-fields.html %} + +## Send Events to Segment + +Start sending the payload of events to Segment using track or identify calls. This will not only send events to Segment but will forward the selected values to Contentstack Personalization. +- Note: Ensure your event payloads align with the mapping configuration you created for the Contentstack destination in Segment. + +## Receive Personalized Content + +As per your events/payloads, your Contentstack Personalize project should now start receiving events for understanding the users associated with your mapped values. + +- Note: Ensure the event names and properties you use match those defined in your Contentstack Personalize project. For advanced customization, you can explore the Contentstack Personalize Documentation to further enhance your personalized experiences From 53f4fb44ab19bb8db5a232266eb914316c8dea41 Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 19 Sep 2024 13:02:32 -0500 Subject: [PATCH 2/3] minor cleanup --- .../catalog/actions-contentstack/index.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/src/connections/destinations/catalog/actions-contentstack/index.md b/src/connections/destinations/catalog/actions-contentstack/index.md index 3396e360c8..44531cc0b0 100644 --- a/src/connections/destinations/catalog/actions-contentstack/index.md +++ b/src/connections/destinations/catalog/actions-contentstack/index.md @@ -4,16 +4,16 @@ id: 664ce7bdc820c71f7e3ff031 --- > info "This destination sends data in cloud-mode" -> This destination transmits data from Segment to Contentstack server-side. Contentstack supports both device-mode and cloud-mode destinations. Learn more about the device-mode web destiantion [here](docs/connections/destinations/catalog/contentstack-web). +> This destination transmits data from Segment to Contentstack server-side. Contentstack supports both device-mode and cloud-mode destinations. For more more about the device-mode web destination, see [Contentstack Web](docs/connections/destinations/catalog/contentstack-web). -[Contentstack](https://www.contentstack.com/?utm_source=segment&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a headless CMS that allows you to build digital experiences using a modular approach. This integration allows you to sync data from Segment to your Contentstack Personalize project, enabling dynamic and personalized content delivery. +[Contentstack](https://www.contentstack.com/?utm_source=segment&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a headless CMS that allows you to build digital experiences using a modular approach. This integration lets you sync data from Segment to your Contentstack Personalize project, enabling dynamic and personalized content delivery. This destination is maintained by Contentstack. For any issues with the destination, [contact their Support team](https://www.contentstack.com/customers/support){:target="_blank”}. ## Prerequisites -- Contentstack account with Personalize enabled -- A Contentstack Personalize project created in your Contentstack organization. +- a Contentstack account with Personalize enabled +- a Contentstack Personalize project created in your Contentstack organization ## Before you begin @@ -32,13 +32,12 @@ This destination is maintained by Contentstack. For any issues with the destinat {% include components/actions-fields.html %} -## Send Events to Segment +## Send events to Segment -Start sending the payload of events to Segment using track or identify calls. This will not only send events to Segment but will forward the selected values to Contentstack Personalization. -- Note: Ensure your event payloads align with the mapping configuration you created for the Contentstack destination in Segment. +Start sending the payload of events to Segment using Track or Identify calls. This will not only send events to Segment but will forward the selected values to Contentstack Personalization. Ensure your event payloads align with the mapping configuration you created for the Contentstack destination in Segment. -## Receive Personalized Content +## Receive personalized content -As per your events/payloads, your Contentstack Personalize project should now start receiving events for understanding the users associated with your mapped values. +As per your events/payloads, your Contentstack Personalize project should now start receiving events to help you understand the users associated with your mapped values. -- Note: Ensure the event names and properties you use match those defined in your Contentstack Personalize project. For advanced customization, you can explore the Contentstack Personalize Documentation to further enhance your personalized experiences +The event names and properties you use must match those defined in your Contentstack Personalize project. For advanced customization and to further enhance your personalized experience, explore Contentstack Personalize in [Contentstack's Documentation](https://www.contentstack.com/docs){:target="_blank”}. \ No newline at end of file From b613262eb28d1b3a4bd124cdf959a4bdfdd730f7 Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 19 Sep 2024 13:08:21 -0500 Subject: [PATCH 3/3] link fixes and some more cleanup --- .../catalog/actions-contentstack/index.md | 4 ++-- .../catalog/contentstack-web/index.md | 19 +++++++++---------- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/src/connections/destinations/catalog/actions-contentstack/index.md b/src/connections/destinations/catalog/actions-contentstack/index.md index 44531cc0b0..34711cb243 100644 --- a/src/connections/destinations/catalog/actions-contentstack/index.md +++ b/src/connections/destinations/catalog/actions-contentstack/index.md @@ -4,7 +4,7 @@ id: 664ce7bdc820c71f7e3ff031 --- > info "This destination sends data in cloud-mode" -> This destination transmits data from Segment to Contentstack server-side. Contentstack supports both device-mode and cloud-mode destinations. For more more about the device-mode web destination, see [Contentstack Web](docs/connections/destinations/catalog/contentstack-web). +> This destination transmits data from Segment to Contentstack server-side. Contentstack supports both device-mode and cloud-mode destinations. For more more about the device-mode web destination, see [Contentstack Web](/docs/connections/destinations/catalog/contentstack-web). [Contentstack](https://www.contentstack.com/?utm_source=segment&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a headless CMS that allows you to build digital experiences using a modular approach. This integration lets you sync data from Segment to your Contentstack Personalize project, enabling dynamic and personalized content delivery. @@ -38,6 +38,6 @@ Start sending the payload of events to Segment using Track or Identify calls. Th ## Receive personalized content -As per your events/payloads, your Contentstack Personalize project should now start receiving events to help you understand the users associated with your mapped values. +Based on your events/payloads, your Contentstack Personalize project should now start receiving events to help you understand the users associated with your mapped values. The event names and properties you use must match those defined in your Contentstack Personalize project. For advanced customization and to further enhance your personalized experience, explore Contentstack Personalize in [Contentstack's Documentation](https://www.contentstack.com/docs){:target="_blank”}. \ No newline at end of file diff --git a/src/connections/destinations/catalog/contentstack-web/index.md b/src/connections/destinations/catalog/contentstack-web/index.md index dce13a3f83..039226a53c 100644 --- a/src/connections/destinations/catalog/contentstack-web/index.md +++ b/src/connections/destinations/catalog/contentstack-web/index.md @@ -4,16 +4,16 @@ id: 66ccaa142d6b2d223bb1ebda --- > info "This destination sends data in device-mode" -> This destination transmits data from the browser directly to Contentstack on the client-side. Contentstack supports both device-mode and cloud-mode destinations. Learn more about the Cloud-mode destiantion [here](docs/connections/destinations/catalog/actions-contentstack). +> This destination transmits data from the browser directly to Contentstack on the client-side. Contentstack supports both device-mode and cloud-mode destinations. For more about the Cloud-mode destination, see [Contentstack Cloud Destination](/docs/connections/destinations/catalog/actions-contentstack). -[Contentstack](https://www.contentstack.com/?utm_source=segment&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a headless CMS that allows you to build digital experiences using a modular approach. This integration allows you to sync data from Segment to your Contentstack Personalize project, enabling dynamic and personalized content delivery. +[Contentstack](https://www.contentstack.com/?utm_source=segment&utm_medium=docs&utm_campaign=partners){:target="_blank”} is a headless CMS that allows you to build digital experiences using a modular approach. This integration lets you sync data from Segment to your Contentstack Personalize project, enabling dynamic and personalized content delivery. This destination is maintained by Contentstack. For any issues with the destination, [contact their Support team](https://www.contentstack.com/customers/support){:target="_blank”}. ## Prerequisites -- Contentstack account with Personalize enabled -- A Contentstack Personalize project created in your Contentstack organization. +- a Contentstack account with Personalize enabled +- a Contentstack Personalize project created in your Contentstack organization ## Before you begin @@ -32,13 +32,12 @@ This destination is maintained by Contentstack. For any issues with the destinat {% include components/actions-fields.html %} -## Send Events to Segment +## Send events to Segment -Start sending the payload of events to Segment using track or identify calls. This will not only send events to Segment but will forward the selected values to Contentstack Personalization. -- Note: Ensure your event payloads align with the mapping configuration you created for the Contentstack destination in Segment. +Start sending the payload of events to Segment using track or identify calls. This will not only send events to Segment but will forward the selected values to Contentstack Personalization. Ensure your event payloads align with the mapping configuration you created for the Contentstack destination in Segment. -## Receive Personalized Content +## Receive personalized content -As per your events/payloads, your Contentstack Personalize project should now start receiving events for understanding the users associated with your mapped values. +Based on your events/payloads, your Contentstack Personalize project should now start receiving events for understanding the users associated with your mapped values. -- Note: Ensure the event names and properties you use match those defined in your Contentstack Personalize project. For advanced customization, you can explore the Contentstack Personalize Documentation to further enhance your personalized experiences +The event names and properties you use must match those defined in your Contentstack Personalize project. For advanced customization and to further enhance your personalized experience, explore Contentstack Personalize in [Contentstack's Documentation](https://www.contentstack.com/docs){:target="_blank”}.