Sign in
gitpod.v1.WebhookService

UpdateWebhook

Updates a webhook's configuration.

Use this method to:

  • Change webhook name or description
  • Change webhook scope (the target repository 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 scope:

    Changes the webhook's target repository.

    webhookId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
scope: "gitpod-io/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

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

Changes