WorkflowStep

  • key
    Type: string
    required

    Step key

  • type
    Type: stringenum
    required

    Type of step

    values
    • group
    • participant
  • action
    Type: object

    Action details for participant steps

    • assignments
      Type: array object[]
    • envelopeKey
      Type: string
    • signedAt
      Type: stringFormat: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • status
      Type: stringenum
      values
      • pending
      • notified
      • viewed
      • signed
      • declined
    • type
      enum
      const:  
      sign

      Type for action

      values
      • sign
  • children
    Type: array object[] · WorkflowStep[]

    Child steps (for group steps)

    • key
      Type: string
      required

      Step key

    • type
      Type: stringenum
      required

      Type of step

      values
      • group
      • participant
    • action
      Type: object

      Action details for participant steps

    • children
      Type: array object[] · WorkflowStep[]

      Child steps (for group steps)

    • completionRule
      Type: stringenum
      values
      • all
      • any
      • quorum
    • executionMode
      Type: stringenum
      values
      • sequential
      • parallel
    • includeIf
      Type: string
    • name
      Type: string

      Step display name

    • onCompleteValidationExpression
      Type: string
    • participantKey
      Type: string
    • quorumCount
      Type: integer

      Integer numbers.

    • status
      Type: stringenum

      Current execution status of this step

      values
      • pending
      • in_progress
      • completed
      • skipped
      • failed
  • completionRule
    Type: stringenum
    values
    • all
    • any
    • quorum
  • executionMode
    Type: stringenum
    values
    • sequential
    • parallel
  • includeIf
    Type: string
  • name
    Type: string

    Step display name

  • onCompleteValidationExpression
    Type: string
  • participantKey
    Type: string
  • quorumCount
    Type: integer

    Integer numbers.

  • status
    Type: stringenum

    Current execution status of this step

    values
    • pending
    • in_progress
    • completed
    • skipped
    • failed