Cloud
Incidents / Reference / REST API

Chat tools

Postman Collection
OpenAPI

This resource represents chat tools to a Jira Service Management Incident. Use this resource to create, remove and fetch chat channels to an Incident. See how to Connect Slack with Jira Service Management for details. One you've connected Slack, you can use this resource to create Slack channel to the Incident. Once a Slack channel has been created, you can perform several incident actions through that channel.

GET

Get chat channelsExperimental

Returns all chat channels available to a Jira Service Management Incident.

Request

Path parameters

issueID

integer

Required

Responses

Returned if the request is successful.

application/json

GetChatChannelResponse
GET/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "channels": [ { "active": true, "connectionId": "e3cc821f-cd95-4cc7-a24f-fa855dd19677", "channelType": "slack", "name": "sip-0" } ] }
POST

Create chat channelExperimental

Create a new chat channel to a Jira Service Management Incident.

Request

Path parameters

issueID

integer

Required

Request bodyapplication/json

connectionId

string

Required
channelType

string

Required
channelName

string

Required
channelDescription

string

Required

Responses

Returned if the request is successful.

POST/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel/create
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel/create' \ --header 'Content-Type: application/json' \ --data '{ "connectionId": "e3cc821f-cd95-4cc7-a24f-fa855dd19677", "channelType": "slack", "channelName": "foo-channel-5", "channelDescription": "good-channel" }'
DEL

Unlinks the chat channel from the Jira Service Management Incident.

issueID

integer

Required
connectionId

string

Required
channelType

string

Required

Returned if the request is successful.

DEL/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel/unlink
1 2 3 4 5 6 7 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel/unlink' \ --header 'Content-Type: application/json' \ --data '{ "connectionId": "e3cc821f-cd95-4cc7-a24f-fa855dd19677", "channelType": "slack" }'

Rate this page: