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: docs/realtime/overview.mdx
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,7 @@ import RealtimeExamplesCards from "/snippets/realtime-examples-cards.mdx";
8
8
9
9
Trigger.dev Realtime allows you to trigger, subscribe to, and get real-time updates for runs. This is useful for monitoring runs, updating UIs, and building real-time dashboards.
10
10
11
-
## What you can do with Realtime
12
-
13
-
Subscribe to real-time updates for different scopes of runs:
11
+
You can subscribe to real-time updates for different scopes of runs:
14
12
15
13
-**Specific runs** - Monitor individual run progress by run ID
16
14
-**Runs with specific tags** - Track all runs that have certain [tags](/tags) (e.g., all runs tagged with `user:123`)
@@ -20,21 +18,21 @@ Subscribe to real-time updates for different scopes of runs:
20
18
Once subscribed, you'll receive the complete [run object](/realtime/run-object) with automatic real-time updates whenever the [run changes](/realtime/how-it-works#run-changes), including:
21
19
22
20
-**Status changes** - queued → executing → completed, etc.
23
-
-**Metadata updates** - Custom progress tracking, status updates, user data, etc. ([React hooks](/realtime/react-hooks/subscribe#using-metadata) | [backend](/realtime/backend/metadata))
21
+
-**Metadata updates** - Custom progress tracking, status updates, user data, etc. ([React hooks](/realtime/react-hooks/subscribe#using-metadata-to-show-progress-in-your-ui) | [backend](/realtime/backend/subscribe#subscribe-to-metadata-updates-from-your-tasks))
24
22
-**Tag changes** - When [tags](/tags) are added or removed from the run
25
23
-**Stream data** - Real-time data chunks from your tasks, perfect for AI/LLM streaming ([React hooks](/realtime/react-hooks/streams) | [backend](/realtime/backend/streams))
26
24
27
-
## Authentication
25
+
## Using Realtime in your applications
28
26
29
-
All Realtime subscriptions require authentication so you can securely trigger and subscribe to runs. See our [authentication guide](/realtime/auth) for more details.
27
+
### Authentication
30
28
31
-
##Realtime approaches
29
+
All Realtime subscriptions require authentication so you can securely trigger and subscribe to runs. See our [authentication guide](/realtime/auth) for more details.
32
30
33
31
### Frontend implementation
34
32
35
33
Use our React hooks to build real-time UIs that update as runs execute. Ideal for progress bars, status indicators, and live dashboards.
0 commit comments