Microsoft Teams Jira Connect Server API documentation

Version 3+

The base API URL path <JIRA_BASE_URL>/rest/microsoft-teams/1.0

CODE

GET /rest/microsoft-teams/1.0/configurations[?projectKey={PROJECT_KEY}]
POST /rest/microsoft-teams/1.0/configurations
DELETE /rest/microsoft-teams/1.0/configurations/{ID}

GET /rest/microsoft-teams/1.0/configurations/supported-events

GET /rest/microsoft-teams/1.0/configurations/excluded-projects
POST /rest/microsoft-teams/1.0/configurations/excluded-projects
DELETE /rest/microsoft-teams/1.0/configurations/excluded-projects/{ID}

Where the projectKey is an optional filter.

Example of the configuration object used to get and set configurations.

CODE

{
   "enabled":true,
   "name":"Config Name",
   "destinations":[
      {
         "useUrl":true,
         "url":"https://some.url.com/test",
         "urlId":0,
         "useBot":false
      }
   ],
   "sources":[
      {
         "projectKey":"TEST"
      }
   ],
   "ignoredSources":[
      {
         "projectKey":"TP"
      }
   ],
   "users":[
      {
         "userKey": "KEY1"
      }
   ],
   "ignoredUsers":[
      
   ],
   "groups":[
      
   ],
   "ignoredGroups":[
      
   ],
   "level":"GLOBAL",
   "noMessageDetails":false,
   "includeAttachments":false,
   "events":[
      "ISSUE_CREATED",
      "ISSUE_COMMENTED",
      "ISSUE_RESOLVED",
      "ISSUE_GENERICEVENT",
      "ISSUE_COMMENT_EDITED",
      "ISSUE_COMMENT_DELETED"
   ],
   "issueTypes":[
      "10002"
   ],
   "issuePriorities":[
      "2"
   ],
   "issueStatuses":[
      "10000",
      "10001",
      "3"
   ],
   "issueAllEventsStatuses":[
      "10000",
      "3"
   ],
   "components":[
      
   ],
   "customFields":[
      
   ],
   "customFieldsMatchingStrategy":"ALL",
   "customFieldUpdates":[
      
   ],
   "messageFields":[
      "project",
      "issuetype",
      "status",
      "assignee",
      "issuekey"
   ],
   "assignees":[
      
   ],
   "labels":[
      
   ],
   "labelMatchingStrategy":"ALL",
   "ignoredLabels":[
      
   ],
   "ignoredLabelMatchingStrategy":"ALL",
   "watchers":[
      
   ],
   "watcherUserInfos":[
      
   ],
   "assigneeUserInfos":[
      
   ],
   "userInfos":[
      
   ],
   "ignoredUserInfos":[
      
   ],
   "configurationTags":{
      
   },
   "owner":{
      "userKey":"admin",
      "displayName":"admin"
   },
   "jql":"",
   "useJql":false,
   "jiraFilter":{
      "useFilter":false
   },
   "notShowEmptyFields":false
}

GET /rest/microsoft-teams/1.0/configurations/supported-events

Gets supported event types

JSON

[{
  "id": "ISSUE_CREATED",
  "label": "Issue created"
}]

Updated: 21 Sep 2021