Skip to main content
Experience faster, smarter testing with BrowserStack AI Agents. See what your workflow’s been missing. Explore now!
No Result Found
Connect & Get help from fellow developers on our Discord community. Ask the CommunityAsk the Community

Test plan variables

Test plan variables that are available through our webhooks, designed to provide comprehensive insights into your test execution plans. These variables enable you to integrate test plan data directly into their custom applications, reporting tools, or automation scripts. By leveraging these variables, you can access critical information such as plan status, progress, associated project details, and key metrics like the count of passed, failed, or blocked test cases. Following is a detailed list of each variable, its description, and an example of its expected value or format.

Events (Trigger conditions)

Webhooks for test plan variables are triggered when significant actions related to a test plan’s lifecycle occur. These events are crucial for synchronizing your external systems with the state and progress of your test plans. The following actions will trigger a webhook payload containing test plan variables:

  • Test plans created: Triggered when a new test plan is established in the system.

  • Test plans updated: Triggered when any details or attributes of an existing test plan are modified.

  • Test plans completed: Triggered when a test plan reaches its Completed status.

  • Test plans deleted: Triggered when a test plan is permanently removed from the system.

Variable name Description / Example
PROJECT_ID The unique identifier for the project to which the test plan belongs.
Example: PR-123
TP_ID The unique identifier for the test plan.
Example: TP-123
TP_TITLE The title or name of the test plan.
Example: Regression Plan
TP_STATE The current state of the test plan.
Example: Active, Completed
TP_STATUS The overall progress or status of the test plan.
TP_DESCRIPTION A detailed description of the test plan, typically in markdown format.
Example: This plan covers all critical regression test cases for the Q2 release.
TP_START_DATE The start date and time of the test plan in ISO 8601 format.
Example: 2024-05-08T12:45:34.651+00:00
TP_END_DATE The end date and time of the test plan in ISO 8601 format.
Example: 2024-05-08T12:45:34.651+00:00
TP_ACTIVE_TR_COUNT The number of active test runs associated with this test plan.
Example: 3
TP_CLOSED_TR_COUNT The number of closed test runs associated with this test plan.
Example: 4
TP_TOTAL_PASSED_TC The total count of test cases within this test plan that have a Passed status.
Example: 1
TP_TOTAL_FAILED_TC The total count of test cases within this test plan that have a Failed status.
Example: 4
TP_TOTAL_BLOCKED_TC The total count of test cases within this test plan that have a Blocked status.
Example: 5

These test plan variables are essential for creating dynamic and responsive integrations that react to the lifecycle and progress of your testing efforts through webhooks. By incorporating these details you can automate notifications, update external dashboards, and ensure all stakeholders are informed about the state of your test plans. 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





Thank you for your valuable feedback

Is this page helping you?

Yes
No

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!

Talk to an Expert
Download Copy Check Circle