ObjectStackObjectStack

Workflow

Workflow protocol schemas

Trigger events for workflow automation

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

TypeScript Usage

import { ConnectorActionRef, CustomScriptAction, EmailAlertAction, FieldUpdateAction, HttpCallAction, PushNotificationAction, WorkflowTriggerType } from '@objectstack/spec/automation';
import type { ConnectorActionRef, CustomScriptAction, EmailAlertAction, FieldUpdateAction, HttpCallAction, PushNotificationAction, WorkflowTriggerType } from '@objectstack/spec/automation';

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

ConnectorActionRef

Properties

PropertyTypeRequiredDescription
namestring✅Action name
typestring✅
connectorIdstring✅Target Connector ID (e.g. slack, twilio)
actionIdstring✅Target Action ID (e.g. send_message)
inputRecord<string, any>✅Input parameters matching the action schema

CustomScriptAction

Properties

PropertyTypeRequiredDescription
namestring✅Action name
typestring✅
languageEnum<'javascript' | 'typescript' | 'python'>✅Script language
codestring✅Script code to execute
timeoutnumber✅Execution timeout in milliseconds
contextRecord<string, any>optionalAdditional context variables

EmailAlertAction

Properties

PropertyTypeRequiredDescription
namestring✅Action name
typestring✅
templatestring✅Email template ID/DevName
recipientsstring[]✅List of recipient emails or user IDs

FieldUpdateAction

Properties

PropertyTypeRequiredDescription
namestring✅Action name
typestring✅
fieldstring✅Field to update
valueany✅Value or Formula to set

HttpCallAction

Properties

PropertyTypeRequiredDescription
namestring✅Action name
typestring✅
urlstring✅Target URL
methodEnum<'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'>✅HTTP Method
headersRecord<string, string>optionalHTTP Headers
bodystringoptionalRequest body (JSON or text)

PushNotificationAction

Properties

PropertyTypeRequiredDescription
namestring✅Action name
typestring✅
titlestring✅Notification title
bodystring✅Notification body text
recipientsstring[]✅User IDs or device tokens
dataRecord<string, any>optionalAdditional data payload
badgenumberoptionalBadge count (iOS)
soundstringoptionalNotification sound
clickActionstringoptionalAction/URL when notification is clicked

WorkflowTriggerType

Allowed Values

  • on_create
  • on_update
  • on_create_or_update
  • on_delete
  • schedule

On this page

TypeScript UsageConnectorActionRefPropertiesCustomScriptActionPropertiesEmailAlertActionPropertiesFieldUpdateActionPropertiesHttpCallActionPropertiesPushNotificationActionPropertiesWorkflowTriggerTypeAllowed Values