BlueprintStep

  • key
    Type: string
    required

    Unique identifier for this step

  • type
    Type: stringenum
    required

    Type of workflow step

    values
    • group
    • participant
  • action
    Type: object

    Action configuration (for participant steps)

    • assignments
      Type: array object[]
      required

      Mappings between documents and template roles

    • envelopeKey
      Type: string
      required

      Envelope key grouping related documents for signing

    • type
      enum
      const:  
      sign
      required

      Type for action

      values
      • sign
  • childStepKeys
    Type: array string[]

    Array of child step keys (for group steps)

  • completionRule
    Type: stringenum

    Rule for determining when this step is complete (for group steps)

    values
    • all
    • any
    • quorum
  • executionMode
    Type: stringenum

    How child steps should be executed (for group steps)

    values
    • parallel
    • sequential
  • includeIf
    Type: string

    JSONata expression that determines whether this step should be included in the workflow

  • name
    Type: string

    Human-readable name for this step

  • onCompleteMappers
    Type: array object[]

    Data mappers that transform entity data when step completes

    • mapperExpression
      Type: string
      required

      JSONata expression that runs on current entity data to produce new values

    • targetEntityKey
      Type: string
      required

      Entity key to update with mapped data

  • onCompleteValidationExpression
    Type: string

    JSONata expression to validate data when step completes

  • participantKey
    Type: string

    Participant key that this step is assigned to

  • quorumCount
    Type: integer

    Number of child steps required for quorum completion (when completionRule is 'quorum')