Skip to content

Latest commit

 

History

History
130 lines (97 loc) · 2.21 KB

defect.md

File metadata and controls

130 lines (97 loc) · 2.21 KB

Defect

Created Defect

Payload example:

{
  "event_name": "defect.created",
  "timestamp": 1650532563,
  "payload": {
    "id": 1,
    "title": "Example defect",
    "severity": "normal",
    "actual_result": "Something",
    "attachments": []
  },
  "team_member_id": 40,
  "project_code": "ID"
}

{% hint style="info" %} This event is being sent when a new defect is created {% endhint %}

Event name

defect.created

Payload fields

Parameter Type Description
id integer Defect ID
title string Defect title
severity string Level of severity
actual_result string A text description of defect
attachments array An array of attachments ids.

Updated Defect

Payload example:

{
  "event_name": "defect.updated",
  "timestamp": 1650532605,
  "payload": {
    "id": 1
  },
  "team_member_id": 40,
  "project_code": "ID"
}

{% hint style="info" %} This event is being sent when a defect is updated. {% endhint %}

Event name

defect.updated

Payload fields

Parameter Type Description
id integer Defect ID

Deleted Defect

Payload example:

{
  "event_name": "defect.deleted",
  "timestamp": 1650533058,
  "payload": {
    "id": 1
  },
  "team_member_id": 40,
  "project_code": "ID"
}

{% hint style="info" %} This event is being sent when a defect is deleted. {% endhint %}

Event name

defect.deleted

Payload fields

Parameter Type Description
id integer Defect ID

Resolved Defect

Payload example:

{
  "event_name": "defect.resolved",
  "timestamp": 1650533030,
  "payload": {
    "id": 1
  },
  "team_member_id": 40,
  "project_code": "ID"
}

{% hint style="info" %} This event is being sent when a defect is resolved {% endhint %}

Event name

defect.resolved

Payload fields

Parameter Type Description
id integer Defect ID