OnwardOnward
  • Public docs
  • Internal docs
  • Guides
  • Public API Reference
  • Internal documentation
Information
Users API
Account Connection API
Events API
Rewards API
    Claim a task rewardpostClaim a quest-chain rewardpost
Quest chain API
Schemas
Onward Public API
Onward Public API

Rewards API

Claim task-level and quest-chain-level rewards.


Claim a task reward

POST
https://api.onwardinc.net
/v1/rewards/claim
X-API-Key (header)
+X-API-Secret (header)

Publisher

Claims the reward for a completed quest-chain task belonging to the calling Platform. The claim is recorded once, reward delivery is attempted immediately, and any pending delivery is retried asynchronously.

Claim a task reward › Request Body

Claims the reward attached to a completed task for a user belonging to the calling Platform. A task reward can be claimed only once.
platform_user_id
​string · minLength: 1 · maxLength: 255 · required

Identifier of the user in the calling Platform's own system.

Example: user_12345
task_id
​string · uuid · required

Identifier of the completed quest-chain task whose reward the user is claiming.

Example: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d

Claim a task reward › Responses

Response for status 200

success
​boolean · enum · required

Indicates that the request was successful.

Enum values:
​object · required

Identifiers and timestamp of the successfully recorded task reward claim.

Example: {"user_task_id":"550e8400-e29b-41d4-a716-446655440000","task_id":"9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d","user_id":"550e8400-e29b-41d4-a716-446655440001","claimed_at":"2026-08-20T12:30:00Z"}
POST/v1/rewards/claim
curl https://api.onwardinc.net/v1/rewards/claim \ --request POST \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --header 'X-API-Secret: <api-key>' \ --data '{ "platform_user_id": "user_12345", "task_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d" }'
Example Request Body
{ "platform_user_id": "user_12345", "task_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d" }
json
Example Responses
{ "success": true, "data": { "user_task_id": "550e8400-e29b-41d4-a716-446655440000", "task_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", "user_id": "550e8400-e29b-41d4-a716-446655440001", "claimed_at": "2026-08-20T12:30:00Z" } }
json
application/json

Claim a quest-chain reward

POST
https://api.onwardinc.net
/v1/chains/rewards/claim
X-API-Key (header)
+X-API-Secret (header)

Publisher

Claims the reward attached to the quest chain itself after the user's chain reaches pending_reward. This is separate from task rewards; chain finalization and any pending reward delivery continue asynchronously.

Claim a quest-chain reward › Request Body

Claims the reward attached to the quest chain itself after the user's chain reaches `pending_reward`. This is separate from rewards attached to individual tasks.
platform_user_id
​string · minLength: 1 · maxLength: 255 · required

Identifier of the user in the calling Platform's own system.

Example: user_12345
quest_chain_id
​string · uuid · required

Identifier of the completed quest chain whose chain-level reward the user is claiming.

Example: 6f2f6f4e-4a1e-4f6f-9a2b-2c9d1f0b7a31

Claim a quest-chain reward › Responses

Response for status 200

success
​boolean · enum · required

Indicates that the request was successful.

Enum values:
​object · required

Identifiers and timestamp of the accepted quest-chain reward claim.

Example: {"quest_chain_id":"6f2f6f4e-4a1e-4f6f-9a2b-2c9d1f0b7a31","user_id":"550e8400-e29b-41d4-a716-446655440001","claimed_at":"2026-08-20T12:35:00Z"}
POST/v1/chains/rewards/claim
curl https://api.onwardinc.net/v1/chains/rewards/claim \ --request POST \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --header 'X-API-Secret: <api-key>' \ --data '{ "platform_user_id": "user_12345", "quest_chain_id": "6f2f6f4e-4a1e-4f6f-9a2b-2c9d1f0b7a31" }'
Example Request Body
{ "platform_user_id": "user_12345", "quest_chain_id": "6f2f6f4e-4a1e-4f6f-9a2b-2c9d1f0b7a31" }
json
Example Responses
{ "success": true, "data": { "quest_chain_id": "6f2f6f4e-4a1e-4f6f-9a2b-2c9d1f0b7a31", "user_id": "550e8400-e29b-41d4-a716-446655440001", "claimed_at": "2026-08-20T12:35:00Z" } }
json
application/json

Events APIQuest chain API