❗This article is intended more for those utilizing our generic REST Alerts API integration. The other out-of-the-box integrations will have their own mechanisms for the primary and secondary properties.
primary_property contains the name of tag being used as the primary property of an alert, and secondary_property contains the name of the tag being used as the secondary property of an alert.
BigPanda uses the primary_property to construct the titles, and the secondary_property to construct the subtitles of an incident.
You can use these properties to set the tags that you want your alert to use as the primary and secondary properties. For example, if the following payload is sent:
{
"host": "bp-test-01",
"check": "This is a test",
"status": "warning",
"application": "BigPanda Console",
"cluster": "east-01",
"primary_property": "application",
"secondary_property": "cluster"
}
by default, BigPanda would use the tag "host" as primary property, and "check" as the secondary property. However, since the payload above declares the primary and secondary properties, BigPanda will use the tags "application" and "cluster" instead.
BigPanda sets the primary property to one of the following tags (in order of precedence):
1. User defined (i.e. "primary_property: TAG_NAME")
2. host
3. service
4. application
5. device
👉 Note: If no primary property is set or no default tag is found, BigPanda will not accept the payload.
BigPanda sets the secondary property to one of the following tags (in order of precedence):
1. User defined (i.e. "secondary_property: TAG_NAME")
2. check
3. sensor
👉 Note: If no secondary property is set or tag is not found/defined, BigPanda will accept the payload. However, only the value of the primary property will be used to identify the alert.