Cloud
Jira Service Management ops / Reference / REST API

Integration actions

Postman Collection
OpenAPI
GET

List integration actionsExperimental

Lists integration actions of an integration that user can view.

Permissions required: Permission to get the integration action:

  • the user has read-only administrative right.
  • the integration's assigned team is one of the teams that the user belongs to.

Request

Query parameters

type

string

direction

string

domain

string

name

string

offset

integer

size

integer

Responses

Returned if the request is successful.

application/json

IntegrationActions
GET/v1/integrations/{integrationId}/actions
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'
200Response
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" } ] }
POST

Create integration actionExperimental

Creates an integration action.

Permissions required: Permission to create an integration action:

  • the user has read-only administrative right.
  • the user is the admin of the team that the integration belongs to.

Request

Path parameters

integrationId

string

Required

Request bodyapplication/json

type

string

Required
name

string

Required
domain

string

Required
direction

string

Required
groupType

string

extraField

string

filter

Filter

Required
typeSpecificProperties

object

fieldMappings

object

actionMapping

ActionMapping

Responses

Returned if the request is successful.

application/json

IntegrationAction
POST/v1/integrations/{integrationId}/actions
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 }'
200Response
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": "" } }
GET

Get integration actionExperimental

Returns the action of an integration.

Permissions required: Permission to access to the integration action:

  • the user has read-only administrative right.
  • the integration's assigned team is one of the teams that the user belongs to.

Request

Path parameters

integrationId

string

Required
id

string

Required

Responses

Returned if the request is successful.

application/json

IntegrationAction
GET/v1/integrations/{integrationId}/actions/{id}
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'
200Response
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": "" } }
DEL

Delete integration actionExperimental

Deletes an integration action.

Permissions required: Permission to update integration alert filter:

  • the user has read-only administrative right.
  • the user is the admin of the team that the integration belongs to.

Request

Path parameters

integrationId

string

Required
id

string

Required

Responses

Returned if the request is successful.

DEL/v1/integrations/{integrationId}/actions/{id}
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>'
PATCH

Update integration actionExperimental

Updates an integration action.

Permissions required: Permission to update the integration action:

  • the user has read-only administrative right.
  • the user is the admin of the team that the integration belongs to.

Request

Path parameters

integrationId

string

Required
id

string

Required

Request bodyapplication/json

name

string

enabled

boolean

filter

Filter

typeSpecificProperties

object

fieldMappings

object

actionMapping

ActionMapping

Responses

Returned if the request is successful.

application/json

Integration
PATCH/v1/integrations/{integrationId}/actions/{id}
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": {} } }'
200Response
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": "" } }
PATCH

Reorder integration actionExperimental

Reorders an integration action.

Permissions required: Permission to reorder the integration action:

  • the user has read-only administrative right.
  • the user is the admin of the team that the integration belongs to.

Request

Path parameters

integrationId

string

Required
id

string

Required

Request bodyapplication/json

successorId

string

Responses

Returned if the request is successful.

PATCH/v1/integrations/{integrationId}/actions/{id}/order
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: