Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ To connect the Amazon Conversions API Destination:
9. Follow the steps in [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
10. Toggle **Enable Destination** on, then click **Save Changes**.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

> info "Event Action Source"
> By default, Segment sends all mappings as `website` conversions. To send events from mobile apps, Fire TV, or offline sources, set the Event Action Source in each mapping to the appropriate value: `android`, `ios`, `fire_tv`, or `offline`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Sync modes available for v2 Actions include:
- **Upsert**: Update existing records and add new ones, if necessary.
- **Add**: Add records to a list, segment, or journey.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## Migration from Braze Classic

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ If you are creating multiple mappings in one Braze Cohorts destination, Segment
> info ""
> A user can only be added to a cohort if the user already exists in Braze. This means that the Braze Cohorts destination should be used in parallel with the [Braze Cloud Mode (Actions) destination](/docs/connections/destinations/catalog/braze-cloud-mode-actions/) or the [Braze Web Mode (Actions) destination](/docs/connections/destinations/catalog/braze-web-device-mode-actions/), both of which can create users in Braze.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

### Supplementing audience payloads

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ After setting up your Braze Web Mode (Action) destination in the Segment app, Se
> If you're using a device-mode connection, Braze's SDK assigns a `device_id` and a backend identifier, `braze_id`, to every user. This allows Braze to capture anonymous activity from the device by matching on those identifiers instead of `userId`. This applies to _device-mode connections_.


{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## Other features

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ id: 5f7dd78fe27ce7ff2b8bfa37
6. Enter the **API Key** and **Site ID**. Find these values on the [Customer.io API Credentials Page](https://fly.customer.io/settings/api_credentials){:target="_blank"}.
7. Select **Quick Setup** to start with pre-populated subscriptions, or **Customized Setup** to configure each action from scratch. Click **Configure Actions**.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}


## Migration from Customer.io classic
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ When these properties are available, they send to the `update` command.

If you have any questions setting up consent mode, reach out to [friends@segment.com](mailto:friends@segment.com).

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## FAQ and troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The Google Campaign Manager 360 destination supports hashing for the following f

The hashing algorithm used is SHA-256. If incoming data arrives already hashed, the destination will not hash it again. The values will be sent as-is to Google.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## FAQ and troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Sync modes allow users to define how Segment should update the data in your dest
Sync modes available for v2 Actions include:
- **Add**: Add records to a list, segment, or journey.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## Consent mode
[Consent mode](https://support.google.com/analytics/answer/9976101?hl=en){:target="_blank"} is a feature provided by Google in the context of its products, particularly the Gtag library and Google Analytics. As of March 6, 2024, Google announced that consent mode must function for European Economic Area (EEA) users, otherwise data from EEA users won't process.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ HubSpot Web (Actions) provides the following benefits over the classic HubSpot d
6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
7. Enable the destination and configured mappings.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## FAQ & Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To access the Intercom Messaging Box, you'll need to configure and connect the I
> info ""
> Segment doesn't support the creation of **Leads** for Intercom Web. Segment recommends using [Intercom Cloud Mode](/docs/connections/destinations/catalog/actions-intercom-cloud/) to support leads creation.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Koala maintains this destination. For any issues with the destination, [contact
5. On the **Settings** tab, input your **Public API Key** which can be found in your Koala workspace settings under **Settings > Install**.
6. Once connected, you can configure how you want to send data to Koala. By default, Segment forwards track events and identify events to Koala. Koala recommends sticking with the defaults.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Koala maintains this destination. For any issues with the destination, [contact
5. On the **Settings** tab, input your **Public API Key** which can be found in your Koala workspace settings under **Settings > Install**.
6. Once connected, you can configure how you want to send data to Koala. By default, Segment forwards track events and identify events to Koala. Koala recommends sticking with the defaults.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The setup is complete and the Audience will start syncing to LinkedIn. Segment a

To sync additional Audiences from your Engage space, create a separate mapping in the LinkedIn Audiences destination. Navigate to **Connections > Destinations**, search and select the LinkedIn Audiences destination, and follow Steps 9-11 above.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## Linked Audiences

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Segment also handles the following mapping:
## GDPR Support
Segment supports deleting/suppressing users in Optimizely Feature Experimentation (Actions) using the [Segment app](/docs/privacy/user-deletion-and-suppression/). Before deleting/suppressing a user, create a [Personal Access Token](https://developers.optimizely.com/x/authentication/personal-token/){:target="_blank”} in Optimizely and provide it as the value of the Personal Access Token setting.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ To connect the Pinterest Conversions API Destination:
8. Follow the steps in [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
9. Toggle **Enable Destination** on, then click **Save Changes**.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

> info "Setting conversion type"
> By default, Segment sends all mappings as `web` conversions. To send events as mobile or offline conversions, set the Action Source in each mapping to `app_android`, `app_ios`, or `offline`.
Expand Down
2 changes: 1 addition & 1 deletion src/connections/destinations/catalog/actions-s3/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ To finish the setup, enable the AWS S3 (Actions) Destination in your workspace:
* Enter the IAM External ID, which is a value set in the Trust Relationship under your AWS IAM Role.
5. Enable the destination.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

### Step 3: Configure the AWS S3 (Actions) Destination mappings
To finish the configuration, add mappings to your new AWS S3 (Actions) Destination:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Once you save the API integration and add permissions, you will see a Summary pa
8. (*Optional*) Follow the steps in the Destinations Actions documentation on [customizing mappings](/docs/connections/destinations/actions/#customize-mappings) to customize your mappings.
7. Enable the destination and configured mappings.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

> info ""
> Note that **send contact to data extension** handles a pre-defined structure of contacts being filled into a data extension, whereas **send event to data extension action** customizes event data extensions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To use this destination, you must have an active Segment Unify space. If you hav
6. Enable the configured mapping(s).
7. On the **Settings** tab, click the **Enable Destination** toggle, and then click **Save Changes** to enable the Segment Profiles destination.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## FAQ & Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The Segment Connections destination enables you to mold data extracted from your
6. Enable the configured mapping(s).
7. On the **Settings** tab, click the **Enable Destination** toggle, and then click **Save Changes** to enable the Segment Connections destination.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## FAQ & Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ Segment supports sending Engage user profile traits to SendGrid Contact User Att

1. Use [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) to include specific user profile traits when syncing users to a SendGrid List.
2. Standard User Attributes: Use the [Sync Audience Action](#sync-audience-action)'s User Attributes field to map the following [Contact Profile Fields](https://www.twilio.com/docs/sendgrid/ui/managing-contacts/segmenting-your-contacts#contact-profile-fields){:target="_blank”} to SendGrid:
- First Name
- Last Name
- Phone Number (must be in [E.164](https://www.twilio.com/docs/glossary/what-e164){:target="_blank”} format)
- Address Line 1
- Address Line 2
- City
- State/Province/Region
- Country
- Postal Code
- First Name
- Last Name
- Phone Number (must be in [E.164](https://www.twilio.com/docs/glossary/what-e164){:target="_blank”} format)
- Address Line 1
- Address Line 2
- City
- State/Province/Region
- Country
- Postal Code
3. Custom User Attributes: Define a custom User Attribute in SendGrid, then use [Sync Audience ](#sync-audience-action) Action to send custom User Attributes to SendGrid using the Custom Fields field. You can only send string, number, and date values to SendGrid with this method.

### Supported identifiers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To sync additional Audiences from your Engage space, create a separate instance
> info "Mapping tester availability"
> The Mapping Tester isn't available for this destination. Since this destination requires batched events for activation, testing can only be performed end-to-end with a connected source.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}


## Limitations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ id: 64c1690a9f08c84a420aba78

[TikTok Pixel](https://ads.tiktok.com/marketing_api/docs?id=1739583652957185){:target="_blank"} is a piece of code that you can place on your website that allows you to share website events with TikTok. With TikTok for Business Tools, the Pixel can help you measure traffic on your website, measure ad campaign performance, optimize your campaigns and find new customers.

### Benefits of TikTok Pixel
## Benefits of TikTok Pixel

Use data collected from TikTok Pixel to:
- **Build marketing audiences**: Create custom Audiences based on website visitor events, like viewing a product page or making a purchase. Audiences can be used to re-engage previous site visitors or model lookalikes to find new customers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@ To integrate Segment with VWO FullStack:
By adding the VWO Cloud mode destination to your Segment audiences, you can export audiences to your VWO account to target your campaigns in VWO. To achieve this, perform the following steps:

1. Navigate to **Engage > Engage Settings**, and click **Destinations**.
- Ensure that you're in the Engage space you plan to use for VWO.
- Ensure that you're in the Engage space you plan to use for VWO.
2. Click **Add Destination**.
3. Search for “VWO Cloud Mode (Actions)” and select the destination. Click **Add Destination**.
4. On the **Select Source** screen, you'll see your Engage space selected as the source. Click **Confirm Source**.
5. Select the VWO Cloud mode destination that you’ve created and navigate to the **Settings** tab. Name your destination and enter your **VWO Account ID**. Toggle **Enable Destination** on and click **Save Changes**.
- You'll find your VWO account ID at the top of the VWO dashboard.
- You'll find your VWO account ID at the top of the VWO dashboard.
6. Navigate to the **Mappings** tab and click **New Mapping**. Under **PRE-BUILT MAPPINGS**, select **Sync Audience**, then click **Save**.
7. The **STATUS** of the mapping displays as disabled by default. Enable the mapping using the toggle.
8. Navigate to **Engage > Audiences**. Choose an existing Engage audience or create a new one to export to VWO.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Segment's Webhooks (Actions) destination uses internet protocol and HTTP callbac
6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). You can create up to 5 mappings, each of which can send to a different webhook URL.
7. Enable the destination and configured mappings.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

## Batch size limits

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ The Adobe Analytics destination automatically works with Segment's standard [Eco
<td>Adobe Analytics Event Name</td>
</tr>
<tr>
<td>Product Viewed
<br>Product List Viewed
</td>
<td>Product Viewed<br>Product List Viewed</td>
<td>`prodView`</td>
</tr>
<tr>
Expand All @@ -48,11 +46,11 @@ The Adobe Analytics destination automatically works with Segment's standard [Eco
<tr>
<td>Order Completed</td>
<td>`purchase`</td>
</tr>
<tr>
<td>Cart Opened</td>
<td>`scOpen`</td>
</tr>
</tr>
</table>

Segment sends the Ecommerce event data to Adobe just as it would send a standard Track event. These Ecommerce events are automatically mapped and sent to Adobe Analytics along with product description data. If you implement Segment events using the Ecommerce spec and naming conventions, you do **NOT** need to create a mapping in your Segment Adobe destination settings. You only need to map **event names** if you want to set them as the value of an `eVar`. To learn more about configuring `eVars` see [the section below on configuring conversion variables in your destination settings.](#conversion-variables---evars)
Expand Down Expand Up @@ -335,8 +333,9 @@ An example eVar mapping in the Segment Destination settings UI should look like

You can only map properties to Adobe eVar properties. For example, you could map the following properties to Adobe: `path`, `referrer`, `search`, `signup_mode`, `title` and `url`.

>![Adobe evar](https://github.com/segmentio/segment-docs/assets/82051355/999b398a-f752-47f6-8511-9b2ec866cbae)
>![adobe mapping](https://github.com/segmentio/segment-docs/assets/82051355/c22eb82d-c9cd-4a2a-b216-b9b36569a606)
![Adobe evar](https://github.com/segmentio/segment-docs/assets/82051355/999b398a-f752-47f6-8511-9b2ec866cbae)

![adobe mapping](https://github.com/segmentio/segment-docs/assets/82051355/c22eb82d-c9cd-4a2a-b216-b9b36569a606)



Expand All @@ -358,7 +357,7 @@ The Segment Adobe Analytics Merchandising setting runs as follows:
If you don't include a value, Segment sends the event without one, and Adobe understands this as an increment of `1`. If you configure a value and the value is not present on the `track` or `page` call, Segment does not send the event to Adobe.
- Map of product eVars to set on the products string. This is only supported at the product level, as expected by Adobe Analytics. <!-- TODO LR Note: this whole section could use work, but this part is especially confusing-->

> info "Product Added, Product Removed, and Product Viewed events do not use the "products" array"
> info "Product Added, Product Removed, and Product Viewed events do not use the products array"
> Product Added, Product Removed, and Product Viewed events store product information in the top level property object rather than in the "products" array. When adding an eVar to these events, specify `properties.key` as the Segment key in the mapping.
>
> For more information, see the [Product Added Spec](/docs/connections/spec/ecommerce/v2/#product-added).
Expand Down
8 changes: 4 additions & 4 deletions src/connections/destinations/catalog/amplitude/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ When you use the **Track All Pages** setting, Segment sends a `Loaded a Page` ev
The following settings are available on iOS for device-mode connections.

| Setting Name | When events will be sent to Amplitude | Amplitude Event Name | Example for `{"name": "Settings", "category": "Merchant" }` |
| ----------------- | ------------------------------------- | -------------------- |
| ----------------- | ------------------------------------- | -------------------- | ----------- |
| Track All Pages | Always | Viewed (Name) | "Viewed Settings" |
| Track All Screens | Always | Loaded a Screen | "Loaded a Screen" |

Expand Down Expand Up @@ -159,7 +159,7 @@ The table below represents default behavior.

| Library | Default | Fallback |
| ----------- | ----------------------- | ------------- |
| A.js | Generated by Amplitude] | `anonymousId` |
| A.js | Generated by Amplitude | `anonymousId` |
| Server-side | `context.device.id` | `anonymousId` |
| iOS | Generated by Amplitude | n/a |
| Android | Generated by Amplitude | n/a |
Expand All @@ -181,8 +181,8 @@ If you're using the "Prefer Advertising ID for Device ID" setting with one of ou

| Library | Default | Fallback |
| ------- | ------------- | ----------------------- |
| iOS | `anonymousId` | [Generated by Amplitude |
| Android | `anonymousId` | [Generated by Amplitude |
| iOS | `anonymousId` | Generated by Amplitude |
| Android | `anonymousId` | Generated by Amplitude |

### Device ID priority

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ Encharge maintains this destination. For any issues with the destination, [conta
10. Click **Save Changes**.
11. To start with pre-populated event subscriptions, enable the **Enable Destination** and click **Save Changes**. Otherwise, click on the **Mappings** tab to configure each action, and then enable the destination.

{% include components/actions-fields.html settings="true"%}
{% include components/actions-fields.html settings="true" %}

Loading