From c022e0c0811a116b91150de0308e5982d5cd1be7 Mon Sep 17 00:00:00 2001 From: Carolina Lopez Date: Fri, 24 Oct 2025 11:58:28 -0500 Subject: [PATCH 1/6] Not h1 titles --- src/connections/destinations/catalog/actions-absmartly/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-absmartly/index.md b/src/connections/destinations/catalog/actions-absmartly/index.md index 13980624e4..5b838d339a 100644 --- a/src/connections/destinations/catalog/actions-absmartly/index.md +++ b/src/connections/destinations/catalog/actions-absmartly/index.md @@ -29,7 +29,7 @@ This destination is maintained by ABsmartly. For any issues with the destination > info "" > If you need support setting things up, you can contact the ABsmartly support team on Slack or [via email](mailto:support@absmartly.com). -# Sending exposures to Segment +## Sending exposures to Segment It can be useful to send experiment exposures to Segment for visibility from other destinations. The Segment Spec includes the [Experiment Viewed semantic event](/docs/connections/spec/ab-testing/) From 5179533da8b5f5b594a8365ca9c9844bec286030 Mon Sep 17 00:00:00 2001 From: Carolina Lopez Date: Fri, 24 Oct 2025 14:16:34 -0500 Subject: [PATCH 2/6] remove end-comment, no init comment in all file --- src/engage/journeys/v2/use-cases.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/engage/journeys/v2/use-cases.md b/src/engage/journeys/v2/use-cases.md index 1d5720610d..c5121bd3f7 100644 --- a/src/engage/journeys/v2/use-cases.md +++ b/src/engage/journeys/v2/use-cases.md @@ -632,7 +632,3 @@ These examples show key moments in the journey, from entry to conversion milesto ``` {% endcodeexampletab %} {% endcodeexample %} - - - ---> \ No newline at end of file From bad9ad5bd537554671cd053f1a64b2af397afa56 Mon Sep 17 00:00:00 2001 From: Paulo Borges Date: Mon, 27 Oct 2025 10:36:02 -0300 Subject: [PATCH 3/6] fixes for batch 5.3 (#8096) * fixes for batch 5.3 * remove liquid syntax and keep the note generic * fix numbering --- src/_includes/content/sync-frequency-note.md | 2 +- .../index.md | 37 +++++---------- .../actions-google-analytics-4-web/index.md | 6 +-- .../catalog/actions-hubspot-cloud/index.md | 4 +- .../catalog/actions-kafka/index.md | 47 +++++-------------- 5 files changed, 28 insertions(+), 68 deletions(-) diff --git a/src/_includes/content/sync-frequency-note.md b/src/_includes/content/sync-frequency-note.md index efb0e050c1..6b5d38ba24 100644 --- a/src/_includes/content/sync-frequency-note.md +++ b/src/_includes/content/sync-frequency-note.md @@ -2,6 +2,6 @@

Real-time to batch destination sync frequency

-

Real-time audience syncs to {{page.title| replace: "Destination", " "}} may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.

+

Real-time audience syncs may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.

diff --git a/src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md b/src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md index 204e20c776..99b1872934 100644 --- a/src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md +++ b/src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md @@ -43,36 +43,21 @@ This destination sends audiences, or lists of users, to Facebook Custom Audience After you've connected your Facebook Custom Audiences destination to Segment, set up a mapping that adds users to a new or existing Custom Audience. +> warning "Added or updated records is the only supported additive sync mode" +> Selecting any other sync mode might lead to sync failures with the Facebook Custom Audiences (Actions) destination. + 1. Navigate to **Connections > Sources** and select your Reverse ETL source. 2. On the Models page, select the model you'd like to use and click **Add Mapping**. 3. Select the Facebook Custom Audience (Actions) destination and the Sync Audience action, then click **Create Mapping**. 4. Enter a descriptive name for your mapping. Segment recommends a name that includes both the audience name and sync mode, for example, `Loyalty Users (Add)`. 5. Under **Select record to map and send**, select **Added or updated records**. The Added or updated records sync mode both adds new records and attempts to re-add any updated records to the custom audience. Adding updated records to your destination enables better match rates as more user identifiers are added to the source model over time. - -> warning "Added or updated records is the only supported additive sync mode" -> Selecting any other sync mode might lead to sync failures with the Facebook Custom Audiences (Actions) destination. - -
    -
  1. - Set how often your model syncs by setting the [Sync schedule](/docs/connections/reverse-etl/#step-4-create-mappings). -
    2. -
  2. - Select or create an audience in Facebook to sync your data with. Click the **Select or create audience in Facebook** button to save the audience ID to your mapping. -
    3. -
  3. - Map your model columns to the appropriate Facebook Custom Audience parameters. For more context about data formatting, see the [Sync Audience](#sync-audience) and [Data processing](#data-processing) documentation. -
      -
    • Map External ID to a unique user identifier from your system (like User ID, CRM ID, or anonymous ID.) Segment recommends using the External ID column as your primary key when setting up your Reverse ETL model so you can more easily remove users from your custom audience. External ID is the only field Facebook requires.
      • -
    • Segment recommends mapping as many parameters as you have available in your source model so that you can increase your match rates.
      • -
    -
    4. -
  4. - Send a test record. If successful, you should see a 200 response in Segment and one added record to your custom audience. To verify that the record was successfully added to your custom audience, open Facebook Ads Manager and navigate to **Audiences > {Audience Name} > History**. -
    5. -
  5. - Click **Save Mapping** and enable the mapping. -
    6. -
+6. Set how often your model syncs by setting the [Sync schedule](/docs/connections/reverse-etl/#step-4-create-mappings). +7. Select or create an audience in Facebook to sync your data with. Click the **Select or create audience in Facebook** button to save the audience ID to your mapping. +8. Map your model columns to the appropriate Facebook Custom Audience parameters. For more context about data formatting, see the [Sync Audience](#sync-audience) and [Data processing](#data-processing) documentation. + - Map External ID to a unique user identifier from your system (like User ID, CRM ID, or anonymous ID.) Segment recommends using the External ID column as your primary key when setting up your Reverse ETL model so you can more easily remove users from your custom audience. External ID is the only field Facebook requires. + - Segment recommends mapping as many parameters as you have available in your source model so that you can increase your match rates. +9. Send a test record. If successful, you should see a 200 response in Segment and one added record to your custom audience. To verify that the record was successfully added to your custom audience, open Facebook Ads Manager and navigate to **Audiences > \{Audience Name\} > History**. +10. Click **Save Mapping** and enable the mapping. ### Remove users from a Custom Audience @@ -84,7 +69,7 @@ After you've connected your Facebook Custom Audiences destination to Segment, se 6. Set how often your model syncs by setting the [Sync schedule](/docs/connections/reverse-etl/#step-4-create-mappings). 7. Select or create an audience in Facebook to sync your data with. Click the **Select or create audience in Facebook** button to save the audience ID to your mapping. 8. Map your model columns to the appropriate Facebook Custom Audience parameters. Only the External ID is required. When a record is deleted from your source model, only the model primary key is sent to the mapping; other columns from your source model are not sent. Segment recommends using the External ID as your primary key in your source model. -9. Send a test record. If successful, you should see a `200` response in Segment and one record removed from your custom audience. To verify that the record was successfully removed from your custom audience, open Facebook Ads Manager and navigate to **Audiences > {Audience Name} > History**. +9. Send a test record. If successful, you should see a `200` response in Segment and one record removed from your custom audience. To verify that the record was successfully removed from your custom audience, open Facebook Ads Manager and navigate to **Audiences > \{Audience Name\} > History**. 10. Click **Save Mapping** and enable the mapping. {% include components/actions-fields.html %} diff --git a/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md b/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md index 9ff0d60a40..cd507cb1f5 100644 --- a/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md +++ b/src/connections/destinations/catalog/actions-google-analytics-4-web/index.md @@ -32,9 +32,9 @@ To connect the Google Analytics 4 Web destination: 7. Analytics.js requires an initial Page call to send data to Google Analytics 4 Web. The [Segment snippet](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-add-the-segment-snippet) includes this initial call by default. 8. For GA4 to accept events on page, enable Set Configuration Mapping triggered by the first Segment event called after analytics.load(). Set Configuration Mapping calls the gtag(‘config’) command to enable tracking to your GA4 Measurement ID. -After you've set up and enabled the Set Configuration Mapping, enable at least one event in your **Mappings** tab. From there, view your events and parameters using the Google [Realtime](https://support.google.com/analytics/answer/9271392){:target="_blank"} or[DebugView](https://support.google.com/analytics/answer/7201382){:target="_blank"} reports. These two reports show you the events users trigger on your website as they occur. The DebugView report requires additional configuration before you can use it. Additional tools for debugging are to view all your Google enabled tracking via https://tagassistant.google.com(https://tagassistant.google.com){:target=”_blank”} or in your browser’s Dev Tools, view GA4 collect requests by filtering by /collect. +After you've set up and enabled the Set Configuration Mapping, enable at least one event in your **Mappings** tab. From there, view your events and parameters using the Google [Realtime](https://support.google.com/analytics/answer/9271392){:target="_blank"} or [DebugView](https://support.google.com/analytics/answer/7201382){:target="_blank"} reports. These two reports show you the events users trigger on your website as they occur. The DebugView report requires additional configuration before you can use it. Additional tools for debugging are to view all your Google enabled tracking via [Tag Assistant](https://tagassistant.google.com){:target="_blank"} or in your browser’s Dev Tools, view GA4 collect requests by filtering by /collect. -Google Analytics automatically populates some events and parameters. For example, there are [Automatically Collected](https://support.google.com/analytics/answer/9234069){:target=”_blank”} events collected by triggering the Set Configuration Mapping. Calling gtag(‘config’) and enabling [Enhanced Measurement events](https://support.google.com/analytics/answer/9216061){:target=”_blank”}, which are controlled by toggling “on” in your GA4 Admin panel, use event listeners to send events. All events tracked via GA4 Web populate some commonly used parameters like `page_location` without additional configuration. Review the [Google Analytics event parameters](https://support.google.com/analytics/table/13594742){:target=”_blank” documentation for more information. +Google Analytics automatically populates some events and parameters. For example, there are [Automatically Collected](https://support.google.com/analytics/answer/9234069){:target=”_blank”} events collected by triggering the Set Configuration Mapping. Calling gtag(‘config’) and enabling [Enhanced Measurement events](https://support.google.com/analytics/answer/9216061){:target=”_blank”}, which are controlled by toggling “on” in your GA4 Admin panel, use event listeners to send events. All events tracked via GA4 Web populate some commonly used parameters like `page_location` without additional configuration. Review the [Google Analytics event parameters](https://support.google.com/analytics/table/13594742){:target=”_blank”} documentation for more information. ### Recommended events @@ -62,7 +62,7 @@ With Google Analytics 4, you must create custom dimensions and metrics, also kno Similar to how properties relate to Segment events, parameters provide additional information about the ways users interact with your website. For example, when someone views a product you sell, you can include parameters that describe the product they viewed, like `product_name`, `category`, and `price`. -Automatically Collected and Enhanced Measurement events include a defined set of parameters by default. Google also provides a set of required and optional parameters to include with each Recommended event, and you can add more event parameters when you need them. Segment recommends that you review GA4’s list of defined event parameters, as anything beyond that list is a custom event parameter. The [Event collection limits](https://https://support.google.com/analytics/answer/9267744){:target=_blank”} also impact how many Custom Definitions your GA4 instance allows and how many parameters you can send with each event. +Automatically Collected and Enhanced Measurement events include a defined set of parameters by default. Google also provides a set of required and optional parameters to include with each Recommended event, and you can add more event parameters when you need them. Segment recommends that you review GA4’s list of defined event parameters, as anything beyond that list is a custom event parameter. The [Event collection limits](https://https://support.google.com/analytics/answer/9267744){:target="_blank"} also impact how many Custom Definitions your GA4 instance allows and how many parameters you can send with each event. ### Conversion events diff --git a/src/connections/destinations/catalog/actions-hubspot-cloud/index.md b/src/connections/destinations/catalog/actions-hubspot-cloud/index.md index a21b6e64d8..d6038422f9 100644 --- a/src/connections/destinations/catalog/actions-hubspot-cloud/index.md +++ b/src/connections/destinations/catalog/actions-hubspot-cloud/index.md @@ -141,8 +141,8 @@ Follow the steps outlined in HubSpot's [Uninstall an app](https://knowledge.hubs #### How does disconnecting and uninstalling affect a user's data and HubSpot account? Segment immediately stops sending data to HubSpot after you disconnect and uninstall a HubSpot account. -#### Understanding HubSpot's `date` and dateTime` custom property types -If you plan on sending a _date_ value that includes time data to your mapped HubSpot custom properties, select HubSpot's `dateTime` property type in HubSpot. If you plan to send a _date_ value that does not contain time data, select the `date` property value in HubSpot. For more information about custom property types, see HubSpot's [Custom objects](https://developers.hubspot.com/docs/api/crm/crm-custom-objects#properties){:target="_blank”} documentation. +#### Understanding HubSpot's `date` and `dateTime` custom property types +If you plan on sending a _date_ value that includes time data to your mapped HubSpot custom properties, select HubSpot's `dateTime` property type in HubSpot. If you plan to send a _date_ value that does not contain time data, select the `date` property value in HubSpot. For more information about custom property types, see HubSpot's [Custom objects](https://developers.hubspot.com/docs/api/crm/crm-custom-objects#properties){:target="_blank"} documentation. If you send a _date_ value that contains time data to a custom property in HubSpot with a `date` property type, the event might fail due to an "**Invalid Date Error**." diff --git a/src/connections/destinations/catalog/actions-kafka/index.md b/src/connections/destinations/catalog/actions-kafka/index.md index 3748bd60c4..4306627f0b 100644 --- a/src/connections/destinations/catalog/actions-kafka/index.md +++ b/src/connections/destinations/catalog/actions-kafka/index.md @@ -20,45 +20,20 @@ id: 65dde5755698cb0dab09b489 The way you've configured your Kafka Cluster informs the authentication and encryption settings you'll need to apply to the Segment Kafka Destination. You may need the assistance of someone technical to provide values for the following Settings: -
    -
  1. - On the Settings tab, enter values into the **Client ID**, **Brokers** and **Authentication Mechanism** setting fields. -
    2. -
  2. - Populate fields based on the value you selected from the Authentication Mechanism field: -
      -
    • - Plain or SCRAM-SHA-256 / 512 authentication: provide values for Username and Password fields. -
      • -
    • - Client Certificate authentication: provide values for the SSL Client Key and SSL Client Certificate fields. -
      • -
    -
    3. -
  3. - Populate the **SSL Certificate Authority** field, if necessary. -
    4. -
  4. - Save your changes and proceed to [Configure the Send Action](#configure-the-send-action). -
    5. -
+1. On the Settings tab, enter values into the **Client ID**, **Brokers** and **Authentication Mechanism** setting fields. +2. Populate fields based on the value you selected from the **Authentication Mechanism** field: + - **Plain** or **SCRAM-SHA-256 / 512** authentication: provide values for **Username** and **Password** fields. + - **Client Certificate** authentication: provide values for the **SSL Client Key** and **SSL Client Certificate** fields. +3. Populate the **SSL Certificate Authority** field, if necessary. +4. Save your changes and proceed to [Configure the Send Action](#configure-the-send-action). ### Configure the "Send" Action -
    -
  1. - Select the Mappings tab and add a new **Send** mapping. -
    2. -
  2. - Select a Topic to send data to. This field should auto-populate based on the credentials you provided in the Settings tab. -
    3. -
  3. - Map your payload using the **Payload** field.
    _(Optional)_: Specify partitioning preferences, Headers and Message Key values. -
    4. -
  4. - Save and enable the Action, then navigate back to the Kafka destination's Settings tab to enable and save the Destination. -
    5. -
+1. Select the Mappings tab and add a new **Send** mapping. +2. Select a Topic to send data to. This field should auto-populate based on the credentials you provided in the Settings tab. +3. Map your payload using the **Payload** field. + _(Optional)_: Specify partitioning preferences, Headers and Message Key values. +4. Save and enable the Action, then navigate back to the Kafka destination's Settings tab to enable and save the Destination. {% include components/actions-fields.html %} From 4ce3f53613cbdb0c3d2fe0af0941954186685e65 Mon Sep 17 00:00:00 2001 From: Carolina Lopez Date: Mon, 27 Oct 2025 11:36:08 -0500 Subject: [PATCH 4/6] Fix --- src/connections/destinations/catalog/actions-braze-web/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-braze-web/index.md b/src/connections/destinations/catalog/actions-braze-web/index.md index 20db884ddc..5661750e78 100644 --- a/src/connections/destinations/catalog/actions-braze-web/index.md +++ b/src/connections/destinations/catalog/actions-braze-web/index.md @@ -29,7 +29,7 @@ Braze web-mode (Actions) provides the following benefits over Braze (Classic): 3. Choose which of your sources to connect the destination to and follow the steps to create your destination. > warning "Mapping settings" > Some events require specific property names to map correctly into Braze. -> For example, purchase events must use a `products` array with `product_id` and `price. +> For example, purchase events must use a `products` array with `product_id` and `price`. > See [Braze-web settings mappings](#braze-web-settings-mapping) for "Device-web" for the full list of requirements before setting up mappings. 4. In the **Settings** tab, configure the connection settings. **API Key**, **SDK Endpoint**, and **REST Endpoint** are required settings. From bf61307abba10b7a8d97e25230272a4f4b166681 Mon Sep 17 00:00:00 2001 From: Carolina Lopez Date: Mon, 27 Oct 2025 11:47:10 -0500 Subject: [PATCH 5/6] Rename file, change html to md --- src/_includes/content/{papi-ga.html => papi-ga.md} | 0 src/api/config-api/api-design.md | 2 +- src/api/config-api/authentication.md | 2 +- src/api/config-api/index.md | 2 +- src/api/public-api/fql.md | 2 +- 5 files changed, 4 insertions(+), 4 deletions(-) rename src/_includes/content/{papi-ga.html => papi-ga.md} (100%) diff --git a/src/_includes/content/papi-ga.html b/src/_includes/content/papi-ga.md similarity index 100% rename from src/_includes/content/papi-ga.html rename to src/_includes/content/papi-ga.md diff --git a/src/api/config-api/api-design.md b/src/api/config-api/api-design.md index da2b06217f..b70743300c 100644 --- a/src/api/config-api/api-design.md +++ b/src/api/config-api/api-design.md @@ -2,7 +2,7 @@ title: API Design --- -{% include content/papi-ga.html %} +{% include content/papi-ga.md %} ## API Evolution: Versioning and Compatibility diff --git a/src/api/config-api/authentication.md b/src/api/config-api/authentication.md index cdec1e547e..d3b6445e13 100644 --- a/src/api/config-api/authentication.md +++ b/src/api/config-api/authentication.md @@ -2,7 +2,7 @@ title: Authentication --- -{% include content/papi-ga.html %} +{% include content/papi-ga.md %} You can access the Config API programmatically using access tokens. When you authenticate with an access token, you have access to any resource and permission assigned to the token. diff --git a/src/api/config-api/index.md b/src/api/config-api/index.md index 3e03b97ec6..d700ccf363 100644 --- a/src/api/config-api/index.md +++ b/src/api/config-api/index.md @@ -4,7 +4,7 @@ redirect_from: - '/config-api' --- -{% include content/papi-ga.html %} +{% include content/papi-ga.md %} The Config API lets you programmatically manage Segment workspaces, sources, destinations, and more. diff --git a/src/api/public-api/fql.md b/src/api/public-api/fql.md index 58f439bd7c..c15b3bdd00 100644 --- a/src/api/public-api/fql.md +++ b/src/api/public-api/fql.md @@ -5,7 +5,7 @@ redirect_from: - /api/config-api/fql --- -{% include content/papi-ga.html %} +{% include content/papi-ga.md %} This reference provides a comprehensive overview of the Segment Destination Filter query language. For information on the Destination Filters API (including information on migrating from the Config API), visit the [Destination Filters API reference](https://docs.segmentapis.com/tag/Destination-Filters){:target="_blank"}. From f0bd5b447a2d7a740f13835f59af8e2b7f5fe15b Mon Sep 17 00:00:00 2001 From: Carolina Lopez Date: Mon, 27 Oct 2025 12:02:00 -0500 Subject: [PATCH 6/6] escape < --- src/api/config-api/api-design.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/api/config-api/api-design.md b/src/api/config-api/api-design.md index b70743300c..8688d6cfe3 100644 --- a/src/api/config-api/api-design.md +++ b/src/api/config-api/api-design.md @@ -28,13 +28,13 @@ The Config API is a set of REST APIs for managing Segment resources. The primary You can manage each resource using standard methods: -| Method | HTTP Mapping | -|--------|-----------------------| -| List | GET | -| Get | GET | -| Create | POST | -| Update | PATCH | -| Delete | DELETE | +| Method | HTTP Mapping | +|--------|------------------------| +| List | GET \ | +| Get | GET \ | +| Create | POST \ | +| Update | PATCH \ | +| Delete | DELETE \ | ## Errors