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/backend/subscribe.mdx
+1-97Lines changed: 1 addition & 97 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -192,7 +192,7 @@ async function monitorProgress(runId: string) {
192
192
}
193
193
```
194
194
195
-
For more information on how to write tasks that use the metadata API, see our [run metadata docs](/runs/metadata).
195
+
For more information on how to write tasks that use the metadata API, as well as more examples, see our [run metadata docs](/runs/metadata#more-metadata-task-examples).
196
196
197
197
### Type safety
198
198
@@ -223,99 +223,3 @@ async function monitorTypedProgress(runId: string) {
Copy file name to clipboardExpand all lines: docs/realtime/overview.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,13 +8,9 @@ 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
-
## Authentication
12
-
13
-
All Realtime subscriptions require authentication so you can securely trigger and subscribe to runs. See our [authentication guide](/realtime/auth) for more details.
14
-
15
11
## What you can do with Realtime
16
12
17
-
You can subscribe to real-time updates for different scopes of runs:
13
+
Subscribe to real-time updates for different scopes of runs:
18
14
19
15
-**Specific runs** - Monitor individual run progress by run ID
20
16
-**Runs with specific tags** - Track all runs that have certain [tags](/tags) (e.g., all runs tagged with `user:123`)
@@ -28,6 +24,10 @@ Once subscribed, you'll receive the complete [run object](/realtime/run-object)
28
24
-**Tag changes** - When [tags](/tags) are added or removed from the run
29
25
-**Stream data** - Real-time data chunks from your tasks, perfect for AI/LLM streaming ([React hooks](/realtime/react-hooks/streams) | [backend](/realtime/backend/streams))
30
26
27
+
## Authentication
28
+
29
+
All Realtime subscriptions require authentication so you can securely trigger and subscribe to runs. See our [authentication guide](/realtime/auth) for more details.
See our [Realtime documentation](/realtime) for more information.
198
198
199
-
## Using Metadata
199
+
## Using metadata to show progress in your UI
200
200
201
201
All realtime hooks automatically include metadata updates. Whenever your task updates metadata using `metadata.set()`, `metadata.append()`, or other metadata methods, your component will re-render with the updated data.
202
202
203
-
<Note>
204
-
To learn how to write tasks with metadata updates, see our [writing tasks using
205
-
metadata](/runs/metadata) guide.
206
-
</Note>
203
+
<Note>To learn how to write tasks using metadata, see our [metadata](/runs/metadata) guide.</Note>
Copy file name to clipboardExpand all lines: docs/runs/metadata.mdx
+98Lines changed: 98 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -514,6 +514,104 @@ Combined with [Realtime](/realtime), you could use this to show a live progress
514
514
height="100%"
515
515
/>
516
516
517
+
## More metadata task examples
518
+
519
+
Using metadata updates in conjunction with our [Realtime React hooks](/realtime/react-hooks/overview) can be a powerful way to build real-time UIs. Here are some example tasks demonstrating how to use metadata in your tasks to track progress, status, and more:
0 commit comments