Task definitions

Tasks define the guidelines and requirements for feedback reported by users and reviewers.

Requirements

Requirements are defined in JSON schemas and are used to validate the feedback data. Forms are generated based on the JSON schema.

See here for how to create a task with a JSON schema.

For a full list of supported JSON schema properties, see JSON Schema (opens in a new tab).

Here is a short list of example JSON schema properties which can be used to create forms:

Text input

{
  "type": "string",
  "title": "Title",
  "description": "Description"
}

Text Area input

{
  "type": "string",
  "title": "Comment",
  "description": "Your comment",
  "multi": true // enable multi-line input
}

{
  "type": "string",
  "title": "Comment",
  "description": "Your comment",
  "multi": {
    "rows": 5 // number of default rows
  }
}

Number input

{
  "type": "number",
  "title": "Rating",
  "description": "Your rating"
}

Boolean input

{
  "type": "boolean",
  "title": "Subscribe",
  "description": "Subscribe to newsletter"
}

Select input

{
  "type": "string",
  "title": "Category",
  "description": "Select category",
  "enum": ["Category 1", "Category 2", "Category 3"]
}

Date input

{
  "type": "string",
  "title": "Date",
  "description": "Date",
  "format": "date"
}

Example

{
  "type": "object",
  "title": "Feedback",
  "description": "Feedback form",
  "properties": {
    "name": {
      "type": "string",
      "title": "Name",
      "description": "Your name"
    },
    "email": {
      "type": "string",
      "title": "Email",
      "description": "Your email",
      "format": "email"
    },
    "rating": {
      "type": "number",
      "title": "Rating",
      "description": "Your rating",
      "minimum": 1,
      "maximum": 5
    },
    "comment": {
      "type": "string",
      "title": "Comment",
      "description": "Your comment",
      "multi": {
        "rows": 3
      }
    },
    "subscribe": {
      "type": "boolean",
      "title": "Subscribe",
      "description": "Subscribe to newsletter"
    },
    "category": {
      "type": "string",
      "title": "Category",
      "description": "Select category",
      "enum": ["Category 1", "Category 2", "Category 3"]
    }
  }
}

Feedback Reference AutoFeedback