Skip to main content
Unary · Workflows Creates a new workflow with specified configuration. Use this method to:
  • Set up automations
  • Configure workflow triggers
  • Define workflow actions and steps
  • Set execution limits and constraints

Endpoint

Send a Bearer token as described in Authentication. If your organization uses a custom management-plane domain, replace https://app.ona.com with that domain.

Request example

Request

gitpod.v1.CreateWorkflowRequest CreateWorkflowRequest creates a new workflow.

Response

gitpod.v1.CreateWorkflowResponse
CodexSettings contains settings consumed only by the Codex app agent.gitpod.v1.CodexSettings
gitpod.v1.Subject
Workflow represents a workflow configuration.gitpod.v1.Workflow
WorkflowMetadata contains workflow metadata.gitpod.v1.Workflow.Metadata
gitpod.v1.Workflow.Spec
WorkflowAction defines the actions to be executed in a workflow.gitpod.v1.WorkflowAction
Limits defines execution limits for workflow actions.gitpod.v1.WorkflowAction.Limits
WorkflowStep defines a single step in a workflow action.gitpod.v1.WorkflowStep
WorkflowTrigger defines when a workflow should be executed.Each trigger type defines a specific condition that will cause the workflow to execute:
  • Manual: Triggered explicitly by user action via StartWorkflow RPC
  • Time: Triggered automatically based on cron schedule
  • PullRequest: Triggered automatically when specified PR events occur
Trigger Semantics:
  • Each trigger instance can create multiple workflow executions
  • Multiple triggers of the same workflow can fire simultaneously
  • Each trigger execution is independent and tracked separately
  • Triggers are evaluated in the context specified by WorkflowTriggerContext
gitpod.v1.WorkflowTrigger
Manual trigger - executed when StartWorkflow RPC is called. No additional configuration needed.gitpod.v1.WorkflowTrigger.ManualThis message has no fields.
Pull request trigger - executed when specified PR events occur. Only triggers for PRs in repositories matching the trigger context.gitpod.v1.WorkflowTrigger.PullRequest
Time-based trigger - executed automatically based on cron schedule. Uses standard cron expression format (minute hour day month weekday).gitpod.v1.WorkflowTrigger.Time
WorkflowTriggerContext defines the context in which a workflow should run.Context determines where and how the workflow executes:
  • Projects: Execute in specific project environments
  • Repositories: Execute in environments created from repository URLs
  • Agent: Execute in agent-managed environments with custom prompts
  • FromTrigger: Use context derived from the trigger event (PR-specific)
Context Usage by Trigger Type:
  • Manual: Can use any context type
  • Time: Typically uses Projects or Repositories context
  • PullRequest: Can use any context, FromTrigger uses PR repository context
  • Incident: Typically uses Projects or Repositories context (no inherent repo context)
gitpod.v1.WorkflowTriggerContext
CodexOpenAIModel is the static allowlist of concrete OpenAI models that the Codex app runtime can select through Ona’s Codex picker.
CodexReasoningEffort is the static allowlist of reasoning efforts supported by the Codex app runtime.
CodexServiceTier is the static allowlist of service tiers supported by the Codex app runtime.
WorkflowPREvent defines pull request events that can trigger workflows.