Information about webhook settings was successfully received.
- Update information about webhook settings
Get information about webhook settings
Update information about...
Shop Builder API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.
Download OpenAPI description
Languages
Servers
Mock server
https://xsolla.redocly.app/_mock/api/shop-builder/
https://store.xsolla.com/api/
Personalized catalog
This API allows to specify rules for user attributes. If the user meets all conditions for a concrete rule, personalized items will be shown.
For personalized promotions see Promotions section.
To pass attributes before a purchase, you can use Xsolla Login API or pass them into user.attributes property while generating token using Pay Station API.
Operations
Request
Gets the information about the webhook settings in Store. Check webhooks documentation to learn more.
Security
basicAuth
Path
Project ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/webhook
- https://store.xsolla.com/api/v2/project/{project_id}/admin/webhook
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/webhookResponse
application/json
{ "url": "http://site.ru/webhook", "secret": "my_secret", "is_enabled": true }
Request
Updates the information about the webhook settings in Store. Check webhooks documentation to learn more.
Security
basicAuth
Path
Bodyapplication/jsonrequiredProject ID. You can find this parameter in your Publisher Account next to the name of the project.
Example: 44056
Information about webhook settings.
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.
Example: "http://site.ru/webhook"
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.
Example: "my_secret_key"
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.
Example: true
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).
Enum12
Example: 1
- Mock serverhttps://xsolla.redocly.app/_mock/api/shop-builder/v2/project/{project_id}/admin/webhook
- https://store.xsolla.com/api/v2/project/{project_id}/admin/webhook
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/api/shop-builder/v2/project/44056/admin/webhook \
-H 'Content-Type: application/json' \
-d '{
"url": "http://site.ru/webhook",
"secret": "my_secret_key",
"is_enabled": true,
"version": 1
}'