Xsolla-logo

Update information about webhook settingsServer-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

Project ID. You can find this parameter in your Publisher Account next to the name of the project.

Example: 44056
Request Body schema: application/json

Information about webhook settings.

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

Information about webhook settings was successfully updated.

401

Basic authentication not passed or wrong. Make sure you used basic authentication or correct credentials.

404

Information about webhook settings with passed project_id does not exists. Make sure you used correct project_id or created webhook earlier.

422

Information about webhook settings contains empty URL.

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