github-featured/triggerdotdev--trigger.dev
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity
Files
b7ef51d763ee9422eb17810601236dddcfff79e9
triggerdotdev--trigger.dev/docs
T
History
Eric Allam 911a1cff80 docs: document the Sessions HTTP API (reference, channels, scopes) (#3942) 
## Summary

Documents the Sessions HTTP API for non-SDK and server-to-server
callers, which until now appeared only in the conceptual
[ai-chat/sessions](https://trigger.dev/docs/ai-chat/sessions) page.

## What's covered

- **Sessions API reference** —
`create`/`list`/`retrieve`/`update`/`close` added to the OpenAPI spec
and a new "Sessions API" group (`management/sessions/*`), mirroring the
Runs API.
- **Channel endpoints** — a reference page for the `.in`/`.out` realtime
HTTP endpoints (append, SSE read, records drain), the wire protocol,
`Last-Event-ID` resume, and the per-direction auth boundary (`.out`
append is secret-key only).
- **Session scopes** — `read:sessions:{id}` / `write:sessions:{id}` in
the authentication docs, with the capability boundary and the 1h token
TTL.

Cross-linked with the SDK-side `ai-chat/sessions` page. Verified by
rendering each page on the Mintlify dev server.
2026-06-14 21:07:12 +01:00
..
ai
docs(ai-chat): AI Agents documentation for v4.5 (#3226)
2026-05-21 16:50:59 +01:00
ai-chat
docs: document the Sessions HTTP API (reference, channels, scopes) (#3942)
2026-06-14 21:07:12 +01:00
config
docs: troubleshooting and additional packages version pinning (#3092)
2026-04-14 15:11:06 +01:00
deployment
docs(management): document TriggerClient for multi-target SDK usage (#3694)
2026-06-12 17:08:04 +01:00
guides
docs(bun): note WebSocket limitation with remote browser connections (#3537)
2026-05-08 17:25:28 +01:00
images
docs(private links): refresh PrivateLink setup screenshots, add ElastiCache IP-finding tip and NLB inbound-rules step (#3517)
2026-05-04 16:33:56 +02:00
logo
Adding docs back into this repo
2023-08-02 15:09:35 +01:00
management
docs: document the Sessions HTTP API (reference, channels, scopes) (#3942)
2026-06-14 21:07:12 +01:00
observability
docs(cli): Expand and improve the MCP server and dev CLI command (#3225)
2026-04-13 14:27:45 +01:00
private-networking
docs(private links): refresh PrivateLink setup screenshots, add ElastiCache IP-finding tip and NLB inbound-rules step (#3517)
2026-05-04 16:33:56 +02:00
realtime
docs(ai-chat): AI Agents documentation for v4.5 (#3226)
2026-05-21 16:50:59 +01:00
runs
docs: Fixes and realtime improvements (#3265)
2026-03-25 15:28:41 +00:00
self-hosting
perf(webapp): parallelize streaming batch-item ingest (#3777)
2026-06-12 13:01:29 +01:00
snippets
docs(ai-chat): AI Agents documentation for v4.5 (#3226)
2026-05-21 16:50:59 +01:00
tasks
docs: troubleshoot "Stream is being deleted" during long waits (#3704)
2026-05-27 12:17:21 -04:00
.gitignore
Adding docs back into this repo
2023-08-02 15:09:35 +01:00
apikeys.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
batch-queue-metrics.md
feat(engine): Batch trigger reloaded (#2779)
2025-12-16 14:32:49 +00:00
batch-queue-stress-test-plan.md
chore(docs): upgrade for new batch trigger limits and functionality (#2787)
2025-12-22 15:35:43 +00:00
building-with-ai.mdx
docs: document the trigger skills installer (replaces agent rules) (#3871)
2026-06-12 17:08:20 +01:00
bulk-actions.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
changelog.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
CLAUDE.md
chore(claude): Improve claude code instructions (#3161)
2026-03-02 12:42:05 +00:00
cli-deploy-commands.mdx
docs: improve deployment docs and add atomic deploy guide (#1748)
2025-03-04 12:00:06 +00:00
cli-deploy.mdx
Updated deploy docs
2024-10-31 09:49:59 +00:00
cli-dev-commands.mdx
v3: docs improvements (#1302)
2024-09-17 11:40:25 +01:00
cli-dev.mdx
Docs/more improvements (#1292)
2024-09-11 17:14:39 +01:00
cli-development-commands.mdx
Docs/more improvements (#1292)
2024-09-11 17:14:39 +01:00
cli-init-commands.mdx
v3: docs improvements (#1302)
2024-09-17 11:40:25 +01:00
cli-introduction.mdx
v3: docs improvements (#1302)
2024-09-17 11:40:25 +01:00
cli-list-profiles-commands.mdx
v3: docs improvements (#1302)
2024-09-17 11:40:25 +01:00
cli-login-commands.mdx
v3: docs improvements (#1302)
2024-09-17 11:40:25 +01:00
cli-logout-commands.mdx
v3: docs improvements (#1302)
2024-09-17 11:40:25 +01:00
cli-preview-archive.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
cli-promote-commands.mdx
docs: improve deployment docs and add atomic deploy guide (#1748)
2025-03-04 12:00:06 +00:00
cli-switch.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
cli-update-commands.mdx
v3: docs improvements (#1302)
2024-09-17 11:40:25 +01:00
cli-whoami-commands.mdx
v3: docs improvements (#1302)
2024-09-17 11:40:25 +01:00
community.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
compute-private-beta.mdx
docs: refresh compute private beta page with may 1 updates (#3502)
2026-05-01 17:32:13 +01:00
context.mdx
feat: add isReplay to run context (#3454)
2026-04-28 11:57:44 +02:00
database-connections.mdx
docs: add a database connections guide for tasks (#3881)
2026-06-09 22:24:51 +01:00
deploy-environment-variables.mdx
docs: document secret env vars and Vercel sync behavior (#3419)
2026-04-20 13:19:33 -04:00
docs.json
docs: document the Sessions HTTP API (reference, channels, scopes) (#3942)
2026-06-14 21:07:12 +01:00
errors-retrying.mdx
docs: Fixes and realtime improvements (#3265)
2026-03-25 15:28:41 +00:00
examples.mdx
Added guides and examples links and snippet
2025-02-03 14:30:03 +00:00
github-actions.mdx
docs: heartbeats, Bun version, troubleshooting, and preview-branch cleanup (#3026)
2026-02-10 21:53:41 +00:00
github-integration.mdx
docs(build-server): adjust build env vars section (#2605)
2025-10-14 17:29:42 +02:00
github-repo.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
help-email.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
help-slack.mdx
docs: clarify slack channel on pro (#2731)
2025-12-03 13:23:38 +00:00
hidden-tasks.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
how-it-works.mdx
chore(docs): Admin requirements for creating worker groups (#2925)
2026-01-24 09:00:50 +00:00
how-to-reduce-your-spend.mdx
Document spike alerts feature (#2844)
2026-01-07 16:40:04 +00:00
idempotency.mdx
fix(core): cap idempotencyKey length at the API boundary (#3560)
2026-05-14 13:24:50 +01:00
introduction.mdx
Add building with ai/skills pages and updated intro (#2962)
2026-01-29 13:55:43 +00:00
known-issues.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
limits.mdx
docs: update batch trigger concurrency limits (#3171)
2026-03-04 11:50:59 +00:00
logging.mdx
Fix(webapp): change "metrics" to "dashboard" (#3136)
2026-02-26 16:56:07 +00:00
machines.mdx
feat(engine): Improve execution stalls troubleshooting, align dev and prod behavior, adding heartbeats.yield utility (#2489)
2025-09-12 14:54:39 +01:00
manual-setup.mdx
feat(docs): update prismaExtension for new mode functionality in 4.1.1 (#2690)
2025-11-19 11:16:35 +00:00
mcp-agent-rules.mdx
docs: document the trigger skills installer (replaces agent rules) (#3871)
2026-06-12 17:08:20 +01:00
mcp-introduction.mdx
docs: document the trigger skills installer (replaces agent rules) (#3871)
2026-06-12 17:08:20 +01:00
mcp-tools.mdx
docs(ai-chat): AI Agents documentation for v4.5 (#3226)
2026-05-21 16:50:59 +01:00
migrating-from-v3.mdx
docs(ai-chat): AI Agents documentation for v4.5 (#3226)
2026-05-21 16:50:59 +01:00
migration-defer.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
migration-mergent.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
migration-n8n.mdx
docs: add migration guide from n8n to Trigger.dev (#3283)
2026-03-31 17:38:39 -04:00
notifications.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
open-source-contributing.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
open-source-self-hosting.mdx
docs: update email regex examples (#2749)
2025-12-04 17:58:25 +00:00
openapi.yml
chore(docs): upgrade for new batch trigger limits and functionality (#2787)
2025-12-22 15:35:43 +00:00
package.json
Remove packageManager override from docs package.json
2024-08-28 10:39:34 +01:00
queue-concurrency.mdx
Add Queue Management API endpoints and SDK documentation (#3087)
2026-02-18 22:35:39 +00:00
quick-start.mdx
docs: Fixes and realtime improvements (#3265)
2026-03-25 15:28:41 +00:00
README.md
Updated docs README.md
2023-10-02 14:26:54 +01:00
replaying.mdx
feat: add isReplay to run context (#3454)
2026-04-28 11:57:44 +02:00
request-feature.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
roadmap.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
run-tests.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
run-usage.mdx
docs: usage function examples were missing the imports (#2830)
2026-02-04 14:05:59 +00:00
runs.mdx
docs: add task-level and config-level TTL documentation (#3200)
2026-04-13 14:23:24 +01:00
skills.mdx
docs: document the trigger skills installer (replaces agent rules) (#3871)
2026-06-12 17:08:20 +01:00
style.css
Added Trigger.dark theme to the docs (#2967)
2026-01-29 13:59:27 +00:00
tags.mdx
Docs: tags can be up to 128 chars (#2678)
2025-11-13 14:43:31 +00:00
tasks-regular.mdx
GitHub workflow improvements (#1306)
2024-09-23 15:14:34 +01:00
triggering.mdx
docs(management): document TriggerClient for multi-target SDK usage (#3694)
2026-06-12 17:08:04 +01:00
troubleshooting-alerts.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
troubleshooting-debugging-in-vscode.mdx
Docs/more docs improvements (#1718)
2025-02-19 16:06:42 +00:00
troubleshooting-github-issues.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
troubleshooting-uptime-status.mdx
Remove v2 docs pages (#1246)
2024-08-07 11:13:45 +01:00
troubleshooting.mdx
fix(cli): fail attempt on uncaught exception instead of hanging to maxDuration (TRI-9117) (#3529)
2026-05-06 19:35:43 +01:00
upgrading-beta.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
upgrading-packages.mdx
Fixes #1337 - update docs for triggerdev -> trigger bin name change
2024-09-20 16:12:14 +01:00
v3-openapi.yaml
docs: document the Sessions HTTP API (reference, channels, scopes) (#3942)
2026-06-14 21:07:12 +01:00
vercel-integration.mdx
docs: document secret env vars and Vercel sync behavior (#3419)
2026-04-20 13:19:33 -04:00
versioning.mdx
chore(docs): Add clarifications for delay semantics and payload handling (#2928)
2026-01-24 08:59:55 +00:00
video-walkthrough.mdx
Restructured the realtime docs (#2317)
2025-08-07 16:02:52 +01:00
wait-for-token.mdx
docs: add list deployments endpoint, fix defaultMachine, and clarify wait token browser completion (#3350)
2026-04-14 15:08:33 +01:00
wait-for.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
wait-until.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00
wait.mdx
docs: realtime input streams (#3153)
2026-03-04 09:55:54 +00:00
writing-tasks-introduction.mdx
Docs – v4 GA updates (#2298)
2025-08-18 12:34:55 +01:00

README.md

Development

Install and initial setup

pnpm install

Running the app

pnpm run dev --filter docs

View the app locally

It runs locally here: http://localhost:3050

Reference in New Issue View Git Blame Copy Permalink