Skip to content

fixes for batch 5.3 #8096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 27, 2025
Merged

fixes for batch 5.3 #8096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c2e68ec
fixes for batch 5.3
Deflaimun Oct 26, 2025
cd4a497
remove liquid syntax and keep the note generic
Deflaimun Oct 26, 2025
1c018d1
fix numbering
Deflaimun Oct 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/_includes/content/sync-frequency-note.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
<div class="fa fa-info-circle"></div>
<div class="content">
<p class="header">Real-time to batch destination sync frequency</p>
<p>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.</p>
<p>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.</p>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some usages showed

Real-time audience syncs to Display and Video 360 (Actions) ...

Real-time audience syncs to Facebook Custom Audiences ... 

Real-time audience syncs to Iterable Lists (Actions) ...

Modifying the snippet to make it generic, doesn't remove context. If you're inside a page already, then it's obvious that this statement applies to this subject.

</div>
</div>
37 changes: 11 additions & 26 deletions src/connections/destinations/catalog/actions-facebook-custom-audiences/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Comment on lines +46 to +48
Copy link
Contributor Author

@Deflaimun Deflaimun Oct 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved the warning to top, to prevent markdown list order to reset (previously the html was used to prevent that from happening)

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.

<ol style="counter-reset: none;">
<li value="6" markdown=1>
Set how often your model syncs by setting the [Sync schedule](/docs/connections/reverse-etl/#step-4-create-mappings).
</li>
<li value="7" markdown=1>
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.
</li>
<li value="8" markdown=1>
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.
<ul>
<li> 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. </li>
<li> Segment recommends mapping as many parameters as you have available in your source model so that you can increase your match rates. </li>
</ul>
</li>
<li value ="9" markdown=1>
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**.
</li>
<li value="10" markdown=1>
Click **Save Mapping** and enable the mapping.
</li>
</ol>
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

Expand All @@ -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 %}
Expand Down
6 changes: 3 additions & 3 deletions src/connections/destinations/catalog/actions-google-analytics-4-web/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/connections/destinations/catalog/actions-hubspot-cloud/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**."

Expand Down
47 changes: 11 additions & 36 deletions src/connections/destinations/catalog/actions-kafka/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<ol style="counter-reset: none">
<li value="5" markdown="1">
On the Settings tab, enter values into the **Client ID**, **Brokers** and **Authentication Mechanism** setting fields.
</li>
<li value="6">
Populate fields based on the value you selected from the <b>Authentication Mechanism</b> field:
<ul>
<li>
<b>Plain</b> or <b>SCRAM-SHA-256 / 512</b> authentication: provide values for <b>Username</b> and <b>Password</b> fields.
</li>
<li>
<b>Client Certificate</b> authentication: provide values for the <b>SSL Client Key</b> and <b>SSL Client Certificate</b> fields.
</li>
</ul>
</li>
<li value="7" markdown="1">
Populate the **SSL Certificate Authority** field, if necessary.
</li>
<li value="8" markdown="1">
Save your changes and proceed to [Configure the Send Action](#configure-the-send-action).
</li>
</ol>
1. On the Settings tab, enter values into the **Client ID**, **Brokers** and **Authentication Mechanism** setting fields.
Copy link
Contributor Author

@Deflaimun Deflaimun Oct 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original author intended the whole page to be a set of steps.

However, the lists are introduced at each paragraph. Reseting the number here still makes sense as they're a different set of steps, even though as a whole its a continuum action

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

<ol style="counter-reset: none;">
<li value="9" markdown=1>
Select the Mappings tab and add a new **Send** mapping.
</li>
<li value="10" markdown=1>
Select a Topic to send data to. This field should auto-populate based on the credentials you provided in the Settings tab.
</li>
<li value="11" markdown=1>
Map your payload using the **Payload** field. <br> _(Optional)_: Specify partitioning preferences, Headers and Message Key values.
</li>
<li value="12" markdown=1>
Save and enable the Action, then navigate back to the Kafka destination's Settings tab to enable and save the Destination.
</li>
</ol>
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 %}

Expand Down
Loading