Skip to content

Commit 70b0b8f

Browse files
committed
add section explaining signals and how they relate to events
1 parent e6e370f commit 70b0b8f

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed
Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,40 @@
11
---
22
title: Auto-Instrumentation Event Builder
33
hidden: true
4-
---
4+
---
5+
6+
The Event Builder provides a no-code way to define analytics events based on signals collected by Auto-Instrumentation.
7+
8+
You can use it to create Track, Identify, Page, and other event types directly from your Segment workspace.
9+
10+
> info "Auto-Instrumentation Private Beta"
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+
13+
## Access the Event Builder
14+
15+
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. If you've installed the SDK but still don't see the Event Builder tab, reach out to your Segment account manager to verify your workspace is included in the Auto-Instrumentation Private Beta.
16+
17+
> info "Event Builder during Private Beta"
18+
> During Private Beta beta, both the Event Builder and the legacy Auto-Instrumentation tab appear in the navigation. Segment will remove the legacy tab once all customers have migrated to the Event Builder experience.
19+
20+
## Generate activity
21+
22+
To see activity in the Event Builder, you need to trigger signals using a custom debug link that Segment provides:
23+
24+
1. In the Event Builder, copy the custom URL shown at the top of the page.
25+
2. Open your website or app using that URL in a browser or mobile device.
26+
3. Try out some typical user actions (like clicking buttons, navigate screens, and triggering network calls).
27+
28+
Segment collects and displays activity as signals. These signals are grouped into types, like:
29+
30+
- Interaction: clicks, taps, and UI interactions.
31+
- Navigation: screen changes and page transitions
32+
- Network: requests and responses
33+
- `LocalData`, Instrumentation, and `UserDefined`: additional signal types from the SDK.
34+
35+
### How signals relate to events
36+
37+
Segment separates signal collection from event creation. Signals represent raw user interactions, like a button click or screen view. Events, on the other hand, are analytics calls you define based on those signals. This two-step process lets you observe user behavior first, and then decide how and when to turn that behavior into structured analytics events, without needing to modify your code.
38+
39+
Signal detection is active for 24 hours after you generate activity. Detected signals are available in the Event Builder for 72 hours.
40+

0 commit comments

Comments
 (0)