This resource represents Integration Actions in Jira Service Management. Use it to get, list, create, update, delete or reorder of actions of an integration.
Lists integration actions of an integration that user can view.
Permissions required: Permission to get the integration action:
read:ops-config:jira-service-managementstring
string
string
string
integer
integer
Returned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{integrationId}/actions' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"links": {
"next": "/v1/integrations/12fa0a15-4b2f-470c-91ac-2a8cb06a4cc2/actions?offset=1&size=1"
},
"values": [
{
"id": "1687265768289000040",
"name": "postToUrl",
"type": "postToUrl",
"direction": "outgoing",
"domain": "alert",
"actionMappingType": "create",
"groupType": "forwarding"
}
]
}Creates an integration action.
Permissions required: Permission to create an integration action:
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
Requiredstring
Requiredstring
Requiredstring
Requiredstring
string
Filter
Requiredobject
object
ActionMapping
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{integrationId}/actions' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"type": "create",
"name": "Create Alert2",
"domain": "alert",
"direction": "incoming",
"groupType": "",
"extraField": "",
"filter": {
"conditionsEmpty": true,
"conditionMatchType": "match-all",
"conditions": []
},
"typeSpecificProperties": {},
"fieldMappings": {
"note": "",
"description": "{{message}}",
"source": "Email",
"message": "{{subject}}",
"priority": "{{priority}}",
"tags": [],
"alias": "",
"details": {
"From": "{{from_address}}"
},
"user": "",
"actions": [],
"entity": ""
},
"actionMapping": {
"type": "<string>",
"parameter": {}
},
"enabled": true
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"id": "1704982046651000029",
"type": "create",
"name": "Create Alert2",
"domain": "alert",
"direction": "incoming",
"filter": {
"conditionsEmpty": false,
"conditionMatchType": "match-all",
"conditions": []
},
"typeSpecificProperties": {
"keepRespondersFromPayload": false,
"appendAttachments": true,
"keepTagsFromPayload": true,
"keepActionsFromPayload": true,
"keepExtraPropertiesFromPayload": true
},
"fieldMappings": {
"note": "",
"description": "{{message}}",
"source": "Email",
"message": "{{subject}}",
"priority": "{{priority}}",
"responders": [
{
"type": "team",
"id": "8ae8a0a2-1122-5566-8899-11b82bbd85c9"
}
],
"tags": [],
"alias": "",
"details": {
"From": "{{from_address}}"
},
"user": "",
"actions": [],
"entity": ""
}
}Returns the action of an integration.
Permissions required: Permission to access to the integration action:
read:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{integrationId}/actions/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"id": "1704982046651000029",
"type": "create",
"name": "Create Alert2",
"domain": "alert",
"direction": "incoming",
"filter": {
"conditionsEmpty": false,
"conditionMatchType": "match-all",
"conditions": []
},
"typeSpecificProperties": {
"keepRespondersFromPayload": false,
"appendAttachments": true,
"keepTagsFromPayload": true,
"keepActionsFromPayload": true,
"keepExtraPropertiesFromPayload": true
},
"fieldMappings": {
"note": "",
"description": "{{message}}",
"source": "Email",
"message": "{{subject}}",
"priority": "{{priority}}",
"responders": [
{
"type": "team",
"id": "8ae8a0a2-1122-5566-8899-11b82bbd85c9"
}
],
"tags": [],
"alias": "",
"details": {
"From": "{{from_address}}"
},
"user": "",
"actions": [],
"entity": ""
}
}Deletes an integration action.
Permissions required: Permission to update integration alert filter:
read:ops-config:jira-service-managementdelete:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{integrationId}/actions/{id}' \
--user 'email@example.com:<api_token>'Updates an integration action.
Permissions required: Permission to update the integration action:
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
Requiredstring
boolean
Filter
object
object
ActionMapping
Returned if the request is successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{integrationId}/actions/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Updated action name",
"enabled": false,
"filter": {
"conditionsEmpty": true,
"conditionMatchType": "match-all",
"conditions": []
},
"typeSpecificProperties": {},
"fieldMappings": {
"note": "",
"description": "{{message}}",
"source": "Email",
"message": "{{subject}}",
"priority": "{{priority}}",
"tags": [],
"alias": "",
"details": {
"From": "{{from_address}}"
},
"user": "",
"actions": [],
"entity": ""
},
"actionMapping": {
"type": "<string>",
"parameter": {}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"id": "1704982046651000029",
"type": "create",
"name": "Updated action name",
"domain": "alert",
"direction": "incoming",
"filter": {
"conditionsEmpty": false,
"conditionMatchType": "match-all",
"conditions": []
},
"typeSpecificProperties": {
"keepRespondersFromPayload": false,
"appendAttachments": true,
"keepTagsFromPayload": true,
"keepActionsFromPayload": true,
"keepExtraPropertiesFromPayload": true
},
"fieldMappings": {
"note": "",
"description": "{{message}}",
"source": "Email",
"message": "{{subject}}",
"priority": "{{priority}}",
"responders": [
{
"type": "team",
"id": "8ae8a0a2-1122-5566-8899-11b82bbd85c9"
}
],
"tags": [],
"alias": "",
"details": {
"From": "{{from_address}}"
},
"user": "",
"actions": [],
"entity": ""
}
}Reorders an integration action.
Permissions required: Permission to reorder the integration action:
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
Requiredstring
Returned if the request is successful.
1
2
3
4
5
6
7
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/integrations/{integrationId}/actions/{id}/order' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"successorId": "<string>"
}'Rate this page: