Getting Started
Special
SINGLE SIGN-ON
Teams
Users
Escalation Policies
Service
Incident
On-Call Shift
Schedules
Schedule Override
API Token
Logs
Webhook
Slack
Reports
Preference
Profile
Automation
FAQ
API Filter Examples
A detailed example of how to set trigger and resolve filter for an incident through Api.
Setup your filter
To configure your API filter by defining Payload Json Key and the Key value contains inside Api integrations. For that, you must first understand the API's payload values.
EXAMPLE1
EXAMPLE2
EXAMPLE3
EXAMPLE4
{
"id": "123ABC",
"title": "This is title",
"content": "This is content"
}
Consider you have API's payload are like these
- Select the urgency for incident
- Payload Json Key : "content"
- Key Value Contains: this is content and this(These items need to be found under the specific key to resolve the incident). We will check the items using AND filter. All the items should present, else we will discard this filter.
- Map Incident With (Mandatory if you want to resolve through api) : "id". This is used to identify the incident and resolve an already triggered incident when there is a Resolve filter.
Note:
• You can select different urgency for a filter, and can add upto 10 filter.
• You can add 2 Payload Json Key for a Trigger filter and 1 for Resolve filter. Each key value contains can have max of 10 items with upto 50 characters. That 10 item should be present in the specific key-value to accept the filter.
• You can select different urgency for a filter, and can add upto 10 filter.
• You can add 2 Payload Json Key for a Trigger filter and 1 for Resolve filter. Each key value contains can have max of 10 items with upto 50 characters. That 10 item should be present in the specific key-value to accept the filter.
Save this filter and use the api to trigger the incident. HOW TO SEND API
The incident may appear like above.
Setup a resolve filter for resolve though Api
- Toggle to activate resolve filter. priority.
- Incident Mapped With : "id". If the Resolve filter is accepted, then we will resolve the incident that was mapped with the same value('Map Incident With' property of Trigger filter)
- Payload Json Key : "title"
- Key Value Contains: complete (These items need to be found under the specific key to resolve the incident)
Note:
• If the Incident Title From is empty and api url has from=<Incident Name> variable, then we take it to be the incident's title. If api url doesn't have from parameter, then the incident title will be Incident from unspecified source.
• If the Incident Description From is empty, then the incident description will be the body of Api payload.
• If the Incident Title From is empty and api url has from=<Incident Name> variable, then we take it to be the incident's title. If api url doesn't have from parameter, then the incident title will be Incident from unspecified source.
• If the Incident Description From is empty, then the incident description will be the body of Api payload.
