---
title: "Create alert"
method: POST
path: "/api/{cloudId}/v1/alerts"
tags: ["Alerts"]
---

# Create alert

`POST /api/{cloudId}/v1/alerts`

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 for incident management.

## Request body

- CreateAlertRequest
  - `message` string, required — Brief summary of the alert that provides enough information to understand the nature of the issue at a glance.
  - `responders` Responder[] — Teams, users, escalations and schedules that the alert will be routed to send notifications.
    - `id` string — Identifier of the responder.
    - `type` 'team' | 'user' | 'escalation' | 'schedule' — Type of the responder.
  - `visibleTo` VisibleTo[]
    - `id` string
    - `type` 'team' | 'user'
  - `note` string — Additional context or information about the alert that isn't captured in other fields. This could include steps taken to address the alert, details about the potential cause, or other relevant information.
  - `alias` string — Client-defined identifier of the alert, that is also the key element of <a target="_self" href="https://support.atlassian.com/atlassian/docs/what-is-alert-de-duplication/">Alert De-Duplication</a>.
  - `entity` string — Entity that the alert is related to. It could be a server, service, application or another source that's being monitored. The 'entity' helps in identifying and categorizing the origin of the alert, enabling quicker diagnostics and resolution of the issue.
  - `source` string — Origin of the alert, i.e., the system or application where the alert was generated. This field is useful for tracking and sorting alerts according to their originating sources, which can help in troubleshooting and determining the cause of the alerts.
  - `tags` string[] — Additional categorizing information. These tags can then be used for searching or grouping alerts, making it easier to manage and prioritize them.
  - `actions` string[] — A list of actions that can be executed on the alert. These actions are custom to your organization and can be used to automate responses to specific alerts.
  - `description` string — Detailed information contains more comprehensive information than the 'message' field, including the implications of the alert, steps to reproduce the issue, or suggestions for resolving the problem. It serves as a guide for the person or team responding to the alert to better understand the situation and take appropriate actions.
  - `priority` 'P1' | 'P2' | 'P3' | 'P4' | 'P5' — Urgency level of the alert. The priority can be set as 'P1', 'P2', 'P3', 'P4', or 'P5', with 'P1' being the highest and 'P5' the lowest. The 'priority' attribute aids in effective alert management by allowing alerts to be categorized and handled according to their importance.
  - `extraProperties` ExtraProperties — Map of key-value pairs to use as custom properties of the alert. This can include context-specific data, diagnostic information, or other metadata that can assist in understanding and resolving the alert.

## Response `200`

Returned if the request is successful.

- SuccessResponse
  - `result` string — Indicates the outcome of the request.
  - `requestId` string — Identifier of the request. This ID can be used to trace or track the request in the system logs or for debugging purposes in case the request fails or causes an error.
  - `took` integer

## Other responses

- `401` — Returned if the authentication credentials are incorrect.
- `403` — Returned if the request user does not have permission to create alert.
- `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)