Zealy API
  • Introduction
  • Authentication
  • Use cases
  • Rate limits
  • Pagination
  • FAQ
  • API Reference
    • Communities
      • Community lookup
      • Community member check
      • Community Secret Retrieval
      • Community Secret Creation
    • Users
      • User lookup
      • Add & Remove XP
      • Ban user
      • Referral code
      • Delete Zealy Connect for member
    • Leaderboards
      • Retrieve a leaderboard
      • List sprints
    • Reviews
      • Claimed quests lookup
      • Review a submission
      • Review events
    • Modules
    • Quests
      • Create quest
      • Update quest
      • List quests
    • Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Reviews

Review events

Overview

This endpoint returns the list of review events that happened on a claimed quest.

The Review Event Object


id - String

ID of the review event


createdAt - String

ISO timestamp that indicates the creation date and time of the review event


type - Enum (error, success, cancel) Type of the review event.


data - Object

Object containing the comment written by the reviewer at the moment of the review and the bonus XP given, if any.


reviewer - Object

Object containing the id, name, and avatar url of the reviewer


API Specification

PreviousReview a submissionNextModules

Last updated 1 year ago

Was this helpful?

List review events for a review

get
Path parameters
idstring ยท uuidRequired
subdomainstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
409
409
application/json
429
429
application/json
500
500
application/json
get
GET /public/communities/{subdomain}/reviews/{id}/events HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Accept: */*
{
  "items": [
    {
      "id": "text",
      "createdAt": "2025-06-06T18:26:50.710Z",
      "type": "success",
      "data": {
        "message": "text",
        "bonusXP": 1
      },
      "reviewer": {
        "id": "text",
        "name": "text",
        "avatar": "https://example.com"
      }
    }
  ]
}
  • Overview
  • The Review Event Object
  • API Specification
  • GETList review events for a review