Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Thank you for visiting our old product documentation site. Note that we are in the process of migrating our product documentation and soon we will not store or update our documentation here. 

Please navigate to our new documentation site and update your bookmarks accordingly. If you're looking for the former content of this page, click here.

Table of Contents

Preparations to use OpsGenie for alerting

...

The request body may be enriched with the following fields that will be parsed by OpsGenie, while creating the alert based on the incoming request:

Field

Mandatory

Description

Limit

message

Status
colourRed
titlemandatory

Message of the alert

130 characters

alias

Status
colourGreen
titleOptional

This field is used for alert de-duplication. When there is an open alert with the same alias, no new alert is created, only a counter will be incremented. After closing this alert, and there is a new alert with the same alias sent in, a new alert will be created.

512 characters

description

Status
colourGreen
titleOptional

Description field of the alert that is generally used to provide detailed information about the alert.

15 000 characters

tags

Status
colourGreen
titleOptional

Tags of the alert.

20 x 50 characters

details

Status
colourGreen
titleOptional

Map of key-value pairs to use as custom properties of the alert.

8 000 characters total

entity

Status
colourGreen
titleOptional

Entity field of the alert that is generally used to specify, to which domain the alert is related.

512 characters

priority

Status
colourGreen
titleOptional

Priority level of the alert. Possible values are P1P2P3P4 and P5. Default value is P3.

For more details, please read the Alert API documentation: https://docs.opsgenie.com/docs/alert-api