Xsolla-logo
  • 文档
  • 创建帐户

更新Webhook设置信息Server-sideAdmin

put/v2/project/{project_id}/admin/webhook

Updates the information about the webhook settings in Store. Check webhooks documentation to learn more.

SecuritybasicAuth
Request
path Parameters
project_id
required
integer

项目编号。您可以在您的发布商帐户项目名称旁边。

Example: 44056
Request Body schema: application/json

Webhook设置信息。

url
required
string

URL of your server for receiving Game services webhooks. The URL must be publicly accessible and use the HTTPS protocol, for example https://example.com. You can also specify the URL you find in any tool for testing webhooks.

For Game services webhooks, the setting specified in this API call takes precedence over the setting configured in Publisher Account in Project Settings > Webhooks section.

secret
required
string

The project secret key for signing Game services webhooks.

For Game services, the key specified in this API call takes precedence over the key generated in Publisher Account in Project Settings > Webhooks section.

is_enabled
required
boolean

Whether Game services webhooks are enabled.

For Game services webhooks, the setting specified in this API call takes precedence over the setting configured in Publisher Account in Project Settings > Webhooks section.

version
integer

Webhooks version. In version 2, the items array includes the parameters is_free, is_bonus, and is_bundle_content, which are not present in version 1 (default).

Enum: 1 2
Responses
204

已成功更新Webhook设置信息。

401

基本认证未通过或错误。确保您使用了基本认证或正确的凭据。

404

传入的project_id不存在相关Webhook设置信息。确保使用了正确的project_id或已在之前创建了Webhook。

422

Webhook设置信息包含空URL。

Request samples
application/json
{}
Response samples
application/json
{
  • "errorCode": 1020,
  • "errorMessage": "[0401-1020]: Error in Authentication method occurred",
  • "statusCode": 401
}