qTest Pulse Quick Start Guide


qTest Pulse is a workflow engine for products in the qTest Platform and is currently optimized to integrate BDD workflows for qTest Scenario-BDD for Jira.  It works behind the scenes to integrate Jira software with Jenkins, Slack, and many different plugins to increase productivity within your development process.  Once you establish and set up your Pulse 'Rules', you will be integrated.

'Pulse Rules' consist of Events and Actions, which are ultimately an 'if this event occurs, then I want Pulse to perform this action'. The Event occurs using a webhook and the Action is performed using program code.

Access and Login

Your qTest Site Administrator must create a new Admin User profile with only 'Pulse Access' selected. This will allow an end user to be assigned this Admin User Profile and have the ability to access and use Pulse, without gaining any additional administrative privileges.

 HINT: The default Administrators profile will also have 'Pulse Access'. One user can be assigned multiple Admin User Profiles.

Once the new 'Admin Profile' is active, you will need to assign this profile to users in the Licenses - Users tab.  In the example below, two users will both receive access to qTest Pulse although they have different Admin profiles. This is because both Admin profiles have the Pulse Access user right.

  • AJ Ford - 'Administrators'
  • Ali Huffstetler - 'Pulse Access User'


Once your username has Pulse access, you can log in to qTest Pulse from the  9-box icon. Pulse will open in a separate browser window from your Manager instance.


Pulse Rules are a combination of 'Events' (webhooks) and 'Actions' (program code.) We have sample program code 'Actions' available, so you can begin setting up your Pulse application. These are available in the QAS public GitHub repository. There is also an Import/Export option available that will allow you to move your pulse rules from one project to another.

Access Sample Pulse Rules in GitHub

  1. Login to your GitHub account and type 'PulseRules' in the GitHub search bar.
  2. Select the QASymphony/PulseRules repository that displays.
  3. The sample rules are available from the Code tab.

  4. Before you begin, read the '' File first. This is located on the Code tab as well. These instructions will assist you with using the supplied Pulse Rules Actions.
  5. You can view the Pulse Rules category of this User Guide for sample Rules/Actions. These are the same Rules/Actions you will find in the GitHub repository.

Sample Pulse Rules

Below are direct links to the sample Pulse Rules Actions (program code.)

 Setup Pulse Rules

  1. Login to your qTest Manager application.
  2. Select the Pulse application from the 9-box icon 9_box.png .
  3. Select the appropriate Project in the project drop-down where you want to establish new Pulse Rules. The projects listed here are the same projects you will find in Manager.
  4. The page will load and display the Rules tab by default for the selected project.

Events (webhook)

The Pulse Event is a unique webhook produced by the application that will not only be used to create your Pulse Rule, but it will also be entered into the separate application tool for complete integration.
Example: You want to create a Pulse Rule so that you receive a message from Slack when XYZ happens. You will create your Event, named 'SlackEvent', and the webhook URL that is produced by Pulse (in the Events section) will also be entered into your Slack application.

  1. In the Events section, select the add.png icon to add an Event. The Add Event widget opens.
  2. Name the Event to be descriptive for what it is accomplishing. Once, the Event is named, the Submit option will enable.
    • Note: The Webhook URL will auto-populate with a unique value. If you are using an SSL configuration the webhook produced will include https. 
  3. Select Submit and the Event will display in the Events section of the screen.

So far, you have created the Event (webhook) that you will enter into the external application tool. Now, you need to enter the Pulse Action (program code.)

Actions (program code)

The Pulse Action is the program code that you want to execute as part of a rule.
Example: if you want to pass a payload to the action, you could send a message to any other tool with an available API using Javascript.

  1. In the Actions section, select the add.png icon to add an Action. The Add Action widget opens.
  2. Name the Action to be descriptive for what it is accomplishing. Once the Action is named, the Submit option will enable.
  3. Optional: provide a Description.
  4. Enter the sample Program Code provided in the QAS repository. 
    Note: For the most up to date sample program code, view the QASymphony/PulseRules repository.
  5. Select Submit and the Action will display in the Actions section of the screen.Add_Action.png

Create the Rule

To create a Pulse Rule, you need to link the Event and Action.

  1. Select the add_Rule.png button at the bottom of the screen. The Add Rule widget opens.
  2. Name the Rule.
  3. In the Event section, select the appropriate 'Active Webhook' from the drop-down.
  4. Enter any Conditions.
  5. In the Actions section, select the appropriate code program Action.
  6. To enable the rule, select the Enabled checkbox.
  7. Select Submit to save.

Import/Export Pulse Rules

You have the ability to import and export Pulse Rules from one project to another. You can also export all of the Sample Pulse Rules provided by QASymphony that are located in the QASymphony/PulseRules repository in GitHub. You will then need to import these Rules into your own Pulse application/project.
Note: For the most up to date sample program code, view the QASymphony/PulseRules repository.

  • Import-creates a unique Event webhook for the new project.
  • Export-includes constants names but you will need to enter your own values into the new project. New values will need to be entered each time you export rules from one project to another. Export is a .json file.

Setup Pulse Constants

The Pulse Constants tab is where you can create a list of Constants (name and value pairs) that are stored per project. These are accessible in your action code using the always available, constants JSON object.

  1. From the Pulse application, select the Constants tab.
  2. The Constants page loads.
  3. Select the Pulse Constants icon pulse_constants_icon.png.
  4. The Pulse Constants widget loads and you can enter the Name and Value. Submit.
    The Constants entered here will be exported when you select the Export icon on the Pulse Rules page. These will export the name, but you will need to enter new values when exporting into a new project.
Subscribe To Our Blog
Powered by Zendesk