WebHook

Webhooks will allow GitCode to notify your external service when certain specific events occur. We will send a POST request to the URL you specify whenever these events happen. This mechanism can be used for integration and automation workflows, such as continuous integration, message notifications, and third-party service integration.

Access Entry

First, go to the project homepage, click on the "Project Settings" tab, then click on "WebHook" in the sidebar to enter the WebHook settings page.

Create WebHook

Click on "+ New WebHook," then fill in the relevant content: URL, WebHook password/signature key, POST request content type, event type.
- URL: When an event occurs, GitCode will send a POST request to the specified URL here.
- WebHook password/signature key:
  - The WebHook password is a simple string used to provide basic authentication for the webhook. GitCode includes this password in the request header or query parameters when sending the Webhook request, and the receiving end can verify this password to confirm the legitimacy of the request.
  - A signature key is a more secure verification method based on encryption algorithms to generate request signatures. GitCode uses the configured key to encrypt the request content and attaches the signature in the request header. The receiving end can use the same key and algorithm to compute the signature and compare it to confirm the integrity and legitimacy of the request.
- Event Type: When the selected event occurs, GitCode will automatically send a POST request.
After successful creation, you can see the existing WebHook list on the settings page.
Click on a WebHook to enter the WebHook details page, where you can reconfigure the WebHook again, or view the request sending records here.