Skip to main content
Template fields can carry example values and Faker-style generation hints so that request previews, documentation, and test runs have realistic data without anyone having to type it in by hand.

When to use it

Example values are most useful when:
  • You want to show what a realistic request looks like without running it.
  • You’re setting up a template that others will use and want to make clear what kind of data each field expects.
  • You need auto-generated test data for fields like emails, names, UUIDs, or amounts so that runs don’t reuse the same static values every time.

Key concepts

  • Example value — a static, representative value for a field. Shown in the template preview and used as a fallback when no other value source is configured for a step.
  • Faker value — a generation hint that tells Reqflo to produce a realistic, randomized value at run time using Faker.js-style generators. Fresh data every run.
  • Scope — example and Faker values are defined at the template level, on each declared value. A step can override them with a specific source; the template default is the fallback.
Faker values are particularly useful for fields that must be unique per run (e.g., an email address for a user-creation request) or fields where any plausible value will do (e.g., a first name or a short description).

How it works

Each declared template value can include an example field (static) and a faker field (generation hint). When a step runs without a configured source for that value, Reqflo uses the Faker hint to generate one. If no Faker hint is set, it falls back to the example value. Available Faker categories include:
GeneratorExample output
internet.emailada.lovelace@example.com
string.uuida04b3f2e-9c1d-4e7a-b832-1f2c3d4e5f6a
person.firstNamePriya
person.lastNameOkonkwo
number.int42
finance.amount198.50
date.future2026-11-14T08:23:00Z
lorem.sentenceA short placeholder sentence
Faker generation follows Faker.js conventions. The exact set of available generators matches what Reqflo supports — check the template editor for autocomplete suggestions on the faker field.

Examples

Static example value only
values:
  - name: currency
    in: body
    required: true
    example: USD
The value is always USD — no generation hint, just a static example used as the default. Faker-generated email
values:
  - name: email
    in: body
    required: true
    description: Email address for the new user account.
    faker: internet.email
    example: ada.lovelace@example.com
The example here acts as documentation. The running system uses internet.email to generate a fresh address each time. UUID for a uniqueness-sensitive field
values:
  - name: idempotency_key
    in: header
    required: true
    description: Unique key to prevent duplicate submissions.
    faker: string.uuid
A mix of static and generated values
values:
  - name: amount
    in: body
    required: true
    example: 100
    faker: finance.amount
  - name: currency
    in: body
    required: true
    example: USD
  - name: note
    in: body
    required: false
    faker: lorem.sentence
Here currency is always USD (static, no Faker hint). amount and note are generated fresh each run.
Use Faker values for any field that needs to be unique per run — emails, idempotency keys, external IDs. For fields where the value must match something in your system (like a known user ID or an ID returned by an earlier step), configure the step to pull from a run input or step output instead.

Template values

How templates declare what values they need.

HTTP request templates

The full shape of an HTTP request template.

Cases

Save named value configurations for repeatable test scenarios.

Parallel data runs

Run a journey multiple times with different data using JSON or CSV.