Skip to content

Commit 151ae1f

Browse files
authored
Enhance documentation on signal conversion and rules
Updated the configuration documentation to clarify the process of converting signals to events and rule creation in Segment.
1 parent a56df1d commit 151ae1f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

src/connections/auto-instrumentation/configuration.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ This guide assumes that you've already added the Signals SDK to your application
1717

1818
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.
1919

20+
The process is:
21+
1. Send signals into the app
22+
2. Build event rules from those signals
23+
3. Publish those event rules
24+
25+
Once your event rules are published they will be analyzed against user behavior on your website or app and send events to Segment when users perform the interaction triggers.
26+
2027
### Getting started with rule creation
2128

2229
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 +54,11 @@ You can enrich your events by adding properties based on signal metadata. For ex
4754

4855
These properties are sent alongside your event, giving your team deeper insights without requiring any manual instrumentation.
4956

57+
<!-- PW, 6 August 2025: Commenting this section out for now
5058
#### Preview your event rule
5159
5260
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.
5361
54-
55-
<!-- PW, 6 August 2025: Commenting this section out for now
56-
5762
The Rules Editor also lets you test your rules with recent signals to verify that they produce the data you need before you deploy.
5863
5964
The following example tracks all Screen events:

0 commit comments

Comments
 (0)