How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Gitpod gitpod.v1.WebhookService API

The gitpod.v1.WebhookService API from Gitpod — 8 operation(s) for gitpod.v1.webhookservice.

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.

8 operations 8 paths 59 schemas 8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.0.0
Base URL
https://api.gitpod.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gitpod gitpod.v1.WebhookService API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 POST. Each is listed below with its method, path, parameters, and response codes.

gitpod.v1.WebhookService 8
POST
/gitpod.v1.WebhookService/CreateWebhook
CreateWebhook
gitpod.v1.WebhookService.CreateWebhook body → 200default
POST
/gitpod.v1.WebhookService/DeleteWebhook
DeleteWebhook
gitpod.v1.WebhookService.DeleteWebhook body → 200default
POST
/gitpod.v1.WebhookService/GetWebhook
GetWebhook
gitpod.v1.WebhookService.GetWebhook body → 200default
POST
/gitpod.v1.WebhookService/GetWebhookSecret
GetWebhookSecret
gitpod.v1.WebhookService.GetWebhookSecret body → 200default
POST
/gitpod.v1.WebhookService/ListWebhookWorkflows
ListWebhookWorkflows
gitpod.v1.WebhookService.ListWebhookWorkflows 2 params body → 200default
POST
/gitpod.v1.WebhookService/ListWebhooks
ListWebhooks
gitpod.v1.WebhookService.ListWebhooks 2 params body → 200default
POST
/gitpod.v1.WebhookService/RotateWebhookSecret
RotateWebhookSecret
gitpod.v1.WebhookService.RotateWebhookSecret body → 200default
POST
/gitpod.v1.WebhookService/UpdateWebhook
UpdateWebhook
gitpod.v1.WebhookService.UpdateWebhook body → 200default

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.WorkflowStep.Report.OutputSpec (9 properties), gitpod.v1.CreateWebhookRequest (7 properties), gitpod.v1.UpdateWebhookRequest (6 properties), gitpod.v1.Webhook (6 properties). Each schema is shown below with its type and property counts.

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.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitpod-gitpod-v1-webhookservice-api-openapi.yml Raw ↑

Other APIs Gitpod publishes across the network.

Gitpod Organizations API
Gitpod Projects API
Gitpod Accounts and Billing API
Gitpod gitpod.v1.AccountService API
Gitpod gitpod.v1.AgentSecurityService API
Gitpod gitpod.v1.AgentService API
Gitpod gitpod.v1.BillingService API
Gitpod gitpod.v1.EditorService API
Gitpod gitpod.v1.EnvironmentAutomationService API
Gitpod gitpod.v1.EnvironmentService API
Gitpod gitpod.v1.ErrorsService API
Gitpod gitpod.v1.EventService API
Where this information came from

This is an independent, third-party profile of Gitpod gitpod.v1.WebhookService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.