-
Type:
Bug
-
Resolution: Fixed
-
Priority:
Low
-
Component/s: Operations - Team - Heartbeats
-
None
-
1
-
Minor
-
1
Issue Summary
When viewing a heartbeat's details in JSM Operations (under the "Instructions" > "Heartbeats API" tab), the documentation incorrectly references a GET request in steps 2 and 3. The correct HTTP method for the Ping Heartbeat endpoint is POST.
Steps to Reproduce
- Navigate to JSM Operations > Teams > select a team.
- Go to Heartbeats and select an existing heartbeat.
- Scroll down to the Instructions section and select the Heartbeats API tab.
- Observe steps 2 and 3.
Expected Results
- Step 2 should read: "Add the relevant information as explained in the API documentation and make a POST request to the following URL..."
- Step 3 should read: "Use this token and the heartbeat details to complete the information in the POST request."
Actual Results
- Step 2 reads: "...make a GET request to the following URL..."
- Step 3 reads: "...complete the information in the GET request."
Evidence
The official API documentation confirms the Ping Heartbeat endpoint uses POST:
The Jira Service Management ops REST API
curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/heartbeats/ping?name={name}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
Impact
Customers following the in-product instructions will use the wrong HTTP method and fail to ping their heartbeats, leading to confusion and unnecessary support contacts.
Workaround
Use POST instead of GET when calling the /v1/teams/{teamId}/heartbeats/ping endpoint.