Import built-in Templates

Owned by Dheeraj Kumar Aggarwal
Last updated: Jul 27, 2017
2 min read

For quick integration with third party tools, we have provided sample templates for few third party tools. That will also provide you a quick overview of, how a hook can be defined in vREST. You may also write your custom hooks, in case if a built-in hook is not available.

How to import built-in hooks:

Step 1: Import the desired template

  1. Find the "Third Party Integrations" section in left hand side of Hooks Tab.
  2. Click on "Import" button on the desired hook template.
  3. System will ask you, whether you want to import the hook or not? Simply click "Ok" button to proceed further.

Step 2: Fill the hook variables / authorizations:
When you import a hook template, then it creates some variables / authorizations depending on the hook template. You may need to define the values of hook variables / authorizations.

  1. For defining variables, simply select More Menu >> Global Variables / Environments.
  2. For defining authorizations, simply select More Menu >> Authorizations.
  3. Define the values of the hook variables. e.g. 
    1. When you import the JIRA template, then you need to define the following hook variables:
      1. jiraBaseURL
        Define the base URL of your JIRA instance. Please do not add the forward slash at the end of base URL.
      2. jiraProjectKey
        Define the JIRA Project Key in which the issue will be logged based on vREST test case status.
      3. jiraAssigneeName
        Define the JIRA assignee name to which the logged issue will be assigned. 
    2. and when you import the Slack template, then you need to define the following hook variables:
      1. slackWebHookURL
        Define the Slack web hook URL. For more information on this, please visit https://api.slack.com/incoming-webhooks. 
      2. slackUsername
        Define the slack user name.
      3. slackChannel
        Define the slack channel name.
  4. Define the values of hook authorizations. e.g.
    1. When you import the JIRA template, then you need to define the JIRA Authorization. Simply select the Authorization Type as "Basic Authorization" and provide the JIRA user name and password details.

That's it. Hooks are now ready to be executed based on the hook condition defined. 

You may enable / disable individual hooks by selecting the desired hooks and then select "# Selected" >> Enable / Disable option.