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.
0 commit comments