Cloud
Jira Service Management ops / Reference / Integration Events API

Integration events

This resource represents the contract to create/acknowledge/close/add note actions of alerts in Jira Service Management. API key is the basic authentication method used by the integration event APIs. Hence, use API keys in your integration events instead of API tokens.

POST

Create alert

The endpoint allows users to programmatically generate alerts with customized parameters. It integrates with existing systems to transform raw data into actionable alerts, ensuring timely notifications.

Request

Header parameters

Authorization

string

Required

Request bodyapplication/json

message

Message

Required
alias

Alias

description

Description

responders

array<Responder>

visibleTo

array<VisibleTo>

actions

array<string>

tags

array<string>

details

ExtraProperties

entity

Entity

source

Source

Responses

Returned if the request validation is successful.

application/json

AsyncSuccessResponse
POST/jsm/ops/integration/v2/alerts
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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/integration/v2/alerts' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "message": "The CPU usage on Server XYZ has exceeded 80% for over 5 minutes.", "alias": "DatabaseConnectionFailure_DatabaseServer1", "description": "The alert is triggered due to the high CPU usage on Server XYZ. The CPU usage has consistently been above 80% for more than 5 minutes which could potentially lead to server slowdown or even a crash. Suggested action is to investigate the processes consuming high CPU and optimize or terminate them as needed. If the issue persists, consider upgrading the server resources.", "responders": [ { "id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c", "type": "team" }, { "id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8", "type": "user" }, { "id": "aee8a0de-c80f-4515-a232-501c0bc9d715", "type": "escalation" }, { "id": "80564037-1984-4f38-b98e-8a1f662df552", "type": "schedule" } ], "visibleTo": [ { "id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c", "type": "team" }, { "id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8", "type": "user" } ], "actions": [ "RestartServer" ], "tags": [ "OverwriteQuietHours", "Critical" ], "details": { "backend": false, "browser": "Firefox 113.0", "browser.name": "Firefox", "bundler": "parcel@2.10.3", "environment": "production" }, "entity": "DatabaseServer1", "source": "DBMonitoringTool", "priority": "P1", "user": "John Smith", "note": "This server has experienced high CPU usage multiple times in the past week. A server upgrade has been recommended to prevent future occurrences." }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Acknowledge alert

This endpoint is used to acknowledge an existing alert. Acknowledging an alert indicates that it has been received and is being acted upon, preventing duplicate efforts and coordinating response actions.

Request

Path parameters

id

string

Required

Header parameters

Authorization

string

Required

Request bodyapplication/json

user

string

source

Source

note

string

Responses

Returned if the request validation is successful.

application/json

AsyncSuccessResponse
POST/jsm/ops/integration/v2/alerts/{id}/acknowledge
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/integration/v2/alerts/{id}/acknowledge' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "user": "John Smith", "source": "DBMonitoringTool", "note": "Action executed via script." }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Close alert

This endpoint is used to close an existing alert. Closing an alert indicates that the issue has been resolved and no further action is necessary. This operation is essential for maintaining an accurate overview of the operational status and for ensuring that only active, unresolved issues remain open.

Request

Path parameters

id

string

Required

Header parameters

Authorization

string

Required

Request bodyapplication/json

user

string

source

Source

note

string

Responses

Returned if the request validation is successful.

application/json

AsyncSuccessResponse
POST/jsm/ops/integration/v2/alerts/{id}/close
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/integration/v2/alerts/{id}/close' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "user": "John Smith", "source": "DBMonitoringTool", "note": "Action executed via script." }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }
POST

Add note

This endpoint is used to add a note to an existing alert.

Request

Path parameters

id

string

Required

Header parameters

Authorization

string

Required

Request bodyapplication/json

user

string

source

Source

note

string

Responses

Returned if the request validation is successful.

application/json

AsyncSuccessResponse
POST/jsm/ops/integration/v2/alerts/{id}/notes
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/integration/v2/alerts/{id}/notes' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "user": "John Smith", "source": "DBMonitoringTool", "note": "Action executed via script." }'
202Response
1 2 3 4 5 { "result": "Request will be processed", "requestId": "d383c6e9-b1e7-4b59-9c35-72f1a2187777", "took": 0.195 }

Rate this page: