BlueprintStep

A step in the blueprint's orchestration tree — either a participant (one task assigned to a participant) or a group (a container of nested children).

key
Type: string
required

Unique identifier for this step within the orchestration.
type
Type: stringenum
required

group for a container that runs children; participant for a single signer task.
values
- group
- participant
action
Type: object

What the participant does at this step (participant steps only).
- assignments
  Type: array object[]
  required
  
  For each document in the envelope this step targets, which template role the participant fills.
- envelopeKey
  Type: string
  required
  
  Envelope key the participant acts on. Must match an envelope in spec.envelopes.
- type
  enum
  const:
  sign
  required
  
  Action kind. Currently only sign (the participant signs the assigned documents).
  
  values
  sign
children
Type: array object[] · BlueprintStep[]

Nested steps (group steps only). Recursive — each child is itself a BlueprintStep.
A step in the blueprint's orchestration tree — either a participant (one task assigned to a participant) or a group (a container of nested children).
- key
  Type: string
  required
  
  Unique identifier for this step within the orchestration.
- type
  Type: stringenum
  required
  
  group for a container that runs children; participant for a single signer task.
  
  values
  group
  participant
- action
  Type: object
  
  What the participant does at this step (participant steps only).
- children
  Type: array object[] · BlueprintStep[]
  
  Nested steps (group steps only). Recursive — each child is itself a BlueprintStep.
  
  A step in the blueprint's orchestration tree — either a participant (one task assigned to a participant) or a group (a container of nested children).
- completion
  Type: stringenum
  
  When the group is considered complete (group steps only):
  
  all (default) — every child must complete before the group is done.
  
  any — the group completes as soon as any one child completes; remaining children no longer block.
  
  quorum — the group completes as soon as at least N children complete, where N is set in the quorum field below.
  
  values
  all
  any
  quorum
- execution
  Type: stringenum
  
  How children execute (group steps only). sequential runs them in order; parallel runs them concurrently.
  
  values
  sequential
  parallel
- includeIf
  Type: string
  
  Optional JSONata expression evaluated at run time. If it returns false, this step is skipped.
- name
  Type: string
  
  Optional human-readable label shown in Studio and in audit/event logs. The key is the machine-readable handle.
- onComplete
  Type: object
  
  Optional hooks that run when this step completes.
- participantKey
  Type: string
  
  Participant whose action this step represents (participant steps only). Must match a key in spec.participants.
- quorum
  Type: integer
  min:
  1
  
  The number of children that must complete to satisfy the group. Required when completion is quorum (ignored otherwise). Example: quorum: 2 with 3 children means the group completes as soon as any 2 of them complete.
completion
Type: stringenum
When the group is considered complete (group steps only):
- all (default) — every child must complete before the group is done.
- any — the group completes as soon as any one child completes; remaining children no longer block.
- quorum — the group completes as soon as at least N children complete, where N is set in the quorum field below.
values
- all
- any
- quorum
execution
Type: stringenum

How children execute (group steps only). sequential runs them in order; parallel runs them concurrently.
values
- sequential
- parallel
includeIf
Type: string

Optional JSONata expression evaluated at run time. If it returns false, this step is skipped.
name
Type: string

Optional human-readable label shown in Studio and in audit/event logs. The key is the machine-readable handle.
onComplete
Type: object

Optional hooks that run when this step completes.
- updates
  Type: array object[]
  
  Entity-data updates to apply when the step completes. Each update writes the result of transform to the entity at key.
- validate
  Type: string
  
  JSONata expression evaluated when the step completes. If it returns false, the step is rejected.
participantKey
Type: string

Participant whose action this step represents (participant steps only). Must match a key in spec.participants.
quorum
Type: integer
min:
1

The number of children that must complete to satisfy the group. Required when completion is quorum (ignored otherwise). Example: quorum: 2 with 3 children means the group completes as soon as any 2 of them complete.