---
title: "Create heartbeat"
method: POST
path: "/api/{cloudId}/v1/teams/{teamId}/heartbeats"
tags: ["Heartbeats"]
---

# Create heartbeat

`POST /api/{cloudId}/v1/teams/{teamId}/heartbeats`

Create heartbeat request is used to define heartbeats in Jira Service Management. A heartbeat needs to be added, before sending heartbeat messages to JSM

## Path parameters

- `teamId` string, required

## Request body

- CreateHeartbeatRequest
  - `name` string, required — Name of the heartbeat.
  - `description` string — Description of the heartbeat.
  - `interval` integer, required — Specifies how often a heartbeat message should be expected.
  - `enabled` boolean — Enable/disable heartbeat monitoring.
  - `intervalUnit` 'hours' | 'minutes' | 'days', required
  - `alertMessage` string — Specifies the alert message for heartbeat expiration alert.
  - `alertTags` string[] — Specifies the alert tags for heartbeat expiration alert.
  - `alertPriority` 'P1' | 'P2' | 'P3' | 'P4' | 'P5' — Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3

## Response `201`

Returned if the request is successful.

- Heartbeat
  - `name` string — Name of the heartbeat.
  - `description` string — Description of the heartbeat.
  - `interval` integer — Specifies how often a heartbeat message should be expected.
  - `intervalUnit` 'Days' | 'Minutes' | 'Hours'
  - `enabled` boolean — Enable/disable heartbeat monitoring.
  - `status` 'Unresponsive' | 'Responsive' | 'Off' | 'Pending'
  - `ownerTeamId` string — Owner team of the heartbeat, consisting id of the owner team
  - `alertMessage` string — Specifies the alert message for heartbeat expiration alert.
  - `alertTags` string[] — Specifies the alert tags for heartbeat expiration alert.
  - `alertPriority` 'P1' | 'P2' | 'P3' | 'P4' | 'P5' — Specifies the alert priority for heartbeat expiration alert.

## Other responses

- `401` — Returned if the authentication credentials are incorrect.
- `402` — Returned if the customer subscription plan does not cover heartbeats.
- `403` — Returned if the request user does not have permission to create heartbeat.
- `422` — Returned if the payload cannot be validated.

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)