Xsolla-logo

Activate keyWebhook POST

When a user activates a key, Xsolla sends a notification to your webhook URL.

Request
Request Body schema: application/json
notification_type
string

Type of notification.

object

Custom project settings (object).

project_id
integer

Game’s Xsolla ID. Can be found in Publisher Account.

merchant_id
integer

Merchant ID.

key
string

Activation key.

sku
string

Unique key package ID.

user_id
string

User ID.

activation_date
string <datetime>

Key activation date in the YYYYMMDDHHMMSS format per ISO 8601.

user_country
string

User’s country. Two-letter uppercase country code per ISO 3166-1 alpha-2.

object

Object with regional restriction cluster settings. The cluster includes a restriction type and a list of countries, servers and locales for which the game is available.

sku
string

Unique cluster ID.

name
string

Cluster name.

types
Array of strings

Array of restriction types.

countries
Array of strings

Array of countries in the cluster.

servers
Array of strings

Array of game servers.

locales
Array of strings

Array of locales.

Responses
204

Return to indicate successful processing.

400

Return in case of an error in the provided information (e.g., a required parameter missing, failed authorization, etc.).

500

Return to indicate temporary errors with your servers.

Request samples
application/json
{
  • "notification_type": "string",
  • "settings": {
    },
  • "key": "string",
  • "sku": "string",
  • "user_id": "string",
  • "activation_date": "string",
  • "user_country": "string",
  • "restriction": {
    }
}
Response samples
application/json
{
  • "error": {
    }
}