Qase Docs
Help CenterAPI DocsRoadmapSign up for free
  • General
    • Qase docs
    • Get started with the Qase platform
      • Account settings
      • Projects
      • Test suites
      • Test cases
        • Test Case Parameters
        • Test case review
        • Shared steps
        • Import test cases
        • Export test cases
        • Trash bin
        • Muted Tests
        • System fields
        • Nested steps
        • Test case actions
        • Filters
      • Requirements Traceability Report
      • AI Test Case Generator
    • Execute testing
      • Test plan
      • Test runs
      • Configurations
      • Environments
    • Issues tracking
      • Defects
      • Milestones
      • Requirements
    • Analytics
      • Dashboards
      • Queries (QQL, Qase Query Language)
      • Saved queries
    • Webhooks
      • Test Case
      • Test suite
      • Test plan
      • Shared step
      • Milestone
      • Custom field
      • Test run
      • Defect
      • Test review
  • AIDEN
    • AIDEN - QA Architect
  • Guide: Action editor
  • Administration
    • Workspace management
      • Users
      • Invites
      • Groups
      • Roles
      • Fields
      • Custom fields
      • Notifications
      • Tags
      • Attachments
      • Audit logs
      • Hotkeys
    • SSO / SAML instructions
      • AzureAD
      • OneLogin
      • Google Workspace
      • Okta
      • JumpCloud
    • SCIM
      • User lifecycle management with SCIM
      • Enable SCIM
      • Users
      • Discovery features
      • Errors
    • Security
      • SOC 2 Type II / SOC 3
      • ISO/IEC 27001:2022
      • Penetration testing report
      • Subprocessors
      • Qase IP addresses
    • Billing
      • Billing options
    • Subscriptions
      • Free plan
      • Startup plan
      • Business plan
      • Enterprise plan
  • Apps
    • Issue tracking
      • Jira Cloud
      • Jira Server/Datacenter Plugin installation
      • GitHub
      • Asana
      • Linear
      • Monday
      • ClickUp
      • Trello
      • Azure DevOps
      • GitLab
      • YouTrack
      • Redmine
    • CI/CD
      • Jenkins
      • BitBucket
      • GitHub CI
      • GitLab CI
    • Chats
      • Slack
  • Automation
    • Qase API
    • Reporters
      • JavaScript
        • Playwright
        • Cypress
        • Mocha
        • Newman
        • Jest
        • WebDriverIO
        • CucumberJS
        • TestCafe
      • Python
        • Pytest
        • Robot Framework
        • Behave
        • Tavern
      • Java
        • TestNG
        • JUnit 4
        • JUnit 5
        • Cucumber 3 (jvm)
        • Cucumber 4 (jvm)
        • Cucumber 5 (jvm)
        • Cucumber 6 (jvm)
        • Cucumber 7 (jvm)
      • PHP
        • PHPUnit
        • Codeception
      • Kotlin
        • Kaspresso
    • Qase CLI App
      • XCTest
Powered by GitBook
On this page
  • Created Test Case
  • Cloned Test Case
  • Updated Test Case
  • Deleted Test Case
  1. General
  2. Webhooks

Test Case

Created Test Case

Payload example:

{
  "event_name": "case.created",
  "timestamp": 1650530190,
  "payload": {
    "id": 1610,
    "title": "Example test case",
    "description": "Description test case",
    "preconditions": "something",
    "postconditions": "something",
    "priority": {
      "id": 2,
      "title": "Medium",
      "icon": "genderless",
      "color": "medium"
    },
    "severity": {
      "id": 4,
      "title": "Normal",
      "icon": "genderless",
      "color": "normal"
    },
    "behavior": {
      "id": 2,
      "title": "Positive"
    },
    "type": {
      "id": 8,
      "title": "Functional"
    },
    "automation": {
      "id": 1,
      "title": "To be automated"
    },
    "status": {
      "id": 0,
      "title": "Actual"
    },
    "suite_id": 12,
    "milestone_id": null,
    "steps": [
      {
        "position": 1,
        "action": "simple action",
        "expected_result": "expected result",
        "data": "input data",
        "attachments": [],
        "shared": false
      }
    ],
    "attachments": [],
    "custom_fields": [
      {
        "id": 174,
        "title": "Test Number",
        "type": "number",
        "value": "1"
      }
    ]
  },
  "team_member_id": 40,
  "project_code": "ID"
}

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

Event name

case.created

Payload fields

Parameter
Type
Description

id

integer

Test case title

title

string

Test case title

description

string

Test case description

preconditions

string

Test case preconditions

postconditions

string

Test case postconditions

severity

object

An object of test case severity

priority

object

An object of test case priority

type

object

An object of test case type

status

object

An object of test case status

automation

object

An object of test case automation status

behavior

object

An object of test case behavior

suite_id

integer

Suite ID (nullable)

milestone_id

integer

Milestone_id (nullable)

steps

array

An array of test steps objects.

attachments

array

An array of attachments ids.

custom_fields

array

An array of custom fields objects.

Step object

Parameter
Type
Description

position

integer

Step position

action

string

Required field (if shared_step_id is not provided). Can't be empty.

expected_result

string

shared

boolean

Actual status step

attachments

array

An array of attachments IDs.

Custom field object

Parameter
Type
Description

id

integer

Custom field ID

title

string

Custom field title

value

string

Available only for selectbox fields. An object with selectbox values.

type

string

Custom field type. Available values: number, string, text, selectbox, checkbox.

Cloned Test Case

Payload example:

{
  "event_name": "case.cloned",
  "timestamp": 1650530878,
  "payload": {
    "id": 1611,
    "from_id": 1610
  },
  "team_member_id": 40,
  "project_code": "ID"
}

This event is being sent when a test case is cloned.

Event name

case.cloned

Payload fields

Parameter
Type
Description

id

integer

Test case ID (clone)

from_id

integer

Test case ID (original)

Updated Test Case

Payload example:

JSON

{
  "event_name": "case.updated",
  "timestamp": 1650530630,
  "payload": {
    "id": 1610
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a test case is updated. It returns only ID of test case and notifies that fields were updated.

Event name

case.updated

Payload fields

Parameter
Type
Description

id

integer

Test case ID

Deleted Test Case

Payload example:

{
  "event_name": "case.deleted",
  "timestamp": 1650530938,
  "payload": {
    "id": 1611
  },
  "team_member_id": 40,
  "project_code": "ID"
}

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

Event name

case.deleted

Payload fields

Parameter
Type
Description

id

integer

Test case ID

PreviousWebhooksNextTest suite

Last updated 5 months ago