Configuring Webhook Settings

Constraints

Project manager or project administrator can set project-level webhooks.
A maximum of 20 webhooks can be created for a repository.

Configuring Webhook Settings

Developers can configure URLs of third-party systems on the Webhook page and subscribe to events such as branch push and tag push of CodeArts Repo based on project requirements. When a subscribed event occurs, you can use a webhook to send a POST request to the URL of a third-party system to trigger operations related to your system (third-party system), such as popping up a notification window, building or updating images, or performing deployment.

To configure webhooks, choose Settings > Service Integration > Webhooks on the repository details page.

**Table 1** Parameters for creating a webhook
Parameter	Description
Name	Mandatory. Custom name with up to 200 characters.
Description	Optional. Used to describe the webhook, up to 200 characters.
URL	Mandatory. The URL and its response cannot contain sensitive data or the sensitive data must be encrypted and decrypted for security. Provided by the third-party CI/CD system.
Token Type	Optional. Used for authentication of third-party services' webhook APIs. The authentication information should be placed in the HTTP request header as the key and used together with the token. Three options are available: X-Repo-Token X-Gitlab-Token X-Auth-Token You can configure a token when setting up a webhook. The token will be associated with the webhook URL and sent to you in the X-Repo-Token header.
Token	Optional. Used for authenticating third-party CI/CD systems. The authentication information should be placed in the HTTP request header as the value and used together with the token type.
Trigger Events	Mandatory. You can subscribe to the following events: Code push After this option is selected, you need to enter the Regular Expression for Branch Filtering with up to 500 characters. .* indicates that all branches are matched. If the branch name matches the configured regular expression and the code is updated (code updates in sub-modules; online or offline code push in Git client), the event will be triggered. Merge requests After this option is selected, updating the MR code, closing MRs, re-opening MRs, updating MR title or description, updating the merger and the work item, deleting source branches, or updating the Squash merge will trigger this event. Tag push After this option is selected, both creating and deleting a tag will trigger this event. Comments After this option is selected, this event will be triggered when a review is added to a code file, a file change in a code commit, or an MR, or when a comment is added to a repository's commit details or MR details.