Quests Resource

Quests are a way for Discord to promote games and other content to users. Users can receive rewards for completing quests, such as redeemable codes, in-game items, or collectibles.

Quest Object

A sponsored quest.

Quest Structure

¹ Some quest content areas may be dismissed using the Dismiss Quest Content endpoint.

Quest Config Structure

Quest Messages Structure

Quest Rewards Config Structure

Quest Reward Structure

¹ If the amount of users who claimed the awards exceeds this count, then all future claimers will be assigned the next reward tier in the list.

Quest Reward Messages Structure

Quest Gradient Structure

A 2-point gradient with a primary and secondary color.

Quest Assets Structure

An object holding CDN asset names.

Quest Config Version

The version of the quest configuration.

Quest Content Type

Areas where the quest can be shown in the Discord client.

Quest Platform Type

Specifies the platforms that the quest reward can be redeemed on.

Quest Reward Assignment Method

The method used to assign the reward to a user.

Quest Reward Type

The type of reward that the user will receive.

Quest Variant

A behavioral variant for a quest.

Example Quest

{
  "id": "8206816794116096000",
  "config": {
    "quest_id": "8206816794116096000",
    "config_version": 1,
    "expires_at": "2077-01-01T11:59:59+00:00",
    "stream_duration_requirement_minutes": 30,
    "messages": {
      "quest_name": "👽",
      "reward_name": "Alien Cybernetics",
      "reward_name_with_article": "the Alien Cybernetics",
      "reward_redemption_instructions_by_platform": {
        "0": "To redeem, visit https://alien.studios/cyberalien/redeem"
      },
      "game_title": "Cyberalien 2077",
      "game_publisher": "Alien Studios"
    },
    "application_id": "1242265603276800000",
    "application_name": "Cyberalien 2077",
    "get_game_link": "https://alien.studios/cyberalien/redeem",
    "rewards_config": {
      "assignment_method": 1,
      "rewards": [
        {
          "sku_id": "12210381551199193606",
          "tag": 3,
          "messages": {
            "name": "Cybernetic Headgear",
            "name_with_article": "a Cybernetic Headgear Decoration"
          }
        }
      ]
    },
    "reward_code_platforms": [0],
    "reward_code_expires_at": "2077-01-01T11:59:59+00:00",
    "colors": {
      "primary": "#E944D4",
      "secondary": "#5318A7"
    },
    "assets": {
      "reward_tile": "reward.webm",
      "hero": "hero.png",
      "quest_bar_hero": "quests_bar_hero.png",
      "game_tile": "game_tile.png",
      "logotype": "game_logotype.svg"
    },
    "in_game_quest_config": null,
    "variants": []
  },
  "user_status": {
    "user_id": "222069018507345921",
    "quest_id": "8206816794116096000",
    "enrolled_at": "2077-01-01T11:59:59+00:00",
    "completed_at": "2077-01-01T11:59:59+00:00",
    "claimed_at": "2077-01-01T11:59:59+00:00",
    "claimed_tier": null,
    "last_stream_heartbeat_at": "2077-01-01T11:59:59+00:00",
    "stream_progress_seconds": 1800,
    "dismissed_quest_content": 0,
    "progress": {}
  },
  "targeted_content": [],
  "preview": false
}

Quest User Status Object

The user's quest progression.

Quest User Status Structure

Dismissible Quest Content Flags

Dismissed quest content areas.

Example Quest User Status

{
  "user_id": "222069018507345921",
  "quest_id": "8206816794116096000",
  "enrolled_at": "2077-01-01T11:59:59+00:00",
  "completed_at": "2077-01-01T11:59:59+00:00",
  "claimed_at": "2077-01-01T11:59:59+00:00",
  "claimed_tier": null,
  "last_stream_heartbeat_at": "2077-01-01T11:59:59+00:00",
  "stream_progress_seconds": 1800,
  "dismissed_quest_content": 0,
  "progress": {}
}

Quest Reward Code Object

An object that holds the quest's reward code.

Quest Reward Code Structure

Example Quest Reward Code

{
  "quest_id": "8206816794116096000",
  "code": "111-1111111",
  "platform": 0,
  "user_id": "222069018507345921",
  "claimed_at": "2077-01-01T18:41:29.706194+00:00",
  "tier": null
}

Quest Claimed Reward Object

Claimed rewards for the quest.

Quest Claimed Reward Structure

Example Quest Claimed Reward

{
  "claimed_at": "2024-04-17T23:30:41.000321+00:00",
  "entitlements": [
    {
      "id": "1230299425620885624",
      "sku_id": "1226939756617793606",
      "application_id": "1242265603276800000",
      "user_id": "222069018507345921",
      "deleted": false,
      "type": 10,
      "tenant_metadata": {},
      "gift_code_flags": 0,
      "promotion_id": null
    }
  ],
  "errors": []
}

Quest Platform Type

Platforms that the reward code can be redeemed on.

Endpoints

Get Available Quests

Returns a list of all available quests.

Accept Quest

Accepts a quest and returns a quest user status object.

JSON Params

Claim Quest Reward

Claims the quest's rewards, setting the completed_at and claimed_at fields of the quest user status to the current timestamp, and returns the claimed rewards.

JSON Params

Get Quest Reward Code

Retrieves the reward code for the specified platform and returns a quest reward code object.

JSON Params

Send Quest Heartbeat

Tells the server to update the last_stream_heartbeat and stream_progress_seconds fields. Used for keeping track of how long the stream has been running for, and for checking if the user has met the stream duration requirement. Returns a quest user status object.

JSON Params

Complete Quest

Forcefully completes the quest for the current user. Returns a quest user status object.

Reset Quest

Resets the quest's status for the current user. Returns a quest user status object.

Dismiss Quest Content

Dismisses the specified quest content area for the current user. Not all content areas can be dismissed. Returns a quest user status object.

Reset Quest Dismissibility

Resets the dismissibility of the quest's content areas for the current user (sets the dismissed_quest_content field to 0). Returns a quest user status object.