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 Custom Field
  • Deleted Custom Field
  • Updated Custom Field
  1. General
  2. Webhooks

Custom field

Created Custom Field

Payload example:

{
  "event_name": "custom_field.created",
  "timestamp": 1650533521,
  "payload": {
    "id": 208,
    "title": "test",
    "isRequired": false,
    "isFilterable": false,
    "isVisible": true,
    "default_value": "5",
    "value": "[]",
    "type": "number",
    "entity": "case"
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a new custom field is created.

Event name

custom_field.created

Payload fields

Parameter
Type
Description

id

integer

Custom field ID

title

string

Custom field title

isRequired

boolean

A boolean value that indicates, that custom field should be filled on case create/update page.

isFilterable

boolean

A boolean value that indicates, that custom field will be shown in filters

isVisible

boolean

A boolean value that indicates, that custom field will be visible in preview and on test case page.

default_value

string

Default value for custom field

value

string

type

string

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

entity

string

Custom field entity. Available values: case, defect, run

Deleted Custom Field

Payload example:

{
  "event_name": "custom_field.deleted",
  "timestamp": 1650533655,
  "payload": {
    "id": 208,
    "title": "test",
    "isRequired": false,
    "isFilterable": false,
    "isVisible": true,
    "default_value": "5",
    "value": "[]",
    "type": "number",
    "entity": "case"
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a custom field is deleted.

Event name

custom_field.deleted

Payload fields

Parameter
Type
Description

id

integer

Custom field ID

title

string

Custom field title

isRequired

boolean

A boolean value that indicates, that custom field should be filled on case create/update page.

isFilterable

boolean

A boolean value that indicates, that custom field will be shown in filters

isVisible

boolean

A boolean value that indicates, that custom field will be visible in preview and on test case page.

default_value

string

Default value for custom field

value

string

type

string

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

entity

string

Custom field entity. Available values: case, defect, run

Updated Custom Field

Payload example:

{
  "event_name": "custom_field.updated",
  "timestamp": 1650533629,
  "payload": {
    "id": 208,
    "title": "test",
    "isRequired": false,
    "isFilterable": false,
    "isVisible": true,
    "default_value": "5",
    "value": "[]",
    "type": "number",
    "entity": "case"
  },
  "team_member_id": 40,
  "project_code": "ID"
}

📘

This event is being sent when a custom field is updated.

Event name

custom_field.updated

Payload fields

Parameter
Type
Description

id

integer

Custom field ID

title

string

Custom field title

isRequired

boolean

A boolean value that indicates, that custom field should be filled on case create/update page.

isFilterable

boolean

A boolean value that indicates, that custom field will be shown in filters

isVisible

boolean

A boolean value that indicates, that custom field will be visible in preview and on test case page.

default_value

string

Default value for custom field

value

string

type

string

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

entity

string

Custom field entity. Available values: case, defect, run

PreviousMilestoneNextTest run

Last updated 2 years ago