Gitpod gitpod.v1.WebhookService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
8 operations
across 8 paths,
and defines 59 schemas.
It is described by OpenAPI 3.0.0, at version v1.0.0.
Requests are made against a single base URL, https://api.gitpod.io.
The identity and technical contract details declared by the specification.
gitpod.v1.Principal
string
gitpod.v1.WorkflowTrigger.PullRequest
object
Pull request trigger - executed when specified PR events occur. Only triggers for PRs in repositories matching the trigger context.
2 properties
gitpod.v1.ListWebhookWorkflowsRequest
object
ListWebhookWorkflowsRequest lists workflows bound to a webhook.
2 properties
gitpod.v1.WebhookOrganizationScope
object
WebhookOrganizationScope represents an SCM organization in the webhook's scope.
2 properties
gitpod.v1.WorkflowStep.Report.OutputSpec
object
9 properties
gitpod.v1.RotateWebhookSecretRequest
object
RotateWebhookSecretRequest rotates the webhook secret.
1 property
gitpod.v1.RotateWebhookSecretResponse
object
1 property
gitpod.v1.WorkflowStep
object
WorkflowStep defines a single step in a workflow action.
4 properties
gitpod.v1.DeleteWebhookRequest
object
DeleteWebhookRequest deletes a webhook permanently.
1 property
gitpod.v1.Subject
object
2 properties
gitpod.v1.WorkflowStep.Report.IntegerSchema
object
2 properties
gitpod.v1.WorkflowTriggerContext.Projects
object
Execute workflow in specific project environments. Creates environments for each specified project.
1 property
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.WorkflowTriggerContext.Repositories
object
Execute workflow in environments created from repository URLs. Supports both explicit repository URLs and search patterns.
3 properties
gitpod.v1.WorkflowTrigger.Time
object
Time-based trigger - executed automatically based on cron schedule. Uses standard cron expression format (minute hour day month weekday).
1 property
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.WorkflowStep.Report
object
1 property
gitpod.v1.WebhookProvider
string
WebhookProvider identifies the Git provider.
gitpod.v1.WorkflowTrigger.Manual
object
Manual trigger - executed when StartWorkflow RPC is called. No additional configuration needed.
gitpod.v1.Webhook
object
Webhook represents a webhook endpoint for receiving SCM events.
6 properties
google.protobuf.Duration
string
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independen…
gitpod.v1.WorkflowStep.PullRequest
object
WorkflowPullRequestStep represents a pull request creation step.
4 properties
gitpod.v1.WorkflowStep.Report.FloatSchema
object
2 properties
gitpod.v1.WorkflowTriggerContext.FromTrigger
object
Use context derived from the trigger event. Currently only supported for PullRequest triggers - uses PR repository context.
gitpod.v1.Webhook.Metadata
object
Metadata contains organizational and ownership information.
6 properties
gitpod.v1.GetWebhookSecretResponse
object
1 property
gitpod.v1.WorkflowTriggerContext.Repositories.RepositorySelector
object
RepositorySelector defines how to select repositories for workflow execution. Combines a search string with an SCM host to identify repositories.
2 properties
gitpod.v1.WorkflowStep.Agent
object
WorkflowAgentStep represents an agent step that executes with a prompt.
1 property
gitpod.v1.CreateWebhookResponse
object
1 property
gitpod.v1.GetWebhookResponse
object
1 property
gitpod.v1.WorkflowStep.Task
object
WorkflowTaskStep represents a task step that executes a command.
1 property
gitpod.v1.CreateWebhookRequest
object
CreateWebhookRequest creates a new webhook.
7 properties
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.WorkflowAction.Limits.PerExecution
object
PerExecution defines limits per execution action.
1 property
gitpod.v1.UpdateWebhookResponse
object
1 property
gitpod.v1.UpdateWebhookRequest
object
UpdateWebhookRequest updates a webhook's configuration.
6 properties
google.protobuf.Timestamp
string
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 res…
gitpod.v1.WorkflowAction
object
WorkflowAction defines the actions to be executed in a workflow.
2 properties
1 required
gitpod.v1.WebhookRepositoryScope
object
WebhookRepositoryScope represents a repository in the webhook's scope. Contains SCM repository information needed to generate execution contexts. The clone URL…
3 properties
gitpod.v1.Workflow
object
Workflow represents a workflow configuration.
4 properties
gitpod.v1.WorkflowTriggerContext.Repositories.RepositoryURLs
object
RepositoryURLs contains a list of explicit repository URLs. Creates one action per repository URL.
1 property
gitpod.v1.WorkflowStep.Report.StringSchema
object
1 property
gitpod.v1.Webhook.Spec
object
Spec contains the webhook configuration.
5 properties
gitpod.v1.WebhookType
string
WebhookType determines the scope level of the webhook.
gitpod.v1.WorkflowTrigger
object
WorkflowTrigger defines when a workflow should be executed. Each trigger type defines a specific condition that will cause the workflow to execute: - Manual: T…
4 properties
1 required
gitpod.v1.Workflow.Metadata
object
WorkflowMetadata contains workflow metadata.
6 properties
gitpod.v1.WorkflowStep.Report.BooleanSchema
object
gitpod.v1.ListWebhooksResponse
object
2 properties
gitpod.v1.GetWebhookSecretRequest
object
GetWebhookSecretRequest retrieves the webhook secret.
1 property
gitpod.v1.WorkflowTriggerContext
object
WorkflowTriggerContext defines the context in which a workflow should run. Context determines where and how the workflow executes: - Projects: Execute in speci…
4 properties
gitpod.v1.ListWebhookWorkflowsResponse
object
2 properties
gitpod.v1.ListWebhooksRequest
object
ListWebhooksRequest lists webhooks with optional filtering.
2 properties
gitpod.v1.Workflow.Spec
object
5 properties
gitpod.v1.WorkflowTriggerContext.Agent
object
Execute workflow in agent-managed environments. Agent receives the specified prompt and manages execution context.
1 property
gitpod.v1.ListWebhooksRequest.Filter
object
3 properties
gitpod.v1.DeleteWebhookResponse
object
1 property
gitpod.v1.GetWebhookRequest
object
GetWebhookRequest gets details about a specific webhook.
1 property
gitpod.v1.WorkflowAction.Limits
object
Limits defines execution limits for workflow actions. Concurrent actions limit cannot exceed total actions limit: this.maxparallel <= this.maxtotal
3 properties
gitpod.v1.WorkflowTrigger.PullRequestEvent
string
WorkflowPREvent defines pull request events that can trigger workflows.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Gitpod publishes across the network.