Test Review

This page contains information about events called in the entity Test Review

Created Test Review

Payload example:

{
  "event_name": "review.created",
  "timestamp": 1650534458,
  "payload": {
    "id": 1,
    "title": "Check edit function and result of updates",
    "case_id": 25,
    "project": "ID",
    "created_by": {
      "email": "[email protected]",
      "name": "Bob Bar"
    },
    "created": "2022-04-21 09:47:38"
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a new test case review is created.

Event name

review.created

Payload fields

ParameterTypeDescription
idintegerTest case review ID
titlestringTest case title
case_idintegerTest case ID
projectstringProject code
created_byobjectUser object
createdstringTest case review creation timestamp

User object

ParameterTypeDescription
emailstringUser email
namestringUser name

Approval status changed Test Review

Payload example:

{
  "event_name": "review.approval_status_changed",
  "timestamp": 1650544272,
  "payload": {
    "id": 2,
    "status": "approved",
    "updated_by": {
      "email": "[email protected]",
      "name": "Bob Bar"
    }
  },
  "team_member_id": 48,
  "project_code": "ID"
}

📘

This event is being sent when a test case review approval status is changed.

Event name

review.approval_status_changed

Payload fields

ParameterTypeDescription
idintegerTest case review ID
statusstringPossible value: unapproved, approved, request changes
updated_byobjectUser object

Commented Test Review

Payload example:

{
  "event_name": "review.commented",
  "timestamp": 1650534928,
  "payload": {
    "id": 2,
    "comment": "comment",
    "commented_by": {
      "email": "[email protected]",
      "name": "Bob Bar"
    }
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a test case review is commented.

Event name

review.commented

Payload fields

ParameterTypeDescription
idintegerTest case review ID
commentstringComment in test review
commented_byobjectUser object

Declined Test Review

Payload example:

{
  "event_name": "review.declined",
  "timestamp": 1650534857,
  "payload": {
    "id": 2,
    "declined_by": {
      "email": "[email protected]",
      "name": "Bob Bar"
    }
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a test case review is declined.

Event name

review.declined

Payload fields

ParameterTypeDescription
idintegerTest case review ID
declined_byobjectUser object

Deleted Test Review

Payload example:

{
  "event_name": "review.deleted",
  "timestamp": 1650534818,
  "payload": {
    "id": 1,
    "deleted_by": {
      "email": "[email protected]",
      "name": "Bob Bar"
    }
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a test case review is deleted.

Event name

review.deleted

Payload fields

ParameterTypeDescription
idintegerTest case review ID
deleted_byobjectUser object

Merged Test Review

Payload example:

{
  "event_name": "review.merged",
  "timestamp": 1650544276,
  "payload": {
    "id": 2,
    "merged_by": {
      "email": "[email protected]",
      "name": "Bob Bar"
    }
  },
  "team_member_id": 48,
  "project_code": "ID"
}

📘

This event is being sent when a test case review is merged.

Event name

review.merged

Payload fields

ParameterTypeDescription
idintegerTest case review ID
merged_byobjectUser object

Reopened Test Review

Payload example:

{
  "event_name": "review.reopened",
  "timestamp": 1650534883,
  "payload": {
    "id": 2,
    "title": "Check edit function and result of updates",
    "case_id": 25,
    "project": "ID",
    "data": {
      "id": "25",
      "title": "Check edit function and result of updates",
      "status": 0,
      "description": "description",
      "suite_id": 12,
      "severity": 0,
      "priority": 0,
      "type": 1,
      "layer": 0,
      "is_flaky": 0,
      "milestone_id": null,
      "behavior": 1,
      "automation": 0,
      "params": [],
      "tags": [],
      "preconditions": null,
      "postconditions": null,
      "custom_field": [],
      "steps_type": "classic",
      "code": "ID",
      "review": true
    },
    "approves": [],
    "updated_by": {
      "email": "[email protected]",
      "name": "Bob Bar"
    },
    "updated": "2022-04-21 09:54:09"
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a test case review is reopened.

Event name

review.reopened

Payload fields

ParameterTypeDescription
idintegerTest case review ID
titlestringTest case title
case_idintegerTest case ID
projectstringProject code
dataobjectTest case review object
updated_byobjectUser object
approvesarrayApprove objects array
updatedstringTest case review update timestamp

Reviewer added Test Review

Payload example:

{
  "event_name": "review.reviewer_added",
  "timestamp": 1650534955,
  "payload": {
    "id": 2,
    "reviewer": {
      "email": "[email protected]",
      "name": "Bob Bar"
    }
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a test case reviewer is added.

Event name

review.reviewer_added

Payload fields

ParameterTypeDescription
idintegerTest case review ID
reviewerobjectUser object

Reviewer removed Test Review

Payload example:

{
  "event_name": "review.reviewer_removed",
  "timestamp": 1650534974,
  "payload": {
    "id": 2,
    "reviewer": {
      "email": "[email protected]",
      "name": "Bib Bob"
    }
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a test case reviewer is removed.

Event name

review.reviewer_removed

Payload fields

ParameterTypeDescription
idintegerTest case review ID
reviewerobjectUser object

Updated Test Review

Payload example:

{
  "event_name": "review.updated",
  "timestamp": 1650534611,
  "payload": {
    "id": 1,
    "title": "Check edit function and result of updates",
    "case_id": 25,
    "project": "ID",
    "data": {
      "id": 25,
      "title": "Check edit function and result of updates f",
      "status": 0,
      "description": "frfr",
      "suite_id": 12,
      "severity": 0,
      "priority": 0,
      "type": 1,
      "layer": 0,
      "is_flaky": 0,
      "milestone_id": null,
      "behavior": 1,
      "automation": 0,
      "params": [],
      "tags": [
        "jira"
      ],
      "preconditions": null,
      "postconditions": null,
      "steps_type": "classic"
    },
    "approves": [],
    "updated_by": {
      "email": "[email protected]",
      "name": "Bib Bob"
    },
    "updated": "2022-04-21 09:47:38"
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a test case review is deleted.

Event name

review.updated

Payload fields

ParameterTypeDescription
idintegerTest case review ID
titlestringTest case title
case_idintegerTest case ID
projectstringProject code
dataobjeactTest case review object
updated_byobjectUser object
approvesarrayApprove objects array
updatedstringTest case review update timestamp