Update your warehouse allowlist for with new IP addresses
-Starting on November 14, 2023 all warehouse customers who use allowlists in their US warehouses must update those lists to include the following ranges:
+Starting on November 14, 2023, all Segment customers with workspaces hosted in the US who use allowlists in their warehouses must update those allowlists to include the following ranges:
52.25.130.38/3234.223.203.0/28
Customers with warehouses in the EU must allowlist 3.251.148.96/29.
Customers with workspaces in the EU must allowlist 3.251.148.96/29.
These updates coincide with reliability improvements to Segment's underlying warehouse architecture.
diff --git a/src/connections/destinations/actions.md b/src/connections/destinations/actions.md index 9161000ad5..bb8852d078 100644 --- a/src/connections/destinations/actions.md +++ b/src/connections/destinations/actions.md @@ -57,7 +57,8 @@ To set up a new Actions-framework destination for the first time: 4. If prompted, select the source you want to connect to the new destination. 5. Enter your credentials. This could be an API Key and secret key, or similar information that allows the destination to connect to your account. 6. Next, choose how you want to set up the destination, and click **Configure Actions**. - You can choose **Quick Setup** to use the default mappings, or choose **Customized Setup** (if available) to create new mappings and conditions from a blank state. You can always edit these mappings later. + * You can choose **Quick Setup** to use the default mappings, or choose **Customized Setup** (if available) to create new mappings and conditions from a blank state. You can always edit these mappings later. + * *(Optional)* Click **Suggest Mappings** to get suggested mappings. Learn more about [suggested mappings](#suggested-mappings). 7. Once you're satisfied with your mappings, click **Create Destination**. > info "" @@ -188,6 +189,16 @@ If necessary, click **New Mapping** to create a new, blank action. > info "" > The required fields for a destination mapping appear automatically. Click the + sign to see optional fields. +## Suggested mappings + +> info "" +> Suggested mappings is fully available for RETL mappings, and is in public beta for event streams and connections. + +Segment offers suggested mappings that automatically propose relevant destination fields for both model columns and payload elements. For example, if your model includes a column or payload field named `transaction_amount`, the feature might suggest mapping it to a destination field like `Amount` or `TransactionValue`. This automation, powered by intelligent autocompletion, matches and identifies near-matching field names to streamline the setup. For more information, see [Segment's suggested mappings blogpost](https://segment.com/blog/ai-assisted-magical-mappings/){:target="_blank”} and the [Suggested Mappings Nutrition Label](/docs/connections/reverse-etl/suggested-mappings-nutrition-facts). + +> warning "" +> Review the suggested mappings for accuracy before finalizing them as the suggestions aren't guaranteed to be 100% accurate. + ### Coalesce function The coalesce function takes a primary value and uses it if it is available. If the value isn't available, the function uses the fallback value instead. 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..34711cb243 --- /dev/null +++ b/src/connections/destinations/catalog/actions-contentstack/index.md @@ -0,0 +1,43 @@ +--- +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. 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. + +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 + +- a 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. Ensure your event payloads align with the mapping configuration you created for the Contentstack destination in Segment. + +## Receive personalized content + +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/actions-mixpanel/index.md b/src/connections/destinations/catalog/actions-mixpanel/index.md index 790c7073ca..92f5a3401d 100644 --- a/src/connections/destinations/catalog/actions-mixpanel/index.md +++ b/src/connections/destinations/catalog/actions-mixpanel/index.md @@ -141,6 +141,11 @@ analytics.track('Example Event', { custom_group_key : 'group1' }); If your integration is correct and you are still seeing failed events, review and verify that you are sending all date properties as UTC time format, due to Mixpanel timestamp format requirements. +### Failed events due to messageId +Segment maps the `messageId` of a Segment event to Mixpanel's `insert_id` value. If you are generating your own `messageId`, ensure the format complies with Mixpanel's `insert_id` requirements. For more information, see Mixpanel's [Import Events](https://developer.mixpanel.com/reference/import-events#propertiesinsert_id){:target="_blank”} documentation. + +Failing to generate a `messageId` that complies with Mixpanel's `insert_id` standard might result in a `400 Bad Request` error from Mixpanel. + ### Why is Boardman, Oregon appearing in my users' profile location field? If you are seeing traffic from Boardman or see Segment as the browser, you might be sending server side calls to your Mixpanel (Actions) destination. To correctly populate your users' profile location field, manually pass the IP information in the context object from the server. 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..039226a53c --- /dev/null +++ b/src/connections/destinations/catalog/contentstack-web/index.md @@ -0,0 +1,43 @@ +--- +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. 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 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 + +- a 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. Ensure your event payloads align with the mapping configuration you created for the Contentstack destination in Segment. + +## Receive personalized content + +Based on your events/payloads, your Contentstack Personalize project should now start receiving events for understanding 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”}. diff --git a/src/connections/reverse-etl/setup.md b/src/connections/reverse-etl/setup.md index 2039d73116..4272485914 100644 --- a/src/connections/reverse-etl/setup.md +++ b/src/connections/reverse-etl/setup.md @@ -88,7 +88,7 @@ To create a mapping: * Deleted records 7. In the **Map fields** section, define how to map the record columns from your model to your destination. Map the fields that come from your source to fields that the destination expects to find. Fields on the destination side depend on the type of Action selected. * If you’re setting up a Destination Action, some mapping fields might require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays) for more information. - + * _(Optional)_ Use the [Suggested Mappings](#suggested-mappings) feature to identify and match near-matching field names to streamline the field mapping process. 8. In the **Send test record section**, select a test record to preview the fields that you mapped to your destination. When you've verified that the records appear as expected, click **Next**. 9. Enter a name for your mapping. The name initially defaults to the Action's name, for example, `Track Event`, but you can make changes to this default name. 10. Select how often you want Segment to sync your data under **Schedule configuration**. @@ -196,6 +196,16 @@ To edit your model: 4. Click the **Settings** tab to edit the model name or change the schedule settings. +### Suggested mappings + +> info "" +> Suggested mappings is fully available for RETL mappings. + +Segment offers suggested mappings that automatically propose relevant destination fields for model columns and payload elements. For example, if your model includes a column or payload field named `transaction_amount`, the feature might suggest mapping it to a destination field like `Amount` or `TransactionValue`. This automation, powered by intelligent autocompletion, matches and identifies near-matching field names to streamline the mappings setup process. For more information, see [Segment's suggested mappings blog post](https://segment.com/blog/ai-assisted-magical-mappings/){:target="_blank”} and the [Suggested Mappings Nutrition Facts Label](/docs/connections/reverse-etl/suggested-mappings-nutrition-facts). + +> warning "" +> Review the suggested mappings for accuracy before finalizing them, as Segment can't guarantee all of the suggested mappings are accurate. + ### Edit your mapping To edit your mapping: diff --git a/src/connections/reverse-etl/suggested-mappings-nutrition-facts.md b/src/connections/reverse-etl/suggested-mappings-nutrition-facts.md new file mode 100644 index 0000000000..ec044c45fa --- /dev/null +++ b/src/connections/reverse-etl/suggested-mappings-nutrition-facts.md @@ -0,0 +1,7 @@ +--- +title: Suggested Mappings Nutrition Facts Label +--- + +Twilio’s [AI Nutrition Facts](https://nutrition-facts.ai/){:target="_blank"} provide an overview of the AI feature you’re using, so you can better understand how the AI is working with your data. Suggested Mappings's AI qualities are outlined in the following Nutrition Facts label. For more information, including the glossary regarding the AI Nutrition Facts label, refer to the [AI Nutrition Facts](https://nutrition-facts.ai/){:target="_blank"} page. + +{% include content/suggested-mappings-nutrition-facts.html %} \ No newline at end of file diff --git a/src/unify/salesforce-unify.md b/src/connections/sources/catalog/cloud-apps/salesforce-unify/index.md similarity index 99% rename from src/unify/salesforce-unify.md rename to src/connections/sources/catalog/cloud-apps/salesforce-unify/index.md index 69563409bd..26a38a9f4e 100644 --- a/src/unify/salesforce-unify.md +++ b/src/connections/sources/catalog/cloud-apps/salesforce-unify/index.md @@ -1,6 +1,8 @@ --- title: Salesforce Unify Direct Integration Guide plan: unify +redirect_from: + - '/unify/salesforce-unify' --- This guide outlines the process for setting up Salesforce as a data source with Segment Profiles. diff --git a/src/engage/audiences/product-based-audiences-nutrition-label.md b/src/engage/audiences/product-based-audiences-nutrition-label.md new file mode 100644 index 0000000000..ce3361179c --- /dev/null +++ b/src/engage/audiences/product-based-audiences-nutrition-label.md @@ -0,0 +1,9 @@ +--- +title: Product Based Audiences Nutrition Facts Label +plan: engage-foundations +redirect_from: + - '/engage/audiences/recommendation-audiences-nutrition-label' +--- + +Twilio’s [AI Nutrition Facts](https://nutrition-facts.ai/){:target="_blank"} provide an overview of the AI feature you’re using, so you can better understand how the AI is working with your data. Twilio outlines AI qualities in Product Based Audiences in the Nutrition Facts label below. For more information, including the AI Nutrition Facts label glossary, refer to the [AI Nutrition Facts](https://nutrition-facts.ai/){:target="_blank"} page. +{% include content/product-based-audiences-nutrition-facts.html %} \ No newline at end of file diff --git a/src/engage/audiences/recommendation-audiences.md b/src/engage/audiences/product-based-audiences.md similarity index 83% rename from src/engage/audiences/recommendation-audiences.md rename to src/engage/audiences/product-based-audiences.md index 6826807c0a..cdf23d7419 100644 --- a/src/engage/audiences/recommendation-audiences.md +++ b/src/engage/audiences/product-based-audiences.md @@ -1,10 +1,12 @@ --- -title: Recommendation Audiences +title: Product Based Audiences plan: engage-foundations +redirect_from: + - '/engage/audiences/recommendation-audiences' --- -Recommendation Audiences lets you select a parameter and then build an audience of the people that are most likely to engage with it. Segment optimized the personalized recommendations built by Recommendation Audiences for user-based commerce, media, and content affinity use cases. +Product Based Audiences lets you select a product, article, song, or other piece of content from your catalog, and then build an audience of the people that are most likely to engage with it. Segment optimized the personalized recommendations built by Product Based Audiences for user-based commerce, media, and content affinity use cases. -You can use Recommendation Audiences to power the following common marketing campaigns: +You can use Product Based Audiences to power the following common marketing campaigns: - **Cross-selling**: Identify an audience of users who recently purchased a laptop and send those customers an email with a discount on items in the "laptop accessories" category. - **Upselling**: Identify an audience of users who regularly interact with your free service and send them a promotion for your premium service. @@ -13,10 +15,10 @@ You can use Recommendation Audiences to power the following common marketing cam - **Next best action**: Identify an audience of users who frequently read articles in your website's "Sports" category and recommend those users your latest sports article. - **Increasing average order value (AOV)**: Identify an audience of users who frequently interact with the "For Kids" section of your website and send them a back to school promotion in August, with free shipping after a set price threshold. -## Create a Recommendation Audience +## Create a Product Based Audience ### Set up your Recommendation Catalog -A Recommendation Catalog identifies the product events you'd like to generate recommendations from and maps those events against your existing data set. +Segment utilizes your interaction events (order_completed, product_added, product_searched, song_played, article_saved) and the event metadata of those interaction events to power our CustomerAI Recommendations workflow. To create your Recommendation Catalog: 1. Open your Engage space and navigate to **Engage** > **Engage Settings** > **Recommendation catalog**. @@ -30,10 +32,10 @@ To create your Recommendation Catalog: > warning "" > Segment can take several hours to create your Recommendation Catalog. -### Create your Recommendation Audience +### Create your Product Based Audience Once you've created your Recommendation Catalog, you can build a Recommendation Audience. A Recommendation Audience lets you select a parameter and then build an audience of the people that are most likely to engage with that parameter. -To create a Recommendation Audience: +To create a Product Based Audience: 1. Open your Engage space and click **+ New audience**. 2. Select **Recommendation Audience** and click **Next**. 3. Select a property and value that you'd like to build your audience around (for example, if the property was "Company", you could select a value of "Twilio"). For values that haven't updated yet, enter an exact value into the **Enter value** field. If you're missing a property, return to your [Recommendation catalog](#set-up-your-recommendation-catalog) and update your mapping to include the property. @@ -43,10 +45,10 @@ To create a Recommendation Audience: 7. Enter a name for your destination, update any optional fields, and click **Create Audience** to create your audience. > warning "" -> Segment can take up to a day to calculate your Recommendation Audience. +> Segment can take up to a day to calculate your Product Based Audience. ## Best practices - When mapping events to the model column during the setup process for your [Recommendation catalog](#set-up-your-recommendation-catalog), select the event property that matches the model column. For example, if you are mapping to model column ‘Brand’, select the property that refers to ‘Brand’ for each of the selected interaction events. - Because a number of factors (like system load, backfills, or user bases) determine the complexity of an Audience, some compute times take longer than others. As a result, **Segment recommends waiting at least 24 hours for an Audience to finish computing** before you resume working with the Audience. -- As the size of your audience increases, the propensity to purchase typically decreases. For example, an audience of a hundred thousand people that represents the top 5% of your customers might be more likely to purchase your product, but you might see a greater number of total sales if you expanded the audience to a million people that represent the top 50% of your customer base. \ No newline at end of file +- As the size of your audience increases, the propensity to purchase typically decreases. For example, an audience of a hundred thousand people that represents the top 5% of your customers might be more likely to purchase your product, but you might see a greater number of total sales if you expanded the audience to a million people that represent the top 50% of your customer base. diff --git a/src/engage/audiences/recommendation-audiences-nutrition-label.md b/src/engage/audiences/recommendation-audiences-nutrition-label.md deleted file mode 100644 index efc66f8adc..0000000000 --- a/src/engage/audiences/recommendation-audiences-nutrition-label.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Recommendation Audiences Nutrition Facts Label -plan: engage-foundations ---- - -Twilio’s [AI Nutrition Facts](https://nutrition-facts.ai/){:target="_blank"} provide an overview of the AI feature you’re using, so you can better understand how the AI is working with your data. Twilio outlines AI qualities in Recommendation Audiences in the Nutrition Facts label below. For more information, including the AI Nutrition Facts label glossary, refer to the [AI Nutrition Facts](https://nutrition-facts.ai/){:target="_blank"} page. -{% include content/recommendation-audiences-nutrition-facts.html %} \ No newline at end of file diff --git a/src/engage/product-limits.md b/src/engage/product-limits.md index 68005d0246..e7736f960b 100644 --- a/src/engage/product-limits.md +++ b/src/engage/product-limits.md @@ -49,17 +49,13 @@ To learn more about custom limits and upgrades, contact your dedicated Customer ## Journeys -> info "" -> These limits only apply to existing users who started with Engage prior to August 18, 2023. Visit Segment's updated Unify and Engage [limits](/docs/unify/product-limits/) to learn more. - - -| Item | Limit description | Details | -| --------------- | -------------------------------- | ---------------------------------------------------------------------------- | -| Steps | 500 | The maximum number of steps per Journey. | -| Step Name | Maximum length of 170 characters | Once the limit is reached, you cannot add additional characters to the name. | -| Key | Maximum length of 255 characters | Once the limit is reached, you cannot add additional characters to the key. | -| Journey Name | Maximum length of 73 characters | Once the limit is reached, you cannot add additional characters to the name. | -| Compute credits | Half a credit for each step (up to 250 compute credits) | Each step in a published Journey consumes half of one compute credit. | +| Item | Limit description | Details | +| --------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------- | +| Steps | 100 | The maximum number of steps per Journey. | +| Step Name | Maximum length of 170 characters | Once the limit is reached, you cannot add additional characters to the name. | +| Key | Maximum length of 255 characters | Once the limit is reached, you cannot add additional characters to the key. | +| Journey Name | Maximum length of 73 characters | Once the limit is reached, you cannot add additional characters to the name. | +| Compute credits | Half a credit for each step (up to 250 compute credits) | Each step in a published Journey consumes half of one compute credit. | diff --git a/src/unify/data-graph/setup-guides/snowflake-setup.md b/src/unify/data-graph/setup-guides/snowflake-setup.md index faadc78e8a..4a69eda7b6 100644 --- a/src/unify/data-graph/setup-guides/snowflake-setup.md +++ b/src/unify/data-graph/setup-guides/snowflake-setup.md @@ -23,7 +23,7 @@ Segment recommends setting up a new Snowflake user and only giving this user per > info "" > Segment recommends creating a new database for the Data Graph. -> If you choose to use an existing database that has also been used for [Segment Reverse ETL](/docs/connections/reverse-etl/), you must follow the [additional instructions](#update-user-access-for-segment-reverse-etl-schema)to update user access for the Segment Reverse ETL schema. +> If you choose to use an existing database that has also been used for [Segment Reverse ETL](/docs/connections/reverse-etl/), you must follow the [additional instructions](#update-user-access-for-segment-reverse-etl-schema) to update user access for the Segment Reverse ETL schema. ```sql @@ -160,7 +160,7 @@ To connect your warehouse to the Data Graph: 5. Test your connection, then click Save. -## Update user acccess for Segment Reverse ETL schema +## Update user access for Segment Reverse ETL schema If Segment Reverse ETL has ever run in the database you are configuring as the Segment connection database, a Segment-managed schema is already created and you need to provide the new Segment user access to the existing schema. Run the following SQL if you run into an error on the Segment app indicating that the user doesn't have sufficient privileges on an existing `_segment_reverse_etl` schema. ```sql @@ -170,4 +170,4 @@ SET retl_schema = concat($segment_connection_db,'.__segment_reverse_etl'); GRANT USAGE ON SCHEMA identifier($retl_schema) TO ROLE identifier($segment_connection_role); GRANT CREATE TABLE ON SCHEMA identifier($retl_schema) TO ROLE identifier($segment_connection_role); GRANT SELECT,INSERT,UPDATE,DELETE ON ALL TABLES IN SCHEMA identifier($retl_schema) TO ROLE identifier($segment_connection_role); -``` \ No newline at end of file +``` diff --git a/styleguide.md b/styleguide.md index 5530f05ebb..2f4774942e 100644 --- a/styleguide.md +++ b/styleguide.md @@ -49,6 +49,7 @@ Sub-bullets/sub-lists | If there are mutliple tasks within a step, break it up i FAQs | Use H4s for FAQs. Don't use the liquid formatting.When naming the FAQ section, use `FAQ` instead of `Frequently Asked Questions`. External links | When inserting links that aren't on the segment.com/docs subdomain, follow this format: `[link text](https://google.com){:target="_blank"}`
Make sure the `{:target="_blank"}` is included after the link. This ensures that the link to the external site opens up in a new tab to avoid taking users away from the docs site. Code blocks | When giving a code example that is more than a line long, use a code block. (For keyboard shortcuts, variables, and commands, use the single-backtick `code format`). Always use triple-backtick code fences to create a code block. Do not use the three-indent (three tabs/six spaces) mode, as this can conflict with nested list rendering. +HTTP response codes | When including an HTTP error code, write the entire code (for example, 400 Bad Request) and format the error code using single-backtick `code format`. ## Segment Specific Terms