PATCH
/
v1
/
projects
/
{project}
/
webhooks
/
{webhook}
:updateWebhook
{
  "issueLabels": [
    {
      "value": "<string>",
      "color": "<string>",
      "group": "<string>"
    }
  ],
  "forceIssueLabels": true,
  "allowModifyStatement": true,
  "autoResolveIssue": true,
  "enforceIssueTitle": true,
  "autoEnableBackup": true,
  "skipBackupErrors": true,
  "postgresDatabaseTenantMode": true,
  "allowSelfApproval": true,
  "executionRetryPolicy": {
    "maximumRetries": 123
  },
  "ciSamplingSize": 123,
  "parallelTasksPerRollout": 123,
  "labels": {}
}

Path Parameters

​
project
string
required

The project id.

​
webhook
string
required

The webhook id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to update.

Body

application/json
​
type
enum<string>
required

type is the type of the webhook.

Available options:
TYPE_UNSPECIFIED,
SLACK,
DISCORD,
TEAMS,
DINGTALK,
FEISHU,
WECOM,
LARK
​
title
string
required

title is the title of the webhook.

​
url
string
required

url is the url of the webhook, should be unique within the project.

​
name
string

name is the name of the webhook, generated by the server. format: projects/{project}/webhooks/{webhook}

​
directMessage
boolean

if direct_message is set, the notification is sent directly to the persons and url will be ignored. IM integration setting should be set for this function to work.

​
notificationTypes
enum<string>[]

notification_types is the list of activities types that the webhook is interested in. Bytebase will only send notifications to the webhook if the activity type is in the list. It should not be empty, and should be a subset of the following:

  • TYPE_ISSUE_CREATED
  • TYPE_ISSUE_STATUS_UPDATE
  • TYPE_ISSUE_PIPELINE_STAGE_UPDATE
  • TYPE_ISSUE_PIPELINE_TASK_STATUS_UPDATE
  • TYPE_ISSUE_FIELD_UPDATE
  • TYPE_ISSUE_COMMENT_CREATE

Response

OK

​
issueLabels
object[]
​
forceIssueLabels
boolean

Force issue labels to be used when creating an issue.

​
allowModifyStatement
boolean

Allow modifying statement after issue is created.

​
autoResolveIssue
boolean

Enable auto resolve issue.

​
enforceIssueTitle
boolean

Enforce issue title created by user instead of generated by Bytebase.

​
autoEnableBackup
boolean

Whether to automatically enable backup.

​
skipBackupErrors
boolean

Whether to skip backup errors and continue the data migration.

​
postgresDatabaseTenantMode
boolean

Whether to enable the database tenant mode for PostgreSQL. If enabled, the issue will be created with the prepend "set role <db_owner>" statement.

​
allowSelfApproval
boolean

Whether to allow the issue creator to self-approve the issue.

​
executionRetryPolicy
object

Execution retry policy for the task run.

​
ciSamplingSize
integer

The maximum number of databases to sample during CI data validation. Without specification, sampling is disabled, resulting in a full validation.

​
parallelTasksPerRollout
integer

The maximum number of parallel tasks to run during the rollout.

​
labels
object

Labels are key-value pairs that can be attached to the project. For example, { "environment": "production", "team": "backend" }