GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On (SSO)
Two-Factor Authentication (2FA)
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Integrations
  3. Using the JIRA Action Templates

Using the JIRA Action Templates

You can use the Prebuilt Action Templates from your JIRA integration to auto-create dialog tasks and test them using the Talk to Bot option.

Step to create a dialog task using the JIRA action templates:

  1. Go to Build > Conversation Skills > Dialog Tasks.
  2. Click Create a Dialog Task.
  3. On the Dialog Task pop-up, under the Integration, select the Jira option to view the action templates.
  4. If you have not configured any integration for your virtual assistant, you will see the Explore Integrations option. Once you click this option, you will be redirected to the Actions page to configure an integration for your VA. For more information, see Actions Overview.

JIRA Actions

The following Freshdesk actions are supported in this release:

Supported Tasks Description Method
Create an Issue Creates an issue in the JIRA system. POST
Get an Issue by ID Fetch an issue details with ID from the JIRA system. GET
Get all issues Retrieves all issues from the JIRA system. GET
Update an Issue Updates an issue in the JIRA system. PUT
Delete an issue Deletes an issue from the JIRA system. GET

Create an Issue

Steps to create an issue in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Create an issue dialog task is added with the following components:
    • createIssue – A user intent to create an issue.
    • projectKey, summary, and issueTypeName – Entity nodes for creating the issue in the JIRA system.
    • getResourceIdService – A bot action service to get a resource ID of a JIRA site.
    • createIssueService – A bot action service to create an issue in an external integration. Click the Plus icon to expand to view the createIssueService bot action component properties.
    • In the Component Properties window, click the Edit Request link to edit the request parameters as shown below:

      Sample Request:

      {
      "fields": {
      "summary": "messaging module is not working",
      "issuetype": {
      "name": "Bug"
      },
      "project": {
      "key": "DFJIIP"
      }
      }
      }

      To add one or more responses, scroll down and click the +Add Response button:
      Sample Response:

      {
      "id": "10000",
      "key": "ED-24",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
      "transition": {
      "status": 200,
      "errorCollection": {
      "errorMessages": [],
      "errors": {}
      }
    • createdIssueInfoService – A bot action service to gather more details about an issue in an external integration. Click the Plus icon to expand to view the createdIssueInfoService bot action component properties.
    • createIssueMessage – A message node with the script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to create an issue as shown below:

Get an Issue by Key

Steps to find an issue using the key in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Get Issues by Key dialog task is added with the following components:
    • getIssuebyKey – A user intent to find an issue by key.
    • issueKey – Entity nodes for gathering the required issue details.
    • getResourceIdService – A bot action service to get a resource ID of a JIRA site.
    • getIssuebyKeyService – A bot action service to find an issue in an external integration. Click the Plus icon to expand to view the getIssuebyKeyService bot action component properties.
    • In the Component Properties window, to add one or more responses, scroll down and click +Add Response:

      Sample Response:

      {
      {
      "id": "10002",
      "type": {
      "id": "10000",
      "name": "Dependent",
      "inward": "depends on",
      "outward": "is depended by"
      },
      "inwardIssue": {
      "id": "10004",
      "key": "PR-3",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3",
      "fields": {
      "status": {
      "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
      "name": "Open"
      }
      }
      }
      }
      ],
      "worklog": [
      {
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
      "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "updateAuthor": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "comment": {
      "type": "doc",
      "version": 1,
      "content": [
      {
      "type": "paragraph",
      "content": [
      {
      "type": "text",
      "text": "I did some work here."
      }
      ] }
      ] },
      "updated": "2021-01-18T23:45:00.000+0000",
      "visibility": {
      "type": "group",
      "value": "jira-developers",
      "identifier": "276f955c-63d7-42c8-9520-92d01dca0625"
      },
      "started": "2021-01-17T12:34:00.000+0000",
      "timeSpent": "3h 20m",
      "timeSpentSeconds": 12000,
      "id": "100028",
      "issueId": "10002"
      }
      ],
      "updated": 1,
      "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
      }
      }
      }

    • getIssuebyKeyMessage – A message node with script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to find an issue by key as shown below:

Get All Issues

Steps to view all issues in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Get All Issues dialog task is added with the following components:
    • getAllIssues – A user intent to view all issues.
    • getResourceIdService – A bot action service to get a resource ID of a JIRA site.
    • getAllIssuesService – A bot action service to fetch all issues
      from an external integration. Click the Plus icon to expand to view the getAllIssuesService bot action component properties.
    • In the Component Properties window, to add one or more responses, scroll down and click +Add Response.

      Sample Response:

      {
      "expand": "names,schema",
      "startAt": 0,
      "maxResults": 50,
      "total": 1,
      "issues": [
      {
      "expand": "",
      "id": "10002",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002",
      "key": "ED-1",
      "fields": {
      "watcher": {
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
      "isWatching": false,
      "watchCount": 1,
      "watchers": [
      {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      }
      ] },
      "attachment": [
      {
      "id": 10000,
      "self": "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
      "filename": "picture.jpg",
      "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "key": "",
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "name": "",
      "avatarUrls": {
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"
      },
      "displayName": "Mia Krystof",
      "active": false
      },
      "created": "2023-02-28T09:45:11.830+0000",
      "size": 23123,
      "mimeType": "image/jpeg",
      "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
      "thumbnail": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
      }
      ],
      "sub-tasks": [
      {
      "id": "10000",
      "type": {
      "id": "10000",
      "name": "",
      "inward": "Parent",
      "outward": "Sub-task"
      },
      "outwardIssue": {
      "id": "10003",
      "key": "ED-2",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2",
      "fields": {
      "status": {
      "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
      "name": "Open"
      }
      }
      }
      }
      ],
      "description": {
      "type": "doc",
      "version": 1,
      "content": [
      {
      "type": "paragraph",
      "content": [
      {
      "type": "text",
      "text": "Main order flow broken"
      }
      ] }
      ] },
      "project": {
      "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "avatarUrls": {
      "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000",
      "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
      "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
      "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"
      },
      "projectCategory": {
      "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000",
      "id": "10000",
      "name": "FIRST",
      "description": "First Project Category"
      },
      "simplified": false,
      "style": "classic",
      "insight": {
      "totalIssueCount": 100,
      "lastIssueUpdateTime": "2023-02-28T09:45:09.984+0000"
      }
      },
      "comment": [
      {
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
      "id": "10000",
      "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "body": {
      "type": "doc",
      "version": 1,
      "content": [
      {
      "type": "paragraph",
      "content": [
      {
      "type": "text",
      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
      }
      ] }
      ] },
      "updateAuthor": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "created": "2021-01-17T12:34:00.000+0000",
      "updated": "2021-01-18T23:45:00.000+0000",
      "visibility": {
      "type": "role",
      "value": "Administrators",
      "identifier": "Administrators"
      }
      }
      ],
      "issuelinks": [
      {
      "id": "10001",
      "type": {
      "id": "10000",
      "name": "Dependent",
      "inward": "depends on",
      "outward": "is depended by"
      },
      "outwardIssue": {
      "id": "10004L",
      "key": "PR-2",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2",
      "fields": {
      "status": {
      "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
      "name": "Open"
      }
      }
      }
      },
      {
      "id": "10002",
      "type": {
      "id": "10000",
      "name": "Dependent",
      "inward": "depends on",
      "outward": "is depended by"
      },
      "inwardIssue": {
      "id": "10004",
      "key": "PR-3",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3",
      "fields": {
      "status": {
      "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
      "name": "Open"
      }
      }
      }
      }
      ],
      "worklog": [
      {
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
      "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "updateAuthor": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "comment": {
      "type": "doc",
      "version": 1,
      "content": [
      {
      "type": "paragraph",
      "content": [
      {
      "type": "text",
      "text": "I did some work here."
      }
      ] }
      ] },
      "updated": "2021-01-18T23:45:00.000+0000",
      "visibility": {
      "type": "group",
      "value": "jira-developers",
      "identifier": "276f955c-63d7-42c8-9520-92d01dca0625"
      },
      "started": "2021-01-17T12:34:00.000+0000",
      "timeSpent": "3h 20m",
      "timeSpentSeconds": 12000,
      "id": "100028",
      "issueId": "10002"
      }
      ],
      "updated": 1,
      "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
      }
      }
      }
      ],
      "warningMessages": [
      "The value 'bar' does not exist for the field 'foo'."
      ] }
    • getAllIssuesMessage – A message node with the script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to view all issues as shown below:

Update an Issue

Steps to update an issue in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Update an Issue dialog task is added with the following components:
    • updateIssue – A user intent to update an issue.
    • issueKey, chooseField, updatedSummary, and newLabel – Entity nodes for updating the issue details.
    • prepareUpdateIssuePayloadScript – A bot action service to update an issue in an external integration. Click the Plus icon to expand to view the prepareUpdateIssuePayloadScript bot action component properties.
    • getResourceIdService – A bot action service to get a resource ID of a JIRA site.
    • updateIssueService – A bot action service to update an issue in an external integration. Click the Plus icon to expand to view the updateIssueService bot action component properties.
    • In the Component Properties window, click the Edit Request link to edit the request parameters as shown below:

      Sample Request:

      {
      "update": {
      "summary": [
      {
      "set": "The updated summary"
      }
      ],
      "labels": {
      "add": "Label_to_add_without_space"
      }
      }
      }
    • getIssuebyKeyService – A bot action service to update an issue in an external integration. Click the Plus icon to expand to view the getIssuebyKeyService bot action component properties.
    • updateIssueMessage – A message node with the script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to update an issue as shown below:

Delete an Issue

Note: You can delete an issue only if the JIRA admin or owner of the JIRA project assigns you the permission to delete it. Otherwise, you will not be able to perform this action.

Steps to delete an issue in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Delete an Issue dialog task is added with the following components:
    • deleteIssue – A user intent to delete an issue.
    • issueKey – Entity node to gather key to delete an issue.
    • getResourceIdService – A bot action service to delete a resource ID for an issue in an external integration.
    • deleteIssueService – A bot action service to delete an issue in an external integration. Click the Plus icon to expand to view the deleteIssueService bot action component properties.
    • In the Component Properties window, click the Edit Request link to edit the request parameters as shown below:
    • deleteIssueMessage – A message node with the script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to delete an issue.

Using the JIRA Action Templates

You can use the Prebuilt Action Templates from your JIRA integration to auto-create dialog tasks and test them using the Talk to Bot option.

Step to create a dialog task using the JIRA action templates:

  1. Go to Build > Conversation Skills > Dialog Tasks.
  2. Click Create a Dialog Task.
  3. On the Dialog Task pop-up, under the Integration, select the Jira option to view the action templates.
  4. If you have not configured any integration for your virtual assistant, you will see the Explore Integrations option. Once you click this option, you will be redirected to the Actions page to configure an integration for your VA. For more information, see Actions Overview.

JIRA Actions

The following Freshdesk actions are supported in this release:

Supported Tasks Description Method
Create an Issue Creates an issue in the JIRA system. POST
Get an Issue by ID Fetch an issue details with ID from the JIRA system. GET
Get all issues Retrieves all issues from the JIRA system. GET
Update an Issue Updates an issue in the JIRA system. PUT
Delete an issue Deletes an issue from the JIRA system. GET

Create an Issue

Steps to create an issue in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Create an issue dialog task is added with the following components:
    • createIssue – A user intent to create an issue.
    • projectKey, summary, and issueTypeName – Entity nodes for creating the issue in the JIRA system.
    • getResourceIdService – A bot action service to get a resource ID of a JIRA site.
    • createIssueService – A bot action service to create an issue in an external integration. Click the Plus icon to expand to view the createIssueService bot action component properties.
    • In the Component Properties window, click the Edit Request link to edit the request parameters as shown below:

      Sample Request:

      {
      "fields": {
      "summary": "messaging module is not working",
      "issuetype": {
      "name": "Bug"
      },
      "project": {
      "key": "DFJIIP"
      }
      }
      }

      To add one or more responses, scroll down and click the +Add Response button:
      Sample Response:

      {
      "id": "10000",
      "key": "ED-24",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
      "transition": {
      "status": 200,
      "errorCollection": {
      "errorMessages": [],
      "errors": {}
      }
    • createdIssueInfoService – A bot action service to gather more details about an issue in an external integration. Click the Plus icon to expand to view the createdIssueInfoService bot action component properties.
    • createIssueMessage – A message node with the script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to create an issue as shown below:

Get an Issue by Key

Steps to find an issue using the key in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Get Issues by Key dialog task is added with the following components:
    • getIssuebyKey – A user intent to find an issue by key.
    • issueKey – Entity nodes for gathering the required issue details.
    • getResourceIdService – A bot action service to get a resource ID of a JIRA site.
    • getIssuebyKeyService – A bot action service to find an issue in an external integration. Click the Plus icon to expand to view the getIssuebyKeyService bot action component properties.
    • In the Component Properties window, to add one or more responses, scroll down and click +Add Response:

      Sample Response:

      {
      {
      "id": "10002",
      "type": {
      "id": "10000",
      "name": "Dependent",
      "inward": "depends on",
      "outward": "is depended by"
      },
      "inwardIssue": {
      "id": "10004",
      "key": "PR-3",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3",
      "fields": {
      "status": {
      "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
      "name": "Open"
      }
      }
      }
      }
      ],
      "worklog": [
      {
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
      "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "updateAuthor": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "comment": {
      "type": "doc",
      "version": 1,
      "content": [
      {
      "type": "paragraph",
      "content": [
      {
      "type": "text",
      "text": "I did some work here."
      }
      ] }
      ] },
      "updated": "2021-01-18T23:45:00.000+0000",
      "visibility": {
      "type": "group",
      "value": "jira-developers",
      "identifier": "276f955c-63d7-42c8-9520-92d01dca0625"
      },
      "started": "2021-01-17T12:34:00.000+0000",
      "timeSpent": "3h 20m",
      "timeSpentSeconds": 12000,
      "id": "100028",
      "issueId": "10002"
      }
      ],
      "updated": 1,
      "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
      }
      }
      }

    • getIssuebyKeyMessage – A message node with script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to find an issue by key as shown below:

Get All Issues

Steps to view all issues in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Get All Issues dialog task is added with the following components:
    • getAllIssues – A user intent to view all issues.
    • getResourceIdService – A bot action service to get a resource ID of a JIRA site.
    • getAllIssuesService – A bot action service to fetch all issues
      from an external integration. Click the Plus icon to expand to view the getAllIssuesService bot action component properties.
    • In the Component Properties window, to add one or more responses, scroll down and click +Add Response.

      Sample Response:

      {
      "expand": "names,schema",
      "startAt": 0,
      "maxResults": 50,
      "total": 1,
      "issues": [
      {
      "expand": "",
      "id": "10002",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002",
      "key": "ED-1",
      "fields": {
      "watcher": {
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
      "isWatching": false,
      "watchCount": 1,
      "watchers": [
      {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      }
      ] },
      "attachment": [
      {
      "id": 10000,
      "self": "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
      "filename": "picture.jpg",
      "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "key": "",
      "accountId": "5b10a2844c20165700ede21g",
      "accountType": "atlassian",
      "name": "",
      "avatarUrls": {
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"
      },
      "displayName": "Mia Krystof",
      "active": false
      },
      "created": "2023-02-28T09:45:11.830+0000",
      "size": 23123,
      "mimeType": "image/jpeg",
      "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
      "thumbnail": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
      }
      ],
      "sub-tasks": [
      {
      "id": "10000",
      "type": {
      "id": "10000",
      "name": "",
      "inward": "Parent",
      "outward": "Sub-task"
      },
      "outwardIssue": {
      "id": "10003",
      "key": "ED-2",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2",
      "fields": {
      "status": {
      "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
      "name": "Open"
      }
      }
      }
      }
      ],
      "description": {
      "type": "doc",
      "version": 1,
      "content": [
      {
      "type": "paragraph",
      "content": [
      {
      "type": "text",
      "text": "Main order flow broken"
      }
      ] }
      ] },
      "project": {
      "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "avatarUrls": {
      "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000",
      "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
      "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
      "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"
      },
      "projectCategory": {
      "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000",
      "id": "10000",
      "name": "FIRST",
      "description": "First Project Category"
      },
      "simplified": false,
      "style": "classic",
      "insight": {
      "totalIssueCount": 100,
      "lastIssueUpdateTime": "2023-02-28T09:45:09.984+0000"
      }
      },
      "comment": [
      {
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
      "id": "10000",
      "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "body": {
      "type": "doc",
      "version": 1,
      "content": [
      {
      "type": "paragraph",
      "content": [
      {
      "type": "text",
      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
      }
      ] }
      ] },
      "updateAuthor": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "created": "2021-01-17T12:34:00.000+0000",
      "updated": "2021-01-18T23:45:00.000+0000",
      "visibility": {
      "type": "role",
      "value": "Administrators",
      "identifier": "Administrators"
      }
      }
      ],
      "issuelinks": [
      {
      "id": "10001",
      "type": {
      "id": "10000",
      "name": "Dependent",
      "inward": "depends on",
      "outward": "is depended by"
      },
      "outwardIssue": {
      "id": "10004L",
      "key": "PR-2",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2",
      "fields": {
      "status": {
      "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
      "name": "Open"
      }
      }
      }
      },
      {
      "id": "10002",
      "type": {
      "id": "10000",
      "name": "Dependent",
      "inward": "depends on",
      "outward": "is depended by"
      },
      "inwardIssue": {
      "id": "10004",
      "key": "PR-3",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3",
      "fields": {
      "status": {
      "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
      "name": "Open"
      }
      }
      }
      }
      ],
      "worklog": [
      {
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
      "author": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "updateAuthor": {
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      "accountId": "5b10a2844c20165700ede21g",
      "displayName": "Mia Krystof",
      "active": false
      },
      "comment": {
      "type": "doc",
      "version": 1,
      "content": [
      {
      "type": "paragraph",
      "content": [
      {
      "type": "text",
      "text": "I did some work here."
      }
      ] }
      ] },
      "updated": "2021-01-18T23:45:00.000+0000",
      "visibility": {
      "type": "group",
      "value": "jira-developers",
      "identifier": "276f955c-63d7-42c8-9520-92d01dca0625"
      },
      "started": "2021-01-17T12:34:00.000+0000",
      "timeSpent": "3h 20m",
      "timeSpentSeconds": 12000,
      "id": "100028",
      "issueId": "10002"
      }
      ],
      "updated": 1,
      "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
      }
      }
      }
      ],
      "warningMessages": [
      "The value 'bar' does not exist for the field 'foo'."
      ] }
    • getAllIssuesMessage – A message node with the script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to view all issues as shown below:

Update an Issue

Steps to update an issue in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Update an Issue dialog task is added with the following components:
    • updateIssue – A user intent to update an issue.
    • issueKey, chooseField, updatedSummary, and newLabel – Entity nodes for updating the issue details.
    • prepareUpdateIssuePayloadScript – A bot action service to update an issue in an external integration. Click the Plus icon to expand to view the prepareUpdateIssuePayloadScript bot action component properties.
    • getResourceIdService – A bot action service to get a resource ID of a JIRA site.
    • updateIssueService – A bot action service to update an issue in an external integration. Click the Plus icon to expand to view the updateIssueService bot action component properties.
    • In the Component Properties window, click the Edit Request link to edit the request parameters as shown below:

      Sample Request:

      {
      "update": {
      "summary": [
      {
      "set": "The updated summary"
      }
      ],
      "labels": {
      "add": "Label_to_add_without_space"
      }
      }
      }
    • getIssuebyKeyService – A bot action service to update an issue in an external integration. Click the Plus icon to expand to view the getIssuebyKeyService bot action component properties.
    • updateIssueMessage – A message node with the script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to update an issue as shown below:

Delete an Issue

Note: You can delete an issue only if the JIRA admin or owner of the JIRA project assigns you the permission to delete it. Otherwise, you will not be able to perform this action.

Steps to delete an issue in the JIRA integration:

  1. Refer to the Installing the JIRA templates section to install this template.
  2. The Delete an Issue dialog task is added with the following components:
    • deleteIssue – A user intent to delete an issue.
    • issueKey – Entity node to gather key to delete an issue.
    • getResourceIdService – A bot action service to delete a resource ID for an issue in an external integration.
    • deleteIssueService – A bot action service to delete an issue in an external integration. Click the Plus icon to expand to view the deleteIssueService bot action component properties.
    • In the Component Properties window, click the Edit Request link to edit the request parameters as shown below:
    • deleteIssueMessage – A message node with the script to display responses for various scenarios.
  3. Click the Train tab to complete the Dialog task training.
  4. Click the Talk to Bot icon to test and debug the dialog task.
  5. Follow the prompts in the VA console to delete an issue.
Menu