Xsolla-logo

Get friendsWebhook

The API should be implemented on the partner’s side. The maximum number of friends is 2000. See the recipe.

Request
query Parameters
limit
required
string

Limit for the number of elements on the page.

notification_type
string

ID that defines the type of request to get the list of friends. The value is friends_list.

user
string

Unique ID of the user buying the gift.

query
string

Friend’s name or ID (full or partial).

offset
integer

Number of the element from which the list is generated (the count starts from 0).

sign
string

Signature line, generated as follows:

  • Concatenate notification_type + parameter values sorted alphabetically by the key + secret_key
  • Apply SHA-1 to the resulting string
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
curl -v 'https://your.webhook.url?notification_type=friends_list&user=user_id&query=frien&offset=10&limit=20&sign=12dfg3f5gdsf4g5s6dfg2sdg1' \
-X GET \
-u merchant_id:merchant_api_key
Response samples
application/json
Invalid user
Invalid user
Invalid parameter
Invalid signature
Incorrect amount
Incorrect invoice
{
  • "error": {
    }
}