Apply template with REST API

With Issue Templates for Jira you’re not limited to using a template with Jira only. You can also use external software to trigger different events in Jira and apply a template immediately.

With this feature you can:

• Connect this function with Zapier, Jenkins, or Bitbucket for example, to automatically create an issue and apply a template with data from a received e-mail.
• Use templates from Jira Automation and apply them to an issue in any moment on any action in automation.
• Synchronize it with Requirements and Test Management for Jira , so when a user creates an issue with a specific status a selected template can be applied and values filled.

Configuration - Generate a token

To connect Issue Templates with external software to use API, you need to generate a token.

1. Go to Api Tokens tab in the global configuration of Issue Templates (Marketplace Apps>Issue Templates>Configuration>API Tokens).

2. Click Generate WebTrigger URL.

   

3. Your Web Trigger URL has been generated. Don’t share the URL publicly. If you use the URL in a configuration and delete the URL later with the bin button, your configuration will stop working.

4. Click Generate token to create a new token for a specific user.

   

5. Create a Label and select a user that you want to generate the token for.
   

   

6. A token is generated for this user.

   Warning

   Make sure you copy and store the token, because it won’t be accessible later.

   

Configuration - REST API

Follow these steps to use REST API (with Postman as an example). In this scenario a specific template will be applied to a specific issue.

1. Select GET and paste the WebTrigger URL created earlier.

2. Insert templateId and issueId.

   Info

   • issueId is the ID of an issue that you want the template to be applied to

   • templateId is the issue key of a template you want to use.

     You can use both issuekey and issueId parameters.

     Go to Atlassian documentation to find out how to check an issue ID.

   

3. Navigate to the Authorization tab.

4. Paste the user token that you copied when it was created.

5. Click Send.

   

Result

Configuration - REST API in Jira Automation

You can use REST API with Jira Automation.

In this scenario you can apply a specific template to each new issue that is created. Follow the steps below:

1. Create a new Automation rule and set When: Work item created.
2. Select Then and choose Send web request.
3. Enter your WebTrigger URL that was generated earlier in Issue Templates for Jira and add issueId={{issue.id}}&templateId=10032 at the end.

4. Set the HTTP method to GET.
5. Make sure your Web request body is Empty.
6. As a key use Authorization and as a value use the user token that was generated earlier.

Result

Whenever a new issue is created the automation rule will apply template with the ID 10032 to that issue.