In the Hybrid deployment, Terse Cloud runs the control plane and you run the data plane. YourDocumentation Index
Fetch the complete documentation index at: https://docs.useterse.ai/llms.txt
Use this file to discover all available pages before exploring further.
createJob() registry and every onTrigger closure execute inside a Node process you operate, behind your network, with your environment variables and secrets.
If you want to run the control plane in your network as well, see Self-hosting the control plane. For an overview of all three deployment options, see Hosting overview.
Self-hosting the data plane is about where handlers execute, not about running your own event processor. Trigger ingestion, webhook URLs, scheduling, integration auth, signing, retries, and run history all stay on the Terse Cloud control plane.
When the Hybrid deployment is the right choice
Pick this when your workflow needs something only your environment can provide.| Reason | Examples |
|---|---|
| Private data access | Internal Postgres, Snowflake on a private link, a service mesh, an on-prem warehouse |
| Secrets in your own env | Credentials managed in AWS Secrets Manager, GCP Secret Manager, Vault, or your platform’s vars |
| VPC-only services | Internal APIs, microservices, or databases that are not reachable from public infrastructure |
| Compliance and data residency | Customer data must stay in a specific region, account, or tenancy |
| Reusing existing app code | You already have a Node service with shared libraries, models, or clients you want to import |
| Custom runtime needs | Specific Node version, native modules, large dependencies, or a long-running process you operate |
Setting it up
Attach the project
From the root of your existing repo, run:This authenticates, links the repo to a Terse project, and writes
terse.config.json with the self-hosted data plane enabled. See terse attach for the full flow.Set the required environment variables
Your data plane needs two values from the control plane, both available in the dashboard under your project’s settings:
Load both into your process the same way you load any other secret —
.env
| Variable | Purpose |
|---|---|
TERSE_API_KEY | Authenticates outbound calls from your data plane to the control plane: opening a session, executing tools, requesting approvals. |
TERSE_SIGNING_SECRET | Verifies that incoming trigger requests really came from the control plane. Used as the HMAC key for the x-terse-signature header. |
.env for local development, your platform’s secret store in production.Mount the trigger handler
Expose the SDK’s webhook handler on your HTTP server so the control plane can deliver events to your data plane. Mount it at The side-effect import of
TERSE_JOB_WEBHOOK_TRIGGER_PATH so URLs match what the platform expects.src/server.ts
./terse.jobs (or whichever entry file holds your createJob() calls) is what makes the registry available at request time. handleTrigger reads TERSE_SIGNING_SECRET and TERSE_API_KEY from the process env on every call. See Terse in the SDK reference for the full client surface.Deploy your code, then sync workflows
Ship your data plane the way you normally ship Node code (Render, Fly, ECS, your own Kubernetes, …). Once it’s reachable at The CLI reads
remoteServerUrl, run:remoteServerUrl, registers your workflows on the control plane, and routes every future trigger to your server.Identity verification
handleTrigger verifies every incoming request against TERSE_SIGNING_SECRET and rejects anything older than 5 minutes or with a mismatched signature. Failing requests never reach your handler.
If you parse the request body before calling
handleTrigger (for example with express.json()), the SDK re-serializes it with JSON.stringify to recompute the signature. Don’t mutate req.body
between parsing and the call, or verification will fail.Who runs what
| Your data plane | Terse Cloud control plane |
|---|---|
The Node process that loads src/terse.jobs.ts | Trigger ingestion from integrations (Attio, Slack, …) |
Every createJob() registration | Webhook URLs, signing, and delivery |
Every onTrigger handler closure | Cron and interval scheduling |
Every agent.tools.* call your handler makes | Integration auth and tool definitions |
| Internal clients, DB drivers, or SDKs you import | Run history, action traces, and approvals |
| The HTTP endpoint that receives signed payloads | The dashboard |
handleTrigger, looks up the registered workflow by name, and runs your onTrigger closure in your process. Tool calls, agent runs, and approvals flow back to the control plane so Activity, Notifications, and history all keep working.
What stays the same
Even though execution moves into your infrastructure, the only difference is the box youronTrigger runs inside. createJob(), agent.tools.*, runs, approvals, and the Activity tab all keep working as they do for managed workflows.
Where to go next
Hosting overview
The control plane / data plane split and the three deployment options.
Self-host the control plane
Run the orchestrator in your network with
npx create-terse.`terse attach`
CLI reference for linking an existing repo to a self-hosted data plane.
`Terse` client
SDK reference for
handleTrigger and signed payload verification.