Award Responses

Every authenticated award attempt returns a predictable JSON response. Automations should check the code value and may display the supplied message directly.

Awarded

{
  "success": true,
  "code": "awarded",
  "message": "exampleuser was awarded Participation Trophy #42.",
  "recipient": "exampleuser",
  "trophy": {
    "name": "Participation Trophy",
    "serial": 42
  },
  "error": null
}

Already owned

The trophy remains unchanged and the original serial number is returned.

{
  "success": false,
  "code": "already_owned",
  "message": "exampleuser already has Participation Trophy #42.",
  "recipient": "exampleuser",
  "trophy": {
    "name": "Participation Trophy",
    "serial": 42
  },
  "error": null
}

Shelf not added

This also covers recipients who do not have a trophycase.gg account or whose Twitch username does not exist. The error.message value provides the specific troubleshooting reason.

{
  "success": false,
  "code": "shelf_not_added",
  "message": "exampleuser has not added your shelf.",
  "recipient": "exampleuser",
  "trophy": {
    "name": "Participation Trophy",
    "serial": null
  },
  "error": {
    "message": "The recipient has a trophycase.gg account but has not added the awarder's shelf."
  }
}