Skip to main content
Unary · Workflows Starts a workflow execution. Use this method to:
  • Start workflow execution on demand
  • Test workflow configurations
  • Run workflows outside of automatic triggers

Examples

  • Start workflow: Starts a workflow execution manually.

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.StartWorkflowRequest StartWorkflowRequest starts a workflow execution.

Response

gitpod.v1.StartWorkflowResponse
WorkflowExecution represents a workflow execution instance.gitpod.v1.WorkflowExecution
WorkflowExecutionMetadata contains workflow execution metadata.gitpod.v1.WorkflowExecution.Metadata
WorkflowExecutionSpec contains the specification used for this execution.gitpod.v1.WorkflowExecution.Spec
WorkflowExecutionStatus contains the current status of a workflow execution.gitpod.v1.WorkflowExecution.Status
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
Execute workflow in agent-managed environments. Agent receives the specified prompt and manages execution context.gitpod.v1.WorkflowTriggerContext.Agent
Use context derived from the trigger event. Currently only supported for PullRequest triggers - uses PR repository context.gitpod.v1.WorkflowTriggerContext.FromTriggerThis message has no fields.
Execute workflow in specific project environments. Creates environments for each specified project.gitpod.v1.WorkflowTriggerContext.Projects
Execute workflow in environments created from repository URLs. Supports both explicit repository URLs and search patterns.gitpod.v1.WorkflowTriggerContext.Repositories