Skip to content

Enhance documentation on signal conversion and rules #8034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 15, 2025
Merged

Enhance documentation on signal conversion and rules #8034

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
151ae1f
Enhance documentation on signal conversion and rules
maxmilhan Oct 13, 2025
fe75dd7
minor rewording
pwseg Oct 15, 2025
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
12 changes: 9 additions & 3 deletions src/connections/auto-instrumentation/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ This guide assumes that you've already added the Signals SDK to your application

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.

The process works like this:

1. The SDK sends raw signals from your app or website to Segment.
2. You build event rules in your workspace that define how those signals should become analytics events.
3. You publish the event rules.

After publishing, Segment analyzes user interactions in your app or website against these rules and automatically generates analytics events when matching interactions occur.

### Getting started with rule creation

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.
Expand Down Expand Up @@ -47,13 +55,11 @@ You can enrich your events by adding properties based on signal metadata. For ex

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

<!-- PW, 6 August 2025: Commenting this section out for now
#### Preview your event rule

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.


<!-- PW, 6 August 2025: Commenting this section out for now

The Rules Editor also lets you test your rules with recent signals to verify that they produce the data you need before you deploy.

The following example tracks all Screen events:
Expand Down
Loading