Skip to main content
This feature is in preview. The API may change before general availability. To try it out, contact support@intunedhq.com and we’ll enable it for your workspace.

Overview

Ephemeral parameters are inputs for a single Run that Intuned never retains. You pass them alongside parameters when you start a Run, read them from your automation when you need them, and they’re deleted—either the moment you invalidate them, or when the Run ends. Regular parameters are stored on the Run record so you can see what a Run was called with, re-run it, and debug it. That’s the right default for a product ID or a date range. It’s the wrong default for an end user’s portal password. Intuned gives you three places to put a sensitive value. They solve different problems:

When to use them

Use ephemeral parameters when the sensitive value is different on every Run and shouldn’t outlive it:
  • Credentials supplied by an end user — Your application collects a customer’s portal login and triggers a Run with it. You don’t want a copy in Intuned’s Run history.
  • One-time codes — A verification code read from your own system and handed to the automation.
  • Identifiers you can’t retain — A government ID, account number, or patient identifier that your compliance posture says must not be stored outside your systems.
Don’t use them for:
  • A secret shared by every Run — Use environment variables.
  • A login you want Intuned to maintain — Use AuthSessions, which keep the session alive and revalidate it instead of logging in on every Run.
  • Values you need to see later — They’re gone. If you need to know what a Run was called with, it belongs in parameters.

How it works

1. Pass them when you start the Run

Add an ephemeralParameters map to the Run request. Keys are non-empty strings; values are JSON scalars—string, number, or boolean. The map is one level deep; nested objects and arrays aren’t accepted. A key can’t also appear in parameters.

2. Read them from your automation

Call getEphemeralParameter with the key, inside a withoutTracing block. While the block runs, the browser trace and the automation logs aren’t recorded, so the value can’t be captured by the trace, a screenshot, or a log. Tracing resumes when the block ends, even if a step inside it fails.
Reading a key that wasn’t passed—or was already invalidated—returns undefined in TypeScript and None in Python rather than throwing.
On a traced Run, reading outside a withoutTracing block throws, so a value can’t be read while the trace is recording. On a Run that isn’t traced, the block isn’t required, but keep it so the automation behaves the same either way.

3. They get deleted

An ephemeral parameter is deleted in whichever of these happens first: Invalidation is scoped to the Run, so every attempt shares it. If an attempt invalidates a key and then fails, the retry reads undefined. See Invalidation and retries for how to choose.

Where the values do and don’t go

Ephemeral parameters are held in a dedicated store, separate from the one that holds Run inputs and results, with tighter access controls and a hard TTL. They’re encrypted at rest, readable only by your workspace’s machines—each one reads only the Run it’s executing—and deleted rather than archived. The store’s point-in-time backups keep a restorable copy for at most one day. They do not appear in:
  • The Run record, or the input panel on the Run details page
  • Webhook or S3 sink payloads
  • Attempt logs or browser traces
  • The Run result API response
  • extendPayload payloads, unless you put them there yourself
The guarantee covers how Intuned stores the values—not what your automation does with them. These all defeat it:
  • Returning a value from your automation. Return values are stored on the Run record.
  • Putting a value in an error message. Error details are stored even while tracing is paused.
  • Logging a value after tracing resumes.
  • Writing a value into extendPayload, a persistent store entry, or an external system.

Best practices

  • Invalidate as soon as the value has done its job, unless you need retries to re-read it.
  • Keep the sensitive section short. Read, use, and invalidate within one withoutTracing block.
  • Validate presence early. If a required key is missing, throw NonRetryableError. Retrying won’t make it appear.
  • Don’t echo values into the Run result. Return a status, not the secret.
  • Keep secrets out of error messages, including ones from your own validation.

Limitations

  • Runs only. Ephemeral parameters are accepted on the Run start request. Jobs, whose payloads are stored and replayed on a schedule, drop the field from their payloads. AuthSession create and update requests don’t take them.
  • Flat, scalar values. One level of non-empty keys; string, number, or boolean values. No nested objects or arrays.
  • Size. Each key and its value together must fit in 400 KB.
  • Not available in the Run Playground during preview. Trigger Runs that need them via the API or CLI.
  • Write-only from Intuned’s side. Once passed, there’s no API to read an ephemeral parameter back. The automation is the only consumer.
  • Not recoverable. If a Run fails after invalidating a value, you have to start a new Run and pass the value again.

FAQs

An environment variable is one value, set once, available to every Run in the project—right for your own API keys. An ephemeral parameter is a different value per Run, supplied by the caller, and retained for no longer than that Run—right for an end user’s credentials.
Partly. When a Run uses an AuthSession, its check and create functions can read the Run’s ephemeral parameters, and an invalidation there carries over to the API attempt. AuthSession create and update requests don’t take ephemeral parameters, so an AuthSession’s own parameters are still stored the way they are today. Note that authSession.saveTrace already defaults to false for this reason. If this blocks your use case, contact support.
The values are deleted by their 24-hour TTL whether or not the Run ever executes. Nothing is left behind if a Run sits queued and is then canceled.
No. There’s no API that lists them. Key names can appear in Intuned’s internal service logs, so never put a secret in a key name. If you need an audit trail, log the key names from your own system before you start the Run.
Yes. intuned dev run api and intuned dev attempt api take --ephemeral-parameters with a JSON object or the path to a JSON file, and the runtime helpers behave the same, so you can test the flow before deploying. Prefer the file form: inline JSON ends up in your shell history.

Ephemeral parameters (TypeScript)

getEphemeralParameter and invalidateEphemeralParameter

Ephemeral parameters (Python)

get_ephemeral_parameter and invalidate_ephemeral_parameter

Pause tracing

Keep sensitive steps out of traces and logs

Environment variables and secrets

For secrets that are the same on every Run