Quest verification#

There are two paths to mark tasks complete.

1. Manual verification#

The player clicks Verify in Gamearly.

Gamearly calls your verification endpoint, whose URL you configure in project settings.

We send a signed request containing:

{
  "task_id": 123,
  "partner_user_id": "A1B2C3"
}

Your endpoint responds with:

{
  "task_id": 123,
  "partner_user_id": "A1B2C3",
  "completed": true
}

If completed is true, the task is marked complete.

2. Automatic verification#

Optional, but recommended. Your project proactively reports task completion to Gamearly via the /quests/complete_task endpoint.

This gives a smoother player experience and reduces the need for manual verification.

Note

Once all tasks in a quest are completed, the quest is automatically marked as completed and the player can claim their rewards.

Locked quests

A quest (or its quest group) can require a minimum rank on your game, a Gamearly level, a completed player profile, or other quests done first. While the player does not meet them, complete_task answers status: "error" with message_tr_key: "error.quest.locked" and records nothing. Report the task again once the player has unlocked the quest.

Discord tasks

Discord tasks (join your server, send a message, react) are verified by the Gamearly bot in your server: nothing to report. A player who has not linked Discord to Gamearly yet and sends a quest's message (or joins your server for a join quest) gets a private message with a Continue with Discord link. Their messages and reactions from the last 30 minutes count once they link, so they never have to send their message again.

Checking completion#

If a player links their account after completing something, you can check state on demand:

POST /v1/quests/check_quest_completed — for a whole quest
POST /v1/quests/check_task_completed — for an individual task

Finding a quest id

The quest id is in the URL of the quest on Gamearly — e.g. https://app.gamearly.com/quests/27 — or from the /quests/list endpoint.