Test case variables
Test case variables available within our webhooks provide comprehensive details about your test cases. It allows you to build robust integrations and automate workflows based on real-time test data. By leveraging these variables, you can access specific attributes of a test case, such as its title, ID, status, and associated assets, directly within their webhook payloads. This guide outlines each available variable, its description, and an example of its typical value or structure.
Events (Trigger conditions)
Webhooks for test case variables are triggered when specific actions related to a test case occur within the system. Understanding these events will help you configure your webhook listeners to respond precisely when the relevant data changes. The following actions will trigger a webhook payload containing test case variables:
-
Test case created: Triggered when a new test case is added to the system.
-
Test case updated: Triggered when any attribute of an existing test case is modified.
-
Test case deleted: Triggered when a test case is permanently removed from the system.
-
Test case archived: Triggered when a test case’s status changes to
archived
.
Variable name | Description | Example |
---|---|---|
TC_ID |
Unique identifier for the test case. | TC-101 |
TC_TITLE |
Title of the test case. | Verify sign in function |
TC_TYPE |
Category or type of the test case. |
Smoke , Functional , Acceptance
|
TC_STATE |
Current state of the test case. |
Active , Draft
|
TC_FOLDER_ID |
ID of the folder containing the test case. | 53491 |
TC_REQUIREMENTS |
List of requirements mapped to the test case. | ["REQ-1", "REQ-2"] |
TC_TAGS |
Tags for categorization. | ["Smoke", "Sanity"] |
TC_AUTOMATION_STATUS |
Automation status of the test case. |
Automated , Not Automated
|
TC_TEMPLATE |
Template used for the test case (e.g., steps, free text). | Steps |
TC_DESCRIPTION |
Detailed description, typically in Markdown. | See body content |
TC_PRECONDITION |
Preconditions to satisfy before execution, in Markdown. | User is logged out |
TC_STEPS |
Steps and expected results, in Markdown. |
1. Navigate to login page *Expected:* Login page appears
|
TC_OWNER |
Email of the test case owner. | john.doe@example.com |
TC_CUSTOM_FIELDS |
Custom fields object with key/value pairs. | {"Module":"Authentication","Severity":"High"} |
TC_PRIORITY |
Priority level of the test case. |
High , Medium , Low
|
TC_ATTACHMENTS |
Array of attachment objects associated with the test case. | See JSON example below |
Example of TC_ATTACHMENTS
[
{
"size": "200 KB",
"name": "3.jpg",
"content_type": "image/jpeg",
"url": "https://.../3.jpg?AWSAccessKeyId=...&Expires=...&Signature=..."
},
{
"size": "50 KB",
"name": "report.pdf",
"content_type": "application/pdf",
"url": "https://example.com/attachments/report.pdf"
}
]
These test case variables are designed to give you granular control and detailed insights into your test management processes through webhooks. By correctly parsing and utilizing these variables in your custom integrations, you can streamline reporting, trigger external actions, and maintain synchronized data across your development and testing tools. If you have any further questions or require additional variables, refer to our full API documentation or contact our support team.
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!