## CreateWorkflow `client.Automations.New(ctx, body) (*AutomationNewResponse, error)` **post** `/gitpod.v1.WorkflowService/CreateWorkflow` Creates a new workflow with specified configuration. Use this method to: - Set up automated workflows - Configure workflow triggers - Define workflow actions and steps - Set execution limits and constraints ### Parameters - `body AutomationNewParams` - `Action param.Field[WorkflowAction]` WorkflowAction defines the actions to be executed in a workflow. - `Description param.Field[string]` Description must be at most 500 characters: ``` size(this) <= 500 ``` - `Executor param.Field[Subject]` Optional executor for the workflow. If not provided, defaults to the creator. Must be either the caller themselves or a service account. - `Name param.Field[string]` Name must be between 1 and 80 characters: ``` size(this) >= 1 && size(this) <= 80 ``` - `Report param.Field[WorkflowAction]` WorkflowAction defines the actions to be executed in a workflow. - `Triggers param.Field[[]WorkflowTrigger]` Automation must have between 1 and 10 triggers: ``` size(this) >= 1 && size(this) <= 10 ``` - `Context 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) 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 - `Agent WorkflowTriggerContextAgent` Execute workflow in agent-managed environments. Agent receives the specified prompt and manages execution context. - `Prompt string` Agent prompt must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` - `FromTrigger unknown` Use context derived from the trigger event. Currently only supported for PullRequest triggers - uses PR repository context. - `Projects WorkflowTriggerContextProjects` Execute workflow in specific project environments. Creates environments for each specified project. - `ProjectIDs []string` - `Repositories WorkflowTriggerContextRepositories` Execute workflow in environments created from repository URLs. Supports both explicit repository URLs and search patterns. - `EnvironmentClassID string` - `RepoSelector WorkflowTriggerContextRepositoriesRepoSelector` RepositorySelector defines how to select repositories for workflow execution. Combines a search string with an SCM host to identify repositories. - `RepoSearchString string` Search string to match repositories using SCM-specific search patterns. For GitHub: supports GitHub search syntax (e.g., "org:gitpod-io language:go", "user:octocat stars:>100") For GitLab: supports GitLab search syntax See SCM provider documentation for supported search patterns. - `ScmHost string` SCM host where the search should be performed (e.g., "github.com", "gitlab.com") - `RepositoryURLs WorkflowTriggerContextRepositoriesRepositoryURLs` RepositoryURLs contains a list of explicit repository URLs. Creates one action per repository URL. - `RepoURLs []string` - `Manual unknown` Manual trigger - executed when StartWorkflow RPC is called. No additional configuration needed. - `PullRequest WorkflowTriggerPullRequest` Pull request trigger - executed when specified PR events occur. Only triggers for PRs in repositories matching the trigger context. - `Events []WorkflowTriggerPullRequestEvent` - `const WorkflowTriggerPullRequestEventPullRequestEventUnspecified WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_UNSPECIFIED"` - `const WorkflowTriggerPullRequestEventPullRequestEventOpened WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_OPENED"` - `const WorkflowTriggerPullRequestEventPullRequestEventUpdated WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_UPDATED"` - `const WorkflowTriggerPullRequestEventPullRequestEventApproved WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_APPROVED"` - `const WorkflowTriggerPullRequestEventPullRequestEventMerged WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_MERGED"` - `const WorkflowTriggerPullRequestEventPullRequestEventClosed WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_CLOSED"` - `const WorkflowTriggerPullRequestEventPullRequestEventReadyForReview WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_READY_FOR_REVIEW"` - `IntegrationID string` integration_id is the optional ID of an integration that acts as the source of webhook events. When set, the trigger will be activated when the webhook receives events. - `WebhookID string` webhook_id is the optional ID of a webhook that this trigger is bound to. When set, the trigger will be activated when the webhook receives events. This allows multiple workflows to share a single webhook endpoint. - `Time WorkflowTriggerTime` Time-based trigger - executed automatically based on cron schedule. Uses standard cron expression format (minute hour day month weekday). - `CronExpression string` Cron expression must be between 1 and 100 characters: ``` size(this) >= 1 && size(this) <= 100 ``` ### Returns - `type AutomationNewResponse struct{…}` - `Workflow Workflow` Workflow represents a workflow configuration. - `ID string` - `Metadata WorkflowMetadata` WorkflowMetadata contains workflow metadata. - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Description string` - `Executor Subject` - `Name string` - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Spec WorkflowSpec` - `Action WorkflowAction` WorkflowAction defines the actions to be executed in a workflow. - `Limits WorkflowActionLimits` Limits defines execution limits for workflow actions. Concurrent actions limit cannot exceed total actions limit: ``` this.max_parallel <= this.max_total ``` - `MaxParallel int64` Maximum parallel actions must be between 1 and 25: ``` this >= 1 && this <= 25 ``` - `MaxTotal int64` Maximum total actions must be between 1 and 100: ``` this >= 1 && this <= 100 ``` - `PerExecution WorkflowActionLimitsPerExecution` PerExecution defines limits per execution action. - `MaxTime string` Maximum time allowed for a single execution action. Use standard duration format (e.g., "30m" for 30 minutes, "2h" for 2 hours). - `Steps []WorkflowStep` Automation must have between 1 and 50 steps: ``` size(this) >= 1 && size(this) <= 50 ``` - `Agent WorkflowStepAgent` WorkflowAgentStep represents an agent step that executes with a prompt. - `Prompt string` Prompt must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` - `PullRequest WorkflowStepPullRequest` WorkflowPullRequestStep represents a pull request creation step. - `Branch string` Branch name must be between 1 and 255 characters: ``` size(this) >= 1 && size(this) <= 255 ``` - `Description string` Description must be at most 20,000 characters: ``` size(this) <= 20000 ``` - `Draft bool` - `Title string` Title must be between 1 and 500 characters: ``` size(this) >= 1 && size(this) <= 500 ``` - `Task WorkflowStepTask` WorkflowTaskStep represents a task step that executes a command. - `Command string` Command must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` - `Report WorkflowAction` WorkflowAction defines the actions to be executed in a workflow. - `Triggers []WorkflowTrigger` - `Context 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) 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 - `Agent WorkflowTriggerContextAgent` Execute workflow in agent-managed environments. Agent receives the specified prompt and manages execution context. - `Prompt string` Agent prompt must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` - `FromTrigger unknown` Use context derived from the trigger event. Currently only supported for PullRequest triggers - uses PR repository context. - `Projects WorkflowTriggerContextProjects` Execute workflow in specific project environments. Creates environments for each specified project. - `ProjectIDs []string` - `Repositories WorkflowTriggerContextRepositories` Execute workflow in environments created from repository URLs. Supports both explicit repository URLs and search patterns. - `EnvironmentClassID string` - `RepoSelector WorkflowTriggerContextRepositoriesRepoSelector` RepositorySelector defines how to select repositories for workflow execution. Combines a search string with an SCM host to identify repositories. - `RepoSearchString string` Search string to match repositories using SCM-specific search patterns. For GitHub: supports GitHub search syntax (e.g., "org:gitpod-io language:go", "user:octocat stars:>100") For GitLab: supports GitLab search syntax See SCM provider documentation for supported search patterns. - `ScmHost string` SCM host where the search should be performed (e.g., "github.com", "gitlab.com") - `RepositoryURLs WorkflowTriggerContextRepositoriesRepositoryURLs` RepositoryURLs contains a list of explicit repository URLs. Creates one action per repository URL. - `RepoURLs []string` - `Manual unknown` Manual trigger - executed when StartWorkflow RPC is called. No additional configuration needed. - `PullRequest WorkflowTriggerPullRequest` Pull request trigger - executed when specified PR events occur. Only triggers for PRs in repositories matching the trigger context. - `Events []WorkflowTriggerPullRequestEvent` - `const WorkflowTriggerPullRequestEventPullRequestEventUnspecified WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_UNSPECIFIED"` - `const WorkflowTriggerPullRequestEventPullRequestEventOpened WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_OPENED"` - `const WorkflowTriggerPullRequestEventPullRequestEventUpdated WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_UPDATED"` - `const WorkflowTriggerPullRequestEventPullRequestEventApproved WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_APPROVED"` - `const WorkflowTriggerPullRequestEventPullRequestEventMerged WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_MERGED"` - `const WorkflowTriggerPullRequestEventPullRequestEventClosed WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_CLOSED"` - `const WorkflowTriggerPullRequestEventPullRequestEventReadyForReview WorkflowTriggerPullRequestEvent = "PULL_REQUEST_EVENT_READY_FOR_REVIEW"` - `IntegrationID string` integration_id is the optional ID of an integration that acts as the source of webhook events. When set, the trigger will be activated when the webhook receives events. - `WebhookID string` webhook_id is the optional ID of a webhook that this trigger is bound to. When set, the trigger will be activated when the webhook receives events. This allows multiple workflows to share a single webhook endpoint. - `Time WorkflowTriggerTime` Time-based trigger - executed automatically based on cron schedule. Uses standard cron expression format (minute hour day month weekday). - `CronExpression string` Cron expression must be between 1 and 100 characters: ``` size(this) >= 1 && size(this) <= 100 ``` - `WebhookURL string` Webhook URL for triggering this workflow via HTTP POST Format: {base_url}/workflows/{workflow_id}/webhooks ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) automation, err := client.Automations.New(context.TODO(), gitpod.AutomationNewParams{ Action: gitpod.F(gitpod.WorkflowActionParam{ Limits: gitpod.F(gitpod.WorkflowActionLimitsParam{ }), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", automation.Workflow) } ``` #### Response ```json { "workflow": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "metadata": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "description": "description", "executor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "name": "x", "updatedAt": "2019-12-27T18:11:19.117Z" }, "spec": { "action": { "limits": { "maxParallel": 0, "maxTotal": 0, "perExecution": { "maxTime": "+9125115.360s" } }, "steps": [ { "agent": { "prompt": "prompt" }, "pullRequest": { "branch": "branch", "description": "description", "draft": true, "title": "title" }, "report": { "outputs": [ { "acceptanceCriteria": "acceptanceCriteria", "boolean": {}, "command": "command", "float": { "max": 0, "min": 0 }, "integer": { "max": 0, "min": 0 }, "key": "key", "prompt": "prompt", "string": { "pattern": "pattern" }, "title": "title" } ] }, "task": { "command": "command" } } ] }, "deleting": true, "disabled": true, "report": { "limits": { "maxParallel": 0, "maxTotal": 0, "perExecution": { "maxTime": "+9125115.360s" } }, "steps": [ { "agent": { "prompt": "prompt" }, "pullRequest": { "branch": "branch", "description": "description", "draft": true, "title": "title" }, "report": { "outputs": [ { "acceptanceCriteria": "acceptanceCriteria", "boolean": {}, "command": "command", "float": { "max": 0, "min": 0 }, "integer": { "max": 0, "min": 0 }, "key": "key", "prompt": "prompt", "string": { "pattern": "pattern" }, "title": "title" } ] }, "task": { "command": "command" } } ] }, "triggers": [ { "context": { "agent": { "prompt": "prompt" }, "fromTrigger": {}, "projects": { "projectIds": [ "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ] }, "repositories": { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "repoSelector": { "repoSearchString": "x", "scmHost": "x" }, "repositoryUrls": { "repoUrls": [ "x" ] } } }, "manual": {}, "pullRequest": { "events": [ "PULL_REQUEST_EVENT_UNSPECIFIED" ], "integrationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "webhookId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" }, "time": { "cronExpression": "cronExpression" } } ] }, "webhookUrl": "webhookUrl" } } ```