Sign in

v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.WebhookService

UpdateWebhook

Updates a webhook's configuration.

Use this method to:

  • Change webhook name or description
  • Change webhook scopes (the target repositories or organization)

Note: The webhook type and provider cannot be changed after creation.

Examples

  • Update webhook name:

    Changes the webhook's display name.

    webhookId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
name: "Updated Webhook Name"

  • Update webhook scopes:

    Changes the webhook's target repositories.

    webhookId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
scopes:
  - host: "github.com"
    owner: "gitpod-io"
    name: "new-repo"
post/gitpod.v1.WebhookService/UpdateWebhook

Request body

descriptionstring nullable

description is an optional description of the webhook's purpose

namestring nullable

name is the display name of the webhook

scopestring nullable

Deprecated: Use scopes instead. scope is the target of the webhook:

  • For REPOSITORY type: "owner/repo" (e.g., "gitpod-io/gitpod")
  • For ORGANIZATION type: "owner" (e.g., "gitpod-io") Note: The webhook type and provider cannot be changed after creation.
webhookIdstring uuid

Response

Success