Skip to main content
POST
/
v1
/
projects
/
{project}
:addWebhook
{
  "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": {},
  "enforceSqlReview": true
}

Path Parameters

​
project
string
required

The project id.

Body

application/json
​
project
string
required

The name of the project to add the webhook to. Format: projects/{project}

​
webhook
object
required

The webhook to add.

Response

OK

Project contains settings and configuration for a Bytebase project.

​
issueLabels
object[]

Available labels that can be applied to issues in this project.

​
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

Configuration for automatic retry on task execution failures. Execution retry policy configuration.

​
ciSamplingSize
integer

The maximum number of databases to sample during CI data validation. If not specified, 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" }

​
enforceSqlReview
boolean

Whether to enforce SQL review checks to pass before issue creation. If enabled, issues cannot be created when SQL review finds errors.