Retrieve a specific achievement by request name.

post https://us-central1-readysandbox.cloudfunctions.net/achievements-getByRequestName

Responses

Response body

object

string

Achievement document id. To trigger an achievement the id is needed.

appIds

array of strings

required

List of application ids where this achievement is used.

appIds*

requestName

string

Achievement request name. This value can be used to query or trigger achievements.

name

string

Achievement name. This value can be null or empty.

description

string

Achievement description. This value can be null or empty.

setBy

string

Defines who can set the achievement as completed: - client - the client and the server can set the achievement as completed. - server - only the server can set the achievement as completed.

client server

isClaimable

boolean

Should the achievement be claim manually to receive the rewards.

valueToReach

int32

Defaults to 1

Value which should be reached to complete the achievement. Default is 1.

completedAchievementsToUnlock

array of strings

Achievement ids which should be completed before this achievement can be triggered.

completedAchievementsToUnlock

repeatable

boolean

Defaults to false

Can this achievement be applied multiple times to the same user account. Default is false.

repeatNoMoreOftenThanCron

string

If provided, the trigger for this achievement will work no more often than the specified cron string. Use https://crontab.guru/ to create cron settings. For example, if the value is 0 0 1 * *, the achievement can be triggered only once a day.

startTime

int64

Start time of the achievement in milliseconds since midnight, January 1, 1970 UTC.

endTime

int64

End time of the achievement in milliseconds since midnight, January 1, 1970 UTC.

resetTimeLimitEvery

string

Define cron value when the achievement should reset. This parameter is used to update the startTime and endTime values. Use https://crontab.guru/ to create cron settings.

rewards

array of objects

Achievement rewards ids and quantity rewards to add to users when the achievement is triggered.

rewards

object

type

string

required

The type of reward this achievement offers.
Supported reward types are:

currency - the reward is a quantity of currency coins. The name field is the name of the currency.
addGlobalCurrency - the reward is a quantity of global currency coins. The name field is the name of the currency.
addRDYXBasedOnUSDTGlobalCurrency - the reward is a quantity of RDYX based on the USDT global currency the user will get when completes the achievement. The name field is always USDT.
item_by_id - the reward is a quantity of a virtual items. The name field is the id of the virtual item.
progression - the reward is a quantity of progression. The name field is the id/name of the progression.
setLeaderboardScore - the reward is a quantity of leaderboard score to set. The name field is the id of the leaderboard.
addLeaderboardScore - the reward is a quantity of leaderboard score to add. The name field is the id of the leaderboard.
gamepass_by_id - the reward is a quantity of game passes to add. The name field is the id of the game pass.
gamepass_by_request_name - the reward is a quantity of game passes to add. The name field is the request name of the game pass.

currency addGlobalCurrency addRDYXBasedOnUSDTGlobalCurrency item_by_id progression setLeaderboardScore addLeaderboardScore gamepass_by_id gamepass_by_request_name

appIds

array of strings

required

The list of application IDs for which this achievement reward is applicable. This allows rewards to be scoped to specific applications within a developer's portfolio.

appIds*

name

string

required

The name of the reward. This could be the id of the virtual item, currency name, progression id, or leaderboard id.

quantity

int32

required

The quantity of the reward that will be given to the user upon completing the achievement. For "virtualItem" and "currency", it represents the number of items or coins rewarded. For "progression", it represents the increment value for the user's progression. For "setLeaderboardScore", it represents the score that will be set for the current user to the leaderboard. For "addLeaderboardScore", it represents the score that will be added for the current user to the leaderboard.

requiredToComplete

object

Requirements to complete the achievement. When the achievement is triggered, the requirements are checked.

operation

string

The operation to be performed on the requirement.
Available operations are:

and - the user must meet all of the requirements.
or - the user must meet at least one of the requirements.
not - the user must not meet the requirement.

and or not

requirements

array of objects

The list of requirements.

requirements

object

type

string

required

gamepass_by_id
gamepass_by_request_name
item_by_id
item_by_tag
achievement_by_id
achievement_by_request_name
social_connected
discord_joined_server
discord_has_role
twitter_retweeted
twitter_liked
twitter_replied

Specifies the type of the requirement.
Available types are:

gamepass_by_id - the user needs to have a gamepass with a specific id to join a leaderboard, purchase a
store offer or complete an achievement.
gamepass_by_request_name - the user needs to have a gamepass with a specific request name to join a
leaderboard, purchase a store offer or complete an achievement.
item_by_id - the user needs to have a virtual item with a specific id to join a leaderboard, purchase a
store offer or complete an achievement.
item_by_tag - the user needs to have a virtual item with a specific tag to join a leaderboard, purchase a
store offer or complete an achievement.
achievement_by_id - the user needs to complete an achievement to join a leaderboard, purchase a store
offer or complete an achievement.
achievement_by_request_name - the user needs to complete an achievement with a specific request name to
join a leaderboard, purchase a store offer or complete an achievement.
social_connected - the user needs to connect their social account to join a leaderboard, purchase a store
offer or complete an achievement. The 'id' field is the social network id: 'discord' or 'twitter'.
discord_joined_server - the user needs to join a specific Discord server to join a leaderboard, purchase a
store offer or complete an achievement.
discord_has_role - the user needs to have a specific role in a Discord server to join a leaderboard,
purchase a store offer or complete an achievement.
twitter_retweeted - the user needs to retweet a specific tweet to join a leaderboard, purchase a store
offer or complete an achievement.
twitter_liked - the user needs to like a specific tweet to join a leaderboard, purchase a store offer or
complete an achievement.
twitter_replied - the user needs to reply to a specific tweet to join a leaderboard, purchase a store offer
or complete an achievement.

gamepass_by_id gamepass_by_request_name item_by_id item_by_tag achievement_by_id achievement_by_request_name social_connected discord_joined_server discord_has_role twitter_retweeted twitter_liked twitter_replied

string

required

The id field is used to provide the data: - gamepass_by_id - the 'id' is the gamepass id. - gamepass_by_request_name - the 'id' is the gamepass request name. - item_by_id - the 'id' is the virtual item id. - item_by_tag - the 'id' is the virtual item tag. - achievement_by_id - the 'id' is the achievement id. - achievement_by_request_name - the 'id' is the achievement request name. - discord_joined_server - the 'id' is the Discord server/guild id. - discord_has_role - the 'id' is the Discord server/guild id. Additionaly 'payload' parameter is excpected for

the Discord role id.

twitter_retweeted - the 'id' is the tweet id. - twitter_liked - the 'id' is the tweet id. - twitter_replied - the 'id' is the tweet id.

iconName

string

Icon name of the achievement.

resetIntervalDays

number | null

1 to 3650

Defaults to null

The number of days after which the achievement will reset. This field is relevant only if the achievement is repeatable. Default is null. Use it for daily, weekly, or monthly achievements. The value should be greater than 0. Every 0:00 UTC the user-achievements with this field will reset.

properties

array of objects

List of properties for the achievement.

properties

object

appIds

array of strings | null

appIds

json

string | null

200Successful retrieval of the achievement.