ObjectStackObjectStack

Approval

Approval protocol schemas

Approval Step Approver Type

Source: packages/spec/src/automation/approval.zod.ts

TypeScript Usage

import { ApprovalAction, ApprovalActionType, ApprovalProcess, ApprovalStep, ApproverType } from '@objectstack/spec/automation';
import type { ApprovalAction, ApprovalActionType, ApprovalProcess, ApprovalStep, ApproverType } from '@objectstack/spec/automation';

// Validate data
const result = ApprovalAction.parse(data);

ApprovalAction

Properties

PropertyTypeRequiredDescription
typeEnum<'field_update' | 'email_alert' | 'webhook' | 'script' | 'connector_action'>
namestringAction name
configRecord<string, any>Action configuration
connectorIdstringoptional
actionIdstringoptional

ApprovalActionType

Allowed Values

  • field_update
  • email_alert
  • webhook
  • script
  • connector_action

ApprovalProcess

Properties

PropertyTypeRequiredDescription
namestringUnique process name
labelstringHuman readable label
objectstringTarget Object Name
activeboolean
descriptionstringoptional
entryCriteriastringoptionalFormula to allow submission
lockRecordbooleanLock record from editing during approval
stepsObject[]Sequence of approval steps
escalationObjectoptionalSLA escalation configuration for pending approval steps
onSubmitObject[]optionalActions on initial submission
onFinalApproveObject[]optionalActions on final approval
onFinalRejectObject[]optionalActions on final rejection
onRecallObject[]optionalActions on recall

ApprovalStep

Properties

PropertyTypeRequiredDescription
namestringStep machine name
labelstringStep display label
descriptionstringoptional
entryCriteriastringoptionalFormula expression to enter this step
approversObject[]List of allowed approvers
behaviorEnum<'first_response' | 'unanimous'>How to handle multiple approvers
rejectionBehaviorEnum<'reject_process' | 'back_to_previous'>What happens if rejected
onApproveObject[]optionalActions on step approval
onRejectObject[]optionalActions on step rejection

ApproverType

Allowed Values

  • user
  • role
  • manager
  • field
  • queue

On this page