Test case variables

This guide explains and lists the reference for variables available in Test Management webhook payloads when a test case is created, updated, deleted, or archived.

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.

Before you begin

You configure webhooks once for your account and use them across all BrowserStack products. To create a webhook and subscribe it to test case events, follow Get started with webhooks. For platform-wide concepts, see Core concepts.

Events that include test case variables

A webhook payload contains test case variables when one of the following events trigger.

Available variables

TC_ATTACHMENTS structure

[
  {
    "size": "200 KB",
    "name": "diagram.jpg",
    "content_type": "image/jpeg",
    "url": "https://.../diagram.jpg?AWSAccessKeyId=...&Expires=...&Signature=..."
  },
  {
    "size": "50 KB",
    "name": "report.pdf",
    "content_type": "application/pdf",
    "url": "https://example.com/attachments/report.pdf"
  }
]

Reference variables in your payload

Wrap each variable in handlebars when you reference it in a webhook URL, header, or payload body. For example: ``.

For payload templates and worked examples, see Get started with webhooks.

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.

Next steps

• Test plan variables
• Test result variables
• Test Management API reference