{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Trigger.dev",
  "description": "Trigger.dev is an open source background jobs framework that lets you write reliable workflows in plain async code. Run long-running AI tasks, handle complex background jobs, and build AI agents with built-in queuing, automatic retries, and real-time monitoring. No timeouts, elastic scaling, and zero infrastructure management required.",
  "colors": {
    "primary": "#A8FF53",
    "light": "#A8FF53",
    "dark": "#A8FF53"
  },
  "favicon": "/images/favicon.png",
  "contextual": {
    "options": ["copy", "view", "claude"]
  },
  "navigation": {
    "dropdowns": [
      {
        "dropdown": "Documentation",
        "description": "Resources for Trigger.dev",
        "icon": "book-open",
        "groups": [
          {
            "group": "Getting started",
            "pages": [
              "introduction",
              "quick-start",
              "manual-setup",
              "video-walkthrough",
              "how-it-works",
              "limits",
              "migrating-from-v3"
            ]
          },
          {
            "group": "Fundamentals",
            "pages": [
              {
                "group": "Tasks",
                "pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
              },
              "triggering",
              "runs",
              "apikeys"
            ]
          },
          {
            "group": "Building with AI",
            "pages": [
              "building-with-ai",
              {
                "group": "MCP Server",
                "pages": ["mcp-introduction", "mcp-tools"]
              },
              "skills",
              "mcp-agent-rules"
            ]
          },
          {
            "group": "Writing tasks",
            "pages": [
              "writing-tasks-introduction",
              "logging",
              "errors-retrying",
              {
                "group": "Wait",
                "pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
              },
              "queue-concurrency",
              "versioning",
              "machines",
              "idempotency",
              "runs/max-duration",
              "runs/heartbeats",
              "tags",
              "runs/metadata",
              "tasks/streams",
              "run-usage",
              "context",
              "runs/priority",
              "hidden-tasks",
              "runs/bulk-actions"
            ]
          },
          {
            "group": "Agents",
            "pages": [
              "ai-chat/overview",
              "ai-chat/quick-start",
              {
                "group": "Building agents",
                "pages": [
                  "ai-chat/anatomy",
                  "ai-chat/backend",
                  "ai-chat/lifecycle-hooks",
                  "ai-chat/tools",
                  "ai-chat/frontend",
                  "ai-chat/server-chat",
                  "ai-chat/sessions",
                  "ai-chat/chat-local",
                  "ai-chat/types",
                  "ai-chat/custom-agents",
                  "ai-chat/how-it-works"
                ]
              },
              {
                "group": "Features",
                "pages": [
                  "ai/prompts",
                  "ai-chat/fast-starts",
                  "ai-chat/compaction",
                  "ai-chat/prompt-caching",
                  "ai-chat/pending-messages",
                  "ai-chat/background-injection",
                  "ai-chat/actions",
                  "ai-chat/error-handling"
                ]
              },
              {
                "group": "Patterns",
                "pages": [
                  "ai-chat/patterns/sub-agents",
                  "ai-chat/patterns/version-upgrades",
                  "ai-chat/patterns/database-persistence",
                  "ai-chat/patterns/persistence-and-replay",
                  "ai-chat/patterns/branching-conversations",
                  "ai-chat/patterns/code-sandbox",
                  "ai-chat/patterns/human-in-the-loop",
                  "ai-chat/patterns/tool-result-auditing",
                  "ai-chat/patterns/large-payloads",
                  "ai-chat/patterns/skills",
                  "ai-chat/patterns/oom-resilience",
                  "ai-chat/patterns/recovery-boot",
                  "ai-chat/patterns/trusted-edge-signals"
                ]
              },
              {
                "group": "Reference",
                "pages": [
                  "ai-chat/reference",
                  "ai-chat/client-protocol",
                  "ai-chat/testing",
                  "ai-chat/mcp",
                  "ai-chat/upgrade-guide",
                  "ai-chat/changelog"
                ]
              }
            ]
          },
          {
            "group": "Configuration",
            "pages": [
              "config/config-file",
              {
                "group": "Build extensions",
                "pages": [
                  "config/extensions/overview",
                  {
                    "group": "Built-in extensions",
                    "pages": [
                      "config/extensions/prismaExtension",
                      "config/extensions/pythonExtension",
                      "config/extensions/playwright",
                      "config/extensions/puppeteer",
                      "config/extensions/lightpanda",
                      "config/extensions/ffmpeg",
                      "config/extensions/aptGet",
                      "config/extensions/additionalFiles",
                      "config/extensions/additionalPackages",
                      "config/extensions/syncEnvVars",
                      "config/extensions/esbuildPlugin",
                      "config/extensions/emitDecoratorMetadata",
                      "config/extensions/audioWaveform"
                    ]
                  },
                  "config/extensions/custom"
                ]
              }
            ]
          },
          {
            "group": "Deployment",
            "pages": [
              "deployment/overview",
              "deploy-environment-variables",
              "github-actions",
              "deployment/preview-branches",
              "deployment/dev-branches",
              "deployment/atomic-deployment",
              {
                "group": "Deployment integrations",
                "pages": ["github-integration", "vercel-integration"]
              }
            ]
          },
          {
            "group": "Private networking",
            "pages": [
              "private-networking/overview",
              "private-networking/aws-console-setup",
              "private-networking/troubleshooting"
            ]
          },
          {
            "group": "Realtime",
            "pages": [
              "realtime/overview",
              "realtime/how-it-works",
              "realtime/run-object",
              "realtime/auth",
              {
                "group": "React hooks",
                "pages": [
                  "realtime/react-hooks/overview",
                  "realtime/react-hooks/triggering",
                  "realtime/react-hooks/subscribe",
                  "realtime/react-hooks/streams",
                  "realtime/react-hooks/swr",
                  "realtime/react-hooks/use-wait-token"
                ]
              },
              {
                "group": "Backend",
                "pages": [
                  "realtime/backend/overview",
                  "realtime/backend/subscribe",
                  "realtime/backend/streams"
                ]
              }
            ]
          },
          {
            "group": "CLI",
            "pages": [
              "cli-introduction",
              {
                "group": "Commands",
                "pages": [
                  "cli-deploy-commands",
                  "cli-dev-commands",
                  "cli-init-commands",
                  "cli-list-profiles-commands",
                  "cli-login-commands",
                  "cli-logout-commands",
                  "cli-preview-archive",
                  "cli-promote-commands",
                  "cli-switch",
                  "cli-update-commands",
                  "cli-whoami-commands"
                ]
              }
            ]
          },
          {
            "group": "Observability",
            "pages": ["observability/query", "observability/dashboards"]
          },
          {
            "group": "Using the Dashboard",
            "pages": [
              "run-tests",
              "troubleshooting-alerts",
              "billing-limits",
              "replaying",
              "bulk-actions"
            ]
          },
          {
            "group": "Troubleshooting",
            "pages": [
              "troubleshooting",
              "database-connections",
              "how-to-reduce-your-spend",
              "troubleshooting-debugging-in-vscode",
              "upgrading-packages",
              "troubleshooting-uptime-status",
              "troubleshooting-github-issues",
              "request-feature"
            ]
          },
          {
            "group": "Self-hosting",
            "pages": [
              "self-hosting/overview",
              "self-hosting/docker",
              "self-hosting/kubernetes",
              "self-hosting/security",
              {
                "group": "Environment variables",
                "pages": ["self-hosting/env/webapp", "self-hosting/env/supervisor"]
              }
            ]
          },
          {
            "group": "Open source",
            "pages": ["open-source-contributing", "github-repo", "changelog", "roadmap"]
          },
          {
            "group": "Help",
            "pages": ["community", "help-slack", "help-email"]
          }
        ]
      },
      {
        "dropdown": "API reference",
        "description": "The Trigger.dev API",
        "icon": "code",
        "groups": [
          {
            "group": "API reference",
            "pages": [
              "management/overview",
              "management/authentication",
              "management/multiple-clients",
              "management/errors-and-retries",
              "management/auto-pagination",
              "management/advanced-usage"
            ]
          },
          {
            "group": "Tasks API",
            "pages": [
              "management/tasks/trigger",
              "management/tasks/batch-trigger",
              "management/tasks/trigger-batch"
            ]
          },
          {
            "group": "Batches API",
            "pages": [
              "management/batches/create",
              "management/batches/retrieve",
              "management/batches/retrieve-results",
              "management/batches/stream-items"
            ]
          },
          {
            "group": "Runs API",
            "pages": [
              "management/runs/list",
              "management/runs/retrieve",
              "management/runs/replay",
              "management/runs/cancel",
              "management/runs/reschedule",
              "management/runs/update-metadata",
              "management/runs/add-tags",
              "management/runs/retrieve-events",
              "management/runs/retrieve-trace",
              "management/runs/retrieve-result"
            ]
          },
          {
            "group": "Bulk actions API",
            "pages": [
              "management/bulk-actions/create",
              "management/bulk-actions/list",
              "management/bulk-actions/retrieve",
              "management/bulk-actions/abort"
            ]
          },
          {
            "group": "Errors API",
            "pages": [
              "management/errors/list",
              "management/errors/retrieve",
              "management/errors/resolve",
              "management/errors/ignore",
              "management/errors/unresolve"
            ]
          },
          {
            "group": "Queues API",
            "pages": [
              "management/queues/list",
              "management/queues/retrieve",
              "management/queues/pause",
              "management/queues/concurrency-override",
              "management/queues/concurrency-reset"
            ]
          },
          {
            "group": "Schedules API",
            "pages": [
              "management/schedules/list",
              "management/schedules/create",
              "management/schedules/retrieve",
              "management/schedules/update",
              "management/schedules/delete",
              "management/schedules/deactivate",
              "management/schedules/activate",
              "management/schedules/timezones"
            ]
          },
          {
            "group": "Env Vars API",
            "pages": [
              "management/envvars/list",
              "management/envvars/import",
              "management/envvars/create",
              "management/envvars/retrieve",
              "management/envvars/update",
              "management/envvars/delete"
            ]
          },
          {
            "group": "Deployments API",
            "pages": [
              "management/deployments/list",
              "management/deployments/retrieve",
              "management/deployments/get-latest",
              "management/deployments/promote"
            ]
          },
          {
            "group": "Waitpoints API",
            "pages": [
              "management/waitpoints/create",
              "management/waitpoints/list",
              "management/waitpoints/retrieve",
              "management/waitpoints/complete",
              "management/waitpoints/complete-callback"
            ]
          },
          {
            "group": "Sessions API",
            "pages": [
              "management/sessions/create",
              "management/sessions/list",
              "management/sessions/retrieve",
              "management/sessions/update",
              "management/sessions/close",
              "management/sessions/channels"
            ]
          },
          {
            "group": "Query API",
            "pages": [
              "management/query/execute",
              "management/query/schema",
              "management/query/dashboards"
            ]
          }
        ]
      },
      {
        "dropdown": "Guides & examples",
        "description": "A great way to get started",
        "icon": "books",
        "groups": [
          {
            "group": "Introduction",
            "pages": ["guides/introduction"]
          },
          {
            "group": "Frameworks",
            "pages": [
              "guides/frameworks/bun",
              "guides/frameworks/nextjs",
              "guides/frameworks/nodejs",
              "guides/frameworks/remix",
              "guides/community/sveltekit"
            ]
          },
          {
            "group": "Guides",
            "pages": [
              {
                "group": "AI Agents",
                "icon": {
                  "name": "microchip-ai",
                  "style": "regular"
                },
                "pages": [
                  "guides/ai-agents/overview",
                  "guides/ai-agents/generate-translate-copy",
                  "guides/ai-agents/route-question",
                  "guides/ai-agents/respond-and-check-content",
                  "guides/ai-agents/translate-and-refine",
                  "guides/ai-agents/verify-news-article"
                ]
              },
              "guides/ai-agents/claude-code-trigger",
              "guides/frameworks/drizzle",
              "guides/frameworks/prisma",
              "guides/frameworks/nango",
              "guides/frameworks/sequin",
              {
                "group": "Supabase",
                "icon": {
                  "name": "bolt",
                  "style": "solid"
                },
                "pages": [
                  "guides/frameworks/supabase-guides-overview",
                  "guides/frameworks/supabase-edge-functions-basic",
                  "guides/frameworks/supabase-edge-functions-database-webhooks",
                  "guides/frameworks/supabase-authentication"
                ]
              },
              {
                "group": "Webhooks",
                "icon": {
                  "name": "webhook",
                  "style": "solid"
                },
                "pages": [
                  "guides/frameworks/webhooks-guides-overview",
                  "guides/frameworks/nextjs-webhooks",
                  "guides/frameworks/remix-webhooks",
                  "guides/examples/stripe-webhook",
                  "guides/examples/hookdeck-webhook"
                ]
              }
            ]
          },
          {
            "group": "Migration guides",
            "pages": ["migration-mergent", "migration-n8n"]
          },
          {
            "group": "Use cases",
            "pages": [
              "guides/use-cases/overview",
              "guides/use-cases/data-processing-etl",
              "guides/use-cases/media-generation",
              "guides/use-cases/media-processing",
              "guides/use-cases/marketing"
            ]
          },
          {
            "group": "Example projects",
            "pages": [
              "guides/example-projects/anchor-browser-web-scraper",
              "guides/example-projects/batch-llm-evaluator",
              "guides/example-projects/claude-changelog-generator",
              "guides/example-projects/claude-github-wiki",
              "guides/example-projects/claude-thinking-chatbot",
              "guides/example-projects/clickhouse-chat-agent",
              "guides/example-projects/cursor-background-agent",
              "guides/example-projects/human-in-the-loop-workflow",
              "guides/example-projects/mastra-agents-with-memory",
              "guides/example-projects/meme-generator-human-in-the-loop",
              "guides/example-projects/openai-agents-sdk-typescript-playground",
              "guides/example-projects/product-image-generator",
              "guides/example-projects/realtime-csv-importer",
              "guides/example-projects/realtime-fal-ai",
              "guides/example-projects/smart-spreadsheet",
              "guides/example-projects/turborepo-monorepo-prisma",
              "guides/example-projects/vercel-ai-sdk-deep-research",
              "guides/example-projects/vercel-ai-sdk-image-generator"
            ]
          },
          {
            "group": "Python guides",
            "pages": [
              "guides/example-projects/openai-agent-sdk-guardrails",
              "guides/python/python-image-processing",
              "guides/python/python-doc-to-markdown",
              "guides/python/python-crawl4ai",
              "guides/python/python-pdf-form-extractor"
            ]
          },
          {
            "group": "Example tasks",
            "pages": [
              "guides/examples/dall-e3-generate-image",
              "guides/examples/deepgram-transcribe-audio",
              "guides/examples/fal-ai-image-to-cartoon",
              "guides/examples/fal-ai-realtime",
              "guides/examples/ffmpeg-video-processing",
              "guides/examples/firecrawl-url-crawl",
              "guides/examples/lightpanda",
              "guides/examples/libreoffice-pdf-conversion",
              "guides/examples/open-ai-with-retrying",
              "guides/examples/pdf-to-image",
              "guides/examples/puppeteer",
              "guides/examples/react-pdf",
              "guides/examples/react-email",
              "guides/examples/replicate-image-generation",
              "guides/examples/resend-email-sequence",
              "guides/examples/satori",
              "guides/examples/scrape-hacker-news",
              "guides/examples/sentry-error-tracking",
              "guides/examples/sharp-image-processing",
              "guides/examples/supabase-database-operations",
              "guides/examples/supabase-storage-upload",
              "guides/examples/vercel-ai-sdk",
              "guides/examples/vercel-sync-env-vars"
            ]
          },
          {
            "group": "Community packages",
            "pages": [
              "guides/community/dotenvx",
              "guides/community/fatima",
              "guides/community/rate-limiter",
              "guides/community/sveltekit"
            ]
          }
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo/light.png",
    "dark": "/logo/dark.png",
    "href": "https://trigger.dev"
  },
  "api": {
    "openapi": ["openapi.yml", "v3-openapi.yaml"],
    "playground": {
      "display": "simple"
    }
  },
  "styling": {
    "codeblocks": {
      "theme": "css-variables"
    }
  },
  "appearance": {
    "default": "dark",
    "strict": true
  },
  "background": {
    "color": {
      "light": "#fff",
      "dark": "#121317"
    }
  },
  "navbar": {
    "primary": {
      "type": "github",
      "href": "https://github.com/triggerdotdev/trigger.dev"
    }
  },
  "footer": {
    "socials": {
      "x": "https://twitter.com/triggerdotdev",
      "github": "https://github.com/triggerdotdev",
      "linkedin": "https://www.linkedin.com/company/triggerdotdev"
    },
    "links": [
      {
        "header": "Developers",
        "items": [
          {
            "label": "Changelog",
            "href": "https://trigger.dev/changelog"
          },
          {
            "label": "Contributing",
            "href": "https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md"
          },
          {
            "label": "Open source",
            "href": "https://github.com/triggerdotdev/trigger.dev?tab=Apache-2.0-1-ov-file#readme"
          },
          {
            "label": "GitHub",
            "href": "https://github.com/triggerdotdev/trigger.dev"
          },
          {
            "label": "OSS Friends",
            "href": "https://trigger.dev/oss-friends"
          }
        ]
      },
      {
        "header": "Product",
        "items": [
          {
            "label": "Pricing",
            "href": "https://trigger.dev/pricing"
          },
          {
            "label": "How it works",
            "href": "https://trigger.dev/#how-it-works"
          },
          {
            "label": "Features",
            "href": "https://trigger.dev/product"
          },
          {
            "label": "Roadmap",
            "href": "https://feedback.trigger.dev/roadmap"
          },
          {
            "label": "FAQs",
            "href": "https://trigger.dev/pricing#faqs"
          },
          {
            "label": "Uptime status",
            "href": "https://status.trigger.dev/"
          }
        ]
      },
      {
        "header": "Company",
        "items": [
          {
            "label": "Blog",
            "href": "https://trigger.dev/blog"
          },
          {
            "label": "Contact",
            "href": "https://trigger.dev/contact"
          },
          {
            "label": "Careers",
            "href": "https://trigger.dev/jobs"
          },
          {
            "label": "Privacy",
            "href": "https://trigger.dev/legal/privacy"
          },
          {
            "label": "Terms of service",
            "href": "https://trigger.dev/legal"
          }
        ]
      }
    ]
  },
  "redirects": [
    {
      "source": "/cli-dev",
      "destination": "/cli-dev-commands",
      "permanent": true
    },
    {
      "source": "/cli-deploy",
      "destination": "/cli-deploy-commands",
      "permanent": true
    },
    {
      "source": "/cli-development-commands",
      "destination": "/cli-dev-commands",
      "permanent": true
    },
    {
      "source": "/v3/feature-matrix",
      "destination": "https://feedback.trigger.dev/roadmap"
    },
    {
      "source": "/v3/upgrading-from-v2",
      "destination": "/guides/use-cases/upgrading-from-v2"
    },
    {
      "source": "/open-source-self-hosting",
      "destination": "/self-hosting/overview"
    },
    {
      "source": "/v3/open-source-self-hosting",
      "destination": "/self-hosting/overview"
    },
    {
      "source": "/v3/:slug*",
      "destination": "/:slug*"
    },
    {
      "source": "/reattempting-replaying",
      "destination": "/replaying"
    },
    {
      "source": "/management/runs/bulk-actions",
      "destination": "/runs/bulk-actions"
    },
    {
      "source": "/tasks-overview",
      "destination": "/tasks/overview"
    },
    {
      "source": "/tasks-scheduled",
      "destination": "/tasks/scheduled"
    },
    {
      "source": "/trigger-folder",
      "destination": "/config/config-file"
    },
    {
      "source": "/trigger-config",
      "destination": "/config/config-file"
    },
    {
      "source": "/guides/frameworks",
      "destination": "/guides/frameworks/nextjs"
    },
    {
      "source": "/guides/frameworks/introduction",
      "destination": "/guides/introduction"
    },
    {
      "source": "/guides/examples/intro",
      "destination": "/guides/introduction"
    },
    {
      "source": "/examples/:slug*",
      "destination": "/guides/examples/:slug*"
    },
    {
      "source": "/realtime",
      "destination": "/realtime/overview"
    },
    {
      "source": "/runs-and-attempts",
      "destination": "/runs"
    },
    {
      "source": "/frontend/react-hooks",
      "destination": "/realtime/react-hooks/overview"
    },
    {
      "source": "/frontend/overview",
      "destination": "/realtime/auth"
    },
    {
      "source": "/frontend/react-hooks/overview",
      "destination": "/realtime/react-hooks/overview"
    },
    {
      "source": "/frontend/react-hooks/realtime",
      "destination": "/realtime/react-hooks/realtime"
    },
    {
      "source": "/frontend/react-hooks/triggering",
      "destination": "/realtime/react-hooks/triggering"
    },
    {
      "source": "/realtime/backend",
      "destination": "/realtime/backend/overview"
    },
    {
      "source": "/realtime/streams",
      "destination": "/realtime/backend/streams"
    },
    {
      "source": "/realtime/react-hooks",
      "destination": "/realtime/react-hooks/overview"
    },
    {
      "source": "/realtime/subscribe-to-run",
      "destination": "/realtime/backend/subscribe"
    },
    {
      "source": "/realtime/subscribe-to-runs-with-tag",
      "destination": "/realtime/backend/subscribe"
    },
    {
      "source": "/realtime/subscribe-to-batch",
      "destination": "/realtime/backend/subscribe"
    },
    {
      "source": "/management/projects/runs",
      "destination": "/management/overview"
    },
    {
      "source": "/guides/cursor-rules",
      "destination": "/mcp-agent-rules"
    },
    {
      "source": "/agents/rules/overview",
      "destination": "/mcp-agent-rules"
    },
    {
      "source": "/upgrade-to-v4",
      "destination": "/migrating-from-v3"
    },
    {
      "source": "/insights/query",
      "destination": "/observability/query"
    },
    {
      "source": "/insights/metrics",
      "destination": "/observability/dashboards"
    },
    {
      "source": "/guides/ai-chat",
      "destination": "/ai-chat/overview"
    }
  ]
}
