Xsolla-logo

ウェブフック設定に関する情報を更新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

プロジェクトID。このパラメータは、ドメインページのプロジェクト名の横にあります。

Example: 44056
Request Body schema: application/json

ウェブフック設定に関する情報。

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

ウェブフック設定に関する情報がは常に更新されました。

401

基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。

404

project_idが渡されたウェブフック設定に関する情報は存在しません。正しいproject_idを使用したか、以前にウェブフックを作成したことを確認してください。

422

ウェブフック設定に関する情報には空URLが含まれています。

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