You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/configuration.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,21 @@ This guide assumes that you've already added the Signals SDK to your application
13
13
> info "Auto-Instrumentation in public beta"
14
14
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
15
15
16
+
> info "Regional availability"
17
+
> Auto-Instrumentation isn't supported in EU workspaces.
18
+
16
19
## Converting signals to events
17
20
18
21
After you set up the Signals SDK to capture the signals you want to target, you can create rules in your Segment workspace to translate the captured signals into traditional Segment analytics events. These rules are deployed in your application the next time a user launches your app.
19
22
23
+
The process works like this:
24
+
25
+
1. The SDK sends raw signals from your app or website to Segment.
26
+
2. You build event rules in your workspace that define how those signals should become analytics events.
27
+
3. You publish the event rules.
28
+
29
+
After publishing, Segment analyzes user interactions in your app or website against these rules and automatically generates analytics events when matching interactions occur.
30
+
20
31
### Getting started with rule creation
21
32
22
33
1. Ensure you have the `Workspace Owner` or `Source Admin` role in Segment. If your source is connected to a tracking plan, you will also need, at a minimum, the `Tracking Plan Read-only` role. To view the content in the Event Builder tab, you will need, at a minimum, the `Source Read-only` role.
@@ -47,13 +58,11 @@ You can enrich your events by adding properties based on signal metadata. For ex
47
58
48
59
These properties are sent alongside your event, giving your team deeper insights without requiring any manual instrumentation.
49
60
61
+
<!-- PW, 6 August 2025: Commenting this section out for now
50
62
#### Preview your event rule
51
63
52
64
To verify that a rule is working as expected, you don't need to enter a cycle of creating and updating the rule, generating signals, then checking the source debugger for the generated event. As you create, edit, or view a rule, you can preview it in real time against the current signal buffer to see which signals match and what the resulting event will look like. Event properties are mapped to the values found in the matched signals, and complete matches are grouped by anonymous ID.
53
65
54
-
55
-
<!-- PW, 6 August 2025: Commenting this section out for now
56
-
57
66
The Rules Editor also lets you test your rules with recent signals to verify that they produce the data you need before you deploy.
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/event-builder.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,9 @@ You can use it to create Track, Identify, Page, and other event types directly f
10
10
> info "Auto-Instrumentation Private Beta"
11
11
> Auto-Instrumentation is currently in Private Beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. Segment is actively iterating on and improving the Auto-Instrumentation user experience.
12
12
13
+
> info "Regional availability"
14
+
> Auto-Instrumentation isn't supported in EU workspaces.
15
+
13
16
## Access the Event Builder
14
17
15
18
The Event Builder appears as a tab within each source, next to the Debugger. If you don't see the Event Builder tab, first confirm that you've installed the required Auto-Instrumentation SDK.
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/index.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,9 @@ Auto-Instrumentation simplifies tracking in your websites and apps by removing t
29
29
> info "Auto-Instrumentation in public beta"
30
30
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
31
31
32
+
> info "Regional availability"
33
+
> Auto-Instrumentation isn't supported in EU workspaces.
34
+
32
35
## Background
33
36
34
37
Collecting high-quality analytics data is essential, but traditional tracking setups often fall behind as business needs change. Instrumentation updates take time away from other engineering priorities, and these delays reduce visibility and increase the burden on engineering teams.
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/kotlin-setup.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,9 @@ This guide shows how to install and configure the library, as well as how to ena
10
10
> info "Auto-Instrumentation in public beta"
11
11
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
12
12
13
+
> info "Regional availability"
14
+
> Auto-Instrumentation isn't supported in EU workspaces.
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/swift-setup.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,9 @@ Learn how to connect an existing source, integrate dependencies, turn on Auto-In
10
10
> info "Auto-Instrumentation in public beta"
11
11
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
12
12
13
+
> info "Regional availability"
14
+
> Auto-Instrumentation isn't supported in EU workspaces.
15
+
13
16
## Step 1: Get your source write key
14
17
15
18
You need the `writeKey` from an existing Segment source. To find it:
Copy file name to clipboardExpand all lines: src/connections/auto-instrumentation/web-setup.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,9 @@ Learn how to connect an existing source, integrate dependencies, turn on Auto-In
10
10
> info "Auto-Instrumentation in public beta"
11
11
> Auto-Instrumentation is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
12
12
13
+
> info "Regional availability"
14
+
> Auto-Instrumentation isn't supported in EU workspaces.
15
+
13
16
## Step 1: Get your source write key
14
17
15
18
You need the `writeKey` from an existing Segment source. To find it:
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/ab-smartly/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,12 +24,12 @@ Segment provides specific implementation details for A/B Smartly in the sections
24
24
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
25
25
2. Search for "A/B Smartly" in the Destinations Catalog, and select the "A/B Smartly" destination.
26
26
3. Choose which Source should send data to the "A/B Smartly" destination.
27
-
4. Go to the A/B Smartly dashboard(https://your-org-name.absmartly.com/apikey/list){:target="_blank”}, find and copy the "API key" that you created for segment.
27
+
4. Go to the A/B Smartly dashboard (`https://your-org-name.absmartly.com/apikey/list`), find and copy the "API key" that you created for segment.
28
28
5. Enter the "API Key" in the "A/B Smartly" destination settings in Segment.
29
29
6. If the integration requests for an Application name go to your A/B Smartly dashboard (`https://your-org-name.absmartly.com/application/create`) and create an Application named "Segment", or whatever you would like to call it. Use that name in the Application field of the integration settings.
30
30
7. Add also your A/B Smartly Collector endpoint. It's the same endpoint that you are using in all your A/B Smartly SDKs.
31
31
8. Enter the environment from your Environment list (`https://your-org-name.absmartly.com/environment/list`) that should receive your Segment data. Most likely it will be the production one.
32
-
9. And finally a mapping of Segment Identities to A/B Smartly Units(`https://your-org-name.absmartly.com/unit/list`). You should map all of your Segment identities that you would like to use in your A/B tests to the units that you already have in A/B Smartly. Users must map all the identity types, but not for the individual users. Map all of your ids in your Unit List(`https://your-org-name.absmartly.com/unit/list`).
32
+
9. And finally a mapping of Segment Identities to A/B Smartly Units(`https://your-org-name.absmartly.com/unit/list`). You should map all of your Segment identities that you would like to use in your A/B tests to the units that you already have in A/B Smartly. Users must map all the identity types, but not for the individual users. Map all of your ids in your Unit List(`https://your-org-name.absmartly.com/unit/list`).
33
33
10. Optionally go to "Goal Mapping" and start adding the track calls that you would like to see showing up on A/B Smartly as goals. You only need to create a name mapping if the name of the goal on A/B Smartly's platform is different from the name of the track call in Segment.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/aboardly/index.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,6 @@ Once the Segment library is integrated with your server, toggle Aboardly on in y
10
10
11
11
Aboardly supports the `identify` and `track` methods.
12
12
13
-
14
13
## Identify
15
14
16
15
When you `identify` a user, we'll pass that user's information to Aboardly with `userId` as Aboardly's External Customer ID. Aboardly recognizes all traits sent by Segment, however in order to send emails you should always add the `email` trait when possible.
[FullSession](https://fullsession.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} provides user behavior analytics software that helps you visualize all user interactions, analyze trends and patterns with laser precision, and optimize your website for peak performance. The Segment integration for FullSession helps accurately identify your customers and track their behavior within the FullSession dashboard.
10
+
11
+
This destination is maintained by FullSession. For any issues with the destination, [contact the FullSession support team](mailto:support@fullsession.com){:target="_blank"}.
12
+
13
+
## Getting started
14
+
15
+
1. From your workspace’s [Destination Catalog](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"}, search for **“FullSession”**.
16
+
2. Select **FullSession**, then click **Add Destination**.
17
+
3. Choose an existing **JavaScript Source** to connect with FullSession (Actions).
18
+
4. Navigate to the [FullSession Setup](https://app.fullsession.io/settings/setup){:target="_blank"} page and copy your **Customer ID**, beginning with `cus_`.
19
+
5. Paste the **Customer ID** into the **FullSession Destination settings** in Segment.
20
+
6. Before enabling the destination, go to the **Mappings** tab and configure the mappings to ensure the correct data is captured.
21
+
7. Once your mappings are configured and enabled, go to the **Settings** tab and enable the destination. Segment then automatically loads the **FullSession recording snippet** in the user’s browser.
[StackAdapt](https://www.stackadapt.com/){:target="_blank"} is a programmatic advertising platform specializing in audience engagement. StackAdapt lets marketers deliver high-performing advertising campaigns across channels through real-time bidding, detailed audience targeting, and data-driven insights. StackAdapt’s integration with [Engage](/docs/engage/) helps you sync user data to optimize targeting and improve your campaign outcomes.
13
+
[StackAdapt](https://www.stackadapt.com/){:target="\_blank"} is a programmatic advertising platform specializing in audience engagement. StackAdapt lets marketers deliver high-performing advertising campaigns across channels through real-time bidding, detailed audience targeting, and data-driven insights. StackAdapt’s integration with [Engage](/docs/engage/) helps you sync user data to optimize targeting and improve your campaign outcomes.
14
14
15
-
This destination is maintained by StackAdapt. For any issues with the destination, submit a ticket to [StackAdapt's support team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}.
15
+
This destination is maintained by StackAdapt. For any issues with the destination, submit a ticket to [StackAdapt's support team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="\_blank"}.
16
16
17
17
## Getting started
18
18
19
19
> info "Getting your StackAdapt GraphQL token"
20
-
> If you do not have an existing StackAdapt read & write API key, contact the [StackAdapt team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="_blank"}.
20
+
> If you do not have an existing StackAdapt read and write API key, contact the [StackAdapt team](https://support.stackadapt.com/hc/en-us/requests/new?ticket_form_id=360006572593){:target="\_blank"}.
21
21
22
22
### Setting up the StackAdapt Audiences destination in Engage
23
23
24
24
1. In your Segment workspace, navigate to **Connections > Catalog > Destinations**.
25
25
2. Search for and select "StackAdapt Audiences".
26
26
3. Click **Add Destination**.
27
27
4. Select an existing Engage space source to connect to the StackAdapt Audience destination.
28
-
5. Enter a name for your destination.
29
-
6. On the Settings screen, provide your StackAdapt GraphQL API token. Then, put in the ID of the advertiser you want to sync the audience with. You can [find the advertiser ID in StackAdapt](#finding-the-advertiser-id-in-stackadapt).
30
-
7. Toggle the destination on using **Enable Destination**.
31
-
8. Click **Save Changes**.
32
-
9. Follow the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings) or [sync an Engage Audience](#sync-an-engage-audience).
33
-
10. Enable the destination and click **Save Changes**.
28
+
5. On the Settings screen, enter a name for your destination.
29
+
6. Provide your StackAdapt GraphQL API token.
30
+
7. Input the ID of the advertiser you want to sync the audience with. You can [find the advertiser ID in StackAdapt](#finding-the-advertiser-id-in-stackadapt).
31
+
8. Toggle the destination on using **Enable Destination**.
32
+
9. Click **Save Changes**.
34
33
35
34
#### Finding the advertiser ID in StackAdapt
35
+
36
36
In StackAdapt, go to **Execute** (or **Overview**) and click **Advertiser**.
37
37
From the **Filter** section, select the advertiser. The advertiser ID appears in the URL after `advertiser=`.
38
38
39
39
### Sync an Engage Audience
40
40
41
41
To sync an Engage audience with StackAdapt:
42
42
43
-
1. Each Engage audience should only contain profiles that have a valid email address. Profiles missing an email address are not valid on StackAdapt's platform.
44
-
2. Add a condition to the Engage audience to ensure the required email trait is included.
45
-
3. Open the previously created StackAdapt Audience destination.
46
-
4. Create a mapping: In the mappings tab, click **New Mapping** and select **Forward Audience Event**.
43
+
Each Engage audience should only contain profiles that have a valid email address. Profiles missing an email address are not valid on StackAdapt's platform.
44
+
45
+
1. Go to **Engage > Audiences** and select the audience you would like to sync.
46
+
2. Scroll to the destinations section and add the **StackAdapt Audience** destination.
47
+
3. Under the **Connection settings** section, enable **Send Identify**.
48
+
4. Under **Event settings**, select **Customized Setup** to choose the list of profile traits you want to sync.
49
+
- Add **email** as an identifier.
50
+
- Add traits as needed. Note that you should set up corresponding mappings for the fields in step 9 for the traits selected here if you want them to be imported.
51
+
5. Click **Save**.
52
+
6. Click on the **StackAdapt Audience** destination under the **Destinations** section.
53
+
7. Under the **Matching Mappings** tab, click **Add mapping**.
47
54
- To reuse your Segment audience on the StackAdapt platform, select **Sync Audience**.
48
-
- To apply import profiles to the StackAdapt platform, select **Forward Profile**.
49
-
-**Note**: you don't have to set up both mappings.
50
-
5. Define the event trigger: Click **Add Condition** and add this condition: **Event Type is `Track` or `Identify`**.
51
-
6. Map fields:
55
+
- To import profiles to the StackAdapt platform, select **Forward Profile**.
56
+
-**Note**: You don't have to set up both mappings. The mappings will be shared across all audiences that have sync enabled to this destination. You should create a new destination if you wish to use different mappings for different audiences.
57
+
8. Define the event trigger: Ensure the Event Type is `Track` or `Identify`.
58
+
9. Map fields:
52
59
- (**Required**:) Select a default value for `Marketing Status`.
53
-
- (**Required**:) Select the source field for `Email`.
54
-
- Select source field for `Standard User Properties`,
60
+
- (**Required**:) Confirm that you have a valid source field for `Email`.
61
+
- Select the source field for `Standard User Properties`. Ensure the source field matches the profile traits selected in step 4. You can learn more about the field format by hovering over the info icon of the field.
55
62
- Create mappings for `Custom User Properties` if applicable.
63
+
- Follow the Destinations Actions documentation to [customize mappings](/docs/connections/destinations/actions/#customize-mappings).
56
64
57
-
To verify that your audience syncs with StackAdapt, open StackAdapt and navigate to **Audience & Attribution > Customer Data > Profiles**. On the Profiles tab, you should be able to see a list of profiles being synced to StackAdapt platform.
65
+
To verify that your audience syncs with StackAdapt, open StackAdapt and navigate to **Audience & Attribution > Customer Data > Profiles**. On the Profiles tab, you should be able to see a list of profiles being synced to the StackAdapt platform.
58
66
59
67
> info "Syncs can take up to 4 hours"
60
68
> It can take up to 4 hours from the time you initiate a sync for profiles to show up in StackAdapt.
61
69
62
70
To create a StackAdapt audience from your Engage audience:
63
71
64
-
1. Open StackAdapt and navigate to **Audience & Attribution > Data Data > Segments**, then click **Create Segment**.
72
+
1. Open StackAdapt and navigate to **Audience & Attribution > Customer Data > Segments**, then click **Create Segment**.
65
73
2. Select the advertiser you have synced your audience to.
66
74
3. Choose **Profile Properties > Segment** and select **External Audience Name** as the rule.
67
-
4. Select a condition and put in the audience name as the filter.
75
+
4. Select a condition and enter the audience name as the filter.
68
76
5. Click **Submit** to create the segment.
69
77
70
78
> info "Audience name format"
71
-
> Use the *snake_case* name of the Segment Engage audience which can be found in **Settings**, shown in the following screenshot.
@@ -80,4 +88,4 @@ To create a StackAdapt audience from your Engage audience:
80
88
81
89
## Data and privacy
82
90
83
-
Review [StackAdapt's Data Processing Agreement](https://www.stackadapt.com/data-processing-agreement){:target="_blank"} to learn more about StackAdapt's privacy and data terms.
91
+
Review [StackAdapt's Data Processing Agreement](https://www.stackadapt.com/data-processing-agreement){:target="\_blank"} to learn more about StackAdapt's privacy and data terms.
0 commit comments