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
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,11 +23,12 @@ After you set up the Signals SDK to capture the signals you want to target, you
23
23
24
24
### Getting started with rule creation
25
25
26
-
1. In your Segment workspace, go to **Sources** and select a source.
27
-
2. Open the **Event Builder**, then click **Create Rules**.
26
+
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.
27
+
2. In your Segment workspace, go to **Sources** and select a source.
28
+
3. Open the **Event Builder**, then click **Create Rules**.
28
29
29
30
> info "Where's the Event Builder tab?"
30
-
> The Event Builder tab only appears after you've installed the Auto-Instrumentation snippet in your site or app. If you don’t see the tab, double check your implementation or reach out to your Segment CSM.
31
+
> The Event Builder tab only appears after you've enabled AutoInstrumentation under the Analytics.js tab in the source's settings. If you don’t see the tab, reach out to your Segment CSM.
31
32
32
33
### Using the Rules Editor
33
34
@@ -37,6 +38,10 @@ The Rules Editor is where you define rules that transform raw signal data into a
37
38
- Set conditions to control when events should be triggered
38
39
- Assign custom event names
39
40
41
+
#### Tracking plan integration
42
+
43
+
If your source is connected to a tracking plan, you can quickly confirm that a rule’s event and properties are planned. When creating or editing a rule, choose an event by typing its name or selecting from the tracking plan’s events in a dropdown. Similarly, add properties by typing their names or selecting from the event’s properties in a dropdown. The Planned column, shown next to each property mapping and in the Event Rules table, indicates whether the property or event is planned.
44
+
40
45
#### Adding event properties
41
46
42
47
You can enrich your events by adding properties based on signal metadata. For example:
@@ -46,6 +51,11 @@ You can enrich your events by adding properties based on signal metadata. For ex
46
51
47
52
These properties are sent alongside your event, giving your team deeper insights without requiring any manual instrumentation.
48
53
54
+
#### Preview your event rule
55
+
56
+
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.
57
+
58
+
49
59
<!-- PW, 6 August 2025: Commenting this section out for now
50
60
51
61
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/destinations/catalog/actions-friendbuy-cloud/index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,15 @@ id: 61dde0dc77eb0db0392649d3
7
7
---
8
8
{% include content/plan-grid.md name="actions" %}
9
9
10
-
[Friendbuy](https://www.friendbuy.com/){:target='_blank'} powers referral programs for e-commerce merchants of all sizes, providing an easy solution to launch Refer-a-Friend programs and accelerate growth through word of mouth.
10
+
[Friendbuy](https://www.friendbuy.com/){:target="_blank"} powers referral programs for e-commerce merchants of all sizes, providing an easy solution to launch Refer-a-Friend programs and accelerate growth through word of mouth.
11
11
12
12
Friendbuy's cloud mode Segment integration allows you to send data to Friendbuy from your data center so that Friendbuy can act on it. For example, you could trigger a reward when a referred customer performs a rewardable event or send customer data to use in your Friendbuy-managed loyalty/rewards program.
13
13
14
14
If you're using Segment with a Friendbuy referral program you probably want to use the [web destination](/docs/connections/destinations/catalog/actions-friendbuy/) to configure the Friendbuy JavaScript and to send customer and purchase data directly to Friendbuy as the user interacts with your web site. However, if you also want to send events from your data center to Friendbuy, such as purchases due to recurring transactions, you should also use this cloud mode [destination action](/docs/connections/destinations/actions/), which provides an interface between Segment's identify and track calls and Friendbuy's MAPI (merchant API).
15
15
16
16
## Overview
17
17
18
-
The Friendbuy cloud mode destination sends information about your customers and their actions to Friendbuy. It supports the following [Friendbuy MAPI events](https://developers.friendbuy.com/#tracking-events){:target='_blank'}.
18
+
The Friendbuy cloud mode destination sends information about your customers and their actions to Friendbuy. It supports the following [Friendbuy MAPI events](https://developers.friendbuy.com/#tracking-events){:target="_blank"}.
19
19
20
20
-**Track Customer**: Converts Segment [Identify](/docs/connections/spec/identify/) calls to Friendbuy [*track customer* MAPI calls](https://developers.friendbuy.com/#tracking-customer-details){:target="_blank”}. Use this to add your customer ID and other customer data to the information that Friendbuy has about the customer.
21
21
-**Track Purchase**: Converts Segment [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) calls to Friendbuy [*track purchase* MAPI calls](https://developers.friendbuy.com/#tracking-a-purchase){:target="_blank”}. Use this to send purchase data to Friendbuy and reward advocates based on their friends' purchases.
@@ -85,7 +85,7 @@ For example, if your *Track Purchase* call has the default *Custom Attributes* v
85
85
}
86
86
```
87
87
88
-
then the [Friendbuy MAPI purchase call](https://developers.friendbuy.com/#postpurchaseevent){:target='_blank'} will be:
88
+
then the [Friendbuy MAPI purchase call](https://developers.friendbuy.com/#postpurchaseevent){:target="_blank"} will be:
89
89
90
90
```json
91
91
{
@@ -117,7 +117,7 @@ To configure a custom event:
117
117
118
118
4.*Event Properties* is set from the path `properties` by default, which means that all the properties that you include in your Segment `analytics.track` call are passed to Friendbuy. If you only want to pass custom attributes to Friendbuy, you need to segregate the fields to pass to Friendbuy into an object and then specify the path to that object, similar to what is described above in [Custom Attributes](#custom-attributes).
119
119
120
-
5. To prevent an event that is tracked multiple times from being rewarded more than once, you should include a deduplication ID in your event as described in Friendbuy's [Track Custom Event documentation](https://developers.friendbuy.com/#tracking-a-custom-event){:target='_blank'}. You can either pass an explicit Event ID field in your event (defaulting to the `deduplicationId` property) or you can create the Event ID out of other event properties (such as the `userId`, a `.`, and the `properties.downloadId` in the above example).
120
+
5. To prevent an event that is tracked multiple times from being rewarded more than once, you should include a deduplication ID in your event as described in Friendbuy's [Track Custom Event documentation](https://developers.friendbuy.com/#tracking-a-custom-event){:target="_blank"}. You can either pass an explicit Event ID field in your event (defaulting to the `deduplicationId` property) or you can create the Event ID out of other event properties (such as the `userId`, a `.`, and the `properties.downloadId` in the above example).
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-friendbuy/index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ id: 6170a348128093cd0245e0ea
9
9
10
10
{% include content/plan-grid.md name="actions" %}
11
11
12
-
[Friendbuy](https://www.friendbuy.com/){:target='_blank'} is a referral marketing platform.
12
+
[Friendbuy](https://www.friendbuy.com/){:target="_blank"} is a referral marketing platform.
13
13
14
14
Friendbuy's web mode Segment integration allows you to enable your Friendbuy referral program through Segment's dashboard instead of adding Friendbuy's JavaScript directly to your site.
15
15
@@ -20,7 +20,7 @@ This Segment integration is a web mode [destination action](/docs/connections/de
20
20
21
21
## Overview
22
22
23
-
The Friendbuy web mode destination sends information about your customers and their actions to Friendbuy. It supports the following [Friendbuy tracking events](https://developers.friendbuy.com/#tracking-events){:target='_blank'}.
23
+
The Friendbuy web mode destination sends information about your customers and their actions to Friendbuy. It supports the following [Friendbuy tracking events](https://developers.friendbuy.com/#tracking-events){:target="_blank"}.
24
24
25
25
-**Track Customer**: Converts Segment [`analytics.identify`](/docs/connections/spec/identify/) calls to Friendbuy *track customer* calls. Use this to add your customer ID and other customer data to the information that Friendbuy has about the customer.
26
26
-**Track Purchase**: Converts Segment [`analytics.track('Order Completed')`](/docs/connections/spec/ecommerce/v2/#order-completed) calls to Friendbuy *track purchase* calls. Use this to send purchase data to Friendbuy and reward advocates based on their friends' purchases.
@@ -39,7 +39,7 @@ Friendbuy Web Mode (Actions) is the Segment web mode destination that works with
39
39
40
40
Before you start, you must have Segment's Analytics.js 2.0 installed on your site. See [Segment's documentation](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/) for instructions.
41
41
42
-
1. Find your Friendbuy Merchant ID, a unique [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier){:target='_blank'} that Friendbuy uses to identify your account. [Log in to your Friendbuy account](https://retailer.friendbuy.io/){:target='_blank'} and visit the **Developer Center** > **Friendbuy Code** page to locate your Merchant ID.
42
+
1. Find your Friendbuy Merchant ID, a unique [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier){:target="_blank"} that Friendbuy uses to identify your account. [Log in to your Friendbuy account](https://retailer.friendbuy.io/){:target="_blank"} and visit the **Developer Center** > **Friendbuy Code** page to locate your Merchant ID.
43
43
2. From the Segment web app, click **Catalog**, then click **Destinations**.
44
44
3. Filter the destinations on Friendbuy in the Catalog and select **Friendbuy Web Device Mode (Actions)**. Click **Configure Friendbuy Web Device Mode (Actions)** to configure the Friendbuy destination, and choose which of your sources to connect the destination to.
45
45
4. Give the destination a name, and fill in the settings manually.
then the [Friendbuy track purchase call](https://developers.friendbuy.com/#purchase-event){:target='_blank'} will be:
89
+
then the [Friendbuy track purchase call](https://developers.friendbuy.com/#purchase-event){:target="_blank"} will be:
90
90
91
91
```javascript
92
92
friendbuyAPI.push(["track", "purchase", {
@@ -114,7 +114,7 @@ To configure a custom event:
114
114
115
115
4.*Event Properties* is set from the path `properties` by default, which means that all the properties that you include in your Segment `analytics.track` call are passed to Friendbuy. If you only want to pass custom attributes to Friendbuy, you need to segregate the fields to pass to Friendbuy into an object and then specify the path to that object, similar to what is described above in [Custom Attributes](#custom-attributes).
116
116
117
-
5. To prevent an event that is tracked multiple times from being rewarded more than once, you should include a deduplication ID in your event as described in Friendbuy's [Track Custom Event documentation](https://developers.friendbuy.com/#custom-event){:target='_blank'}. You can either pass an explicit Event ID field in your event (defaulting to the `deduplicationId` property) or you can create the Event ID out of other event properties (such as the `userId`, a `.`, and the `properties.downloadId` in the above example).
117
+
5. To prevent an event that is tracked multiple times from being rewarded more than once, you should include a deduplication ID in your event as described in Friendbuy's [Track Custom Event documentation](https://developers.friendbuy.com/#custom-event){:target="_blank"}. You can either pass an explicit Event ID field in your event (defaulting to the `deduplicationId` property) or you can create the Event ID out of other event properties (such as the `userId`, a `.`, and the `properties.downloadId` in the above example).
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-google-analytics-4-web/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
@@ -19,15 +19,15 @@ When you have Segment installed, you can use your existing Analytics 2.0 trackin
19
19
20
20
## Getting started
21
21
22
-
Before you connect Segment to Google Analytics 4, configure a Google Analytics 4 property in your Analytics account and enable any Custom Definitions in your GA4 Admin Panel. For more information, see Google's article [Set up Analytics for a website and/or app](https://support.google.com/analytics/answer/9304153){:target='_blank'}.
22
+
Before you connect Segment to Google Analytics 4, configure a Google Analytics 4 property in your Analytics account and enable any Custom Definitions in your GA4 Admin Panel. For more information, see Google's article [Set up Analytics for a website and/or app](https://support.google.com/analytics/answer/9304153){:target="_blank"}.
23
23
24
24
To connect the Google Analytics 4 Web destination:
25
25
26
26
1. From the Segment web app, click **Catalog**, then click **Destinations**.
27
27
2. Search for “Google Analytics 4 Web” in the Destinations Catalog, and select the destination.
28
28
3. Click **Configure Google Analytics 4 Web**.
29
29
4. Select the web source that will send data to Google Analytics 4 and follow the steps to name your destination. The web source chosen must use [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/). For mobile source tracking, view the [Firebase Destination](/docs/connections/destinations/catalog/firebase/).
30
-
5. On the **Settings** tab, under **Basic Settings**, enter in the [Measurement ID](https://support.google.com/analytics/answer/9539598){:target='_blank'} associated with your GA4 web stream.
30
+
5. On the **Settings** tab, under **Basic Settings**, enter in the [Measurement ID](https://support.google.com/analytics/answer/9539598){:target="_blank"} associated with your GA4 web stream.
31
31
6. Set up your event mappings by following the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
32
32
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.
33
33
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.
0 commit comments