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
on the repository details page.
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:
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:
|
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.