Create Webhook

Click to create a new Webhook

Enter the Webhooks page and click New Webhook.

Fill in the name

The name distinguishes callback configurations in the console. Include the business purpose, such as:

Main-site risk alert callback
Payment event receiver
Audit event archive

The name only helps you identify this Webhook configuration in the console. Name it after the receiving system and business purpose to simplify later investigation.

Select Region

Select the Region to which the webhook belongs. After selection, the bound application list only displays applications under this Region.

After the Region is created, the Webhook should not be modified to achieve cross-region reception. If you need events for multiple regions, create a separate configuration for each Region.

Binding application

You can choose:

All applications under the current Region.
One or more specific applications.

If you select All Apps, confirm which apps it covers based on the scope description in the creation form. When you need to strictly control the push scope, it is recommended to select a specific application.

Fill in the target URL

The target URL is the public address where your server will receive callbacks.

Please note:

Production environment uses HTTPS.
The address must be accessible from the Geelab server.
Do not use localhost, 127.0.0.1, or an intranet IP as the production target.
Do not put tokens or other sensitive information in URL query parameters.
The target service should return an HTTP response within a reasonable amount of time.

Example:

https://api. example.com/Webhooks/geelab

Configure Bearer Token

Bearer Token is used to allow your server to verify whether the callback request comes from the configured webhook.

You can enter your own Token or use the random generation function provided on the page. It is recommended to use a randomly generated high-strength Token and save it to the server-side key management system.

Do not write Tokens into front-end code, public repositories, public logs or URLs.

After selecting all identified events or only high-risk events, click Confirm creation.

After successful creation, it is recommended to immediately use Test Webhook Delivery to verify the target URL, network connectivity, and Token verification.

Illustration: New Webhook