- What's New
- Function Overview
- Product Bulletin
- Service Overview
- Getting Started
-
User Guide
- Process of CodeArts Repo
- Purchasing CodeArts
- Environment and Personal Settings
- Accessing CodeArts Repo Homepage
- Creating and Configuring a CodeArts Project
- Configuring Project-Level Settings for CodeArts Repo
- Managing Member Permissions
- Creating a Repository
- Migrating Code and Syncing a Repository
- Configuring Repository Settings
- Hierarchical Repository Management
- Configuring a Repository
- Cloning or Downloading a Repository to a Local PC
- Uploading Code Files to CodeArts Repo
- Collaborating on a Workflow
- Committing Code to CodeArts Repo and Creating a Merge Request
- Managing Merge Requests
- Managing Code Files
- Security Management
-
Best Practices
- CodeArts Repo Best Practices
- Managing Repository Members and Permissions in an Enterprise
- Migrating GitLab Intranet Repositories to CodeArts Repo in Batches
- Importing Local Repositories to CodeArts Repo in Batches
- CodeArts Repo Security Configuration Overview
- Configuring HTTPS Password
- Best Practices for Configuring Protected Branch Rules
-
FAQs
- Authentication
- Member Permissions
-
Uploading and Downloading Code
- "Error: Deny by project hooks setting 'default': message of commit" Is Reported When Code Repository Is Pushed from the Local Host to CodeArts Repo
- Pushing Binary Files to CodeArts Repo Failed
- Error "'origin' does not appear to be a git repository..." Is Reported When the Git Push Command Is Executed
- Error "The requested URL returned error: 401" Is Reported When HTTPS Is Used to Clone Code in CentOS
- Error "Merge branch 'master' of https://test.com Please Enter a commit" Is Reported When Pulling Code Using the Git Pull Command
- Message "fatal: refusing to merge unrelated histories" Is Displayed
- How Do I Prevent Files Containing Secrets from Being Pushed to CodeArts Repo?
- Migrating Repositories
- Merge Request
- Fork Sync
- Repository Capacity
- FAQs
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
- SSH Key
-
Repository
- Obtaining Files in a Branch Directory
- Obtaining Repository Statistics
- Obtaining Image Files of a Specific Branch in a Repository
- Modifying the Status of a Repository Referenced by a Pipeline
- Checking Whether a User Has the Repository Administrator Permission
- Setting a Repository to Public or Private
- Obtaining the Content of a Specified File in a Specified Branch of a Repository
- Obtaining a Public Template List
- Creating a Repository
- Obtaining a Repository Short ID to Generate the Details Page URL
- Querying a Commit of a Branch by Repository or Repository Group Name
- Querying Branches of a Specified Repository
- Querying a Commit of a Repository Branch by the Repository ID
- Adding a Deploy Key
- Deleting a Deploy Key
- Obtaining the Last Commit Statistics of a Repository
- Repository Statistics
- Deleting a Repository
- Viewing a Repository Creation Status
- Querying the Tag List of a Repository
- Adding a Tag
- Querying Details About a Repository
- Obtaining the number of committed code lines
- Downloading a Repository
- Creating a Protected Branch
- Deleting a Protected Branch
- Deleting Protected Branches in Batches
- Creating a Protected Tag
- Deleting a Protected Tag
- Obtaining a Repository Branch List
- Obtaining the MR List of a Repository
- Obtaining MR Details of a Repository
- Obtaining the Repository IP Address Whitelist
- Adding the Repository IP Address Whitelist
- Modifying the Repository IP Address Whitelist
- Deleting the Repository IP Address Whitelist
- Obtaining the Changes of an MR
- Associating a Repository with a Member Group
- Locking a Repository Based on the Repository Short ID
- Unlocking a Repository Based on the Repository Short ID
- Approving an MR
- Obtaining Associated Work Item Information
- Obtaining Reviewer Information Based on the Repo Short ID and Merge Request Short ID
- Obtaining the List of Changed Files
- Tenant
- Group
- Project (V2)
- RepoMember
- Commit
- File
- User
- Webhook
- Project
- Repository Management (V2)
- Review
- Application Examples
- Appendix
- Videos
- General Reference
Copied.
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.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot