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
https://app.ona.com with that domain.
Request example
Request
gitpod.v1.StartWorkflowRequest
StartWorkflowRequest starts a workflow execution.
Response
gitpod.v1.StartWorkflowResponse
Related types
WorkflowExecution
WorkflowExecution
WorkflowExecution represents a workflow execution instance.
gitpod.v1.WorkflowExecutionMetadata
Metadata
WorkflowExecutionMetadata contains workflow execution metadata.
gitpod.v1.WorkflowExecution.MetadataSpec
Spec
WorkflowExecutionSpec contains the specification used for this execution.
gitpod.v1.WorkflowExecution.SpecStatus
Status
WorkflowExecutionStatus contains the current status of a workflow execution.
gitpod.v1.WorkflowExecution.StatusWorkflowTriggerContext
WorkflowTriggerContext
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)
- 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.WorkflowTriggerContextAgent
Agent
Execute workflow in agent-managed environments.
Agent receives the specified prompt and manages execution context.
gitpod.v1.WorkflowTriggerContext.AgentFromTrigger
FromTrigger
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.Projects
Projects
Execute workflow in specific project environments.
Creates environments for each specified project.
gitpod.v1.WorkflowTriggerContext.ProjectsRepositories
Repositories
Execute workflow in environments created from repository URLs.
Supports both explicit repository URLs and search patterns.
gitpod.v1.WorkflowTriggerContext.RepositoriesWorkflowExecutionPhase
WorkflowExecutionPhase