PagerDuty webhook

APImetrics uses the PagerDuty Events v2 API. To use this, you need to provide an Event API key - as described in their support documentation: https://support.pagerduty.com/docs/generating-api-keys#section-events-api-keys.

Now in APImetrics:

  • Go to Alerts & Webhooks:
  • Create a new webhook, selecting PagerDuty as the type and enter the API key you just generated in the Integration key box.
  • Select the Trigger Alerts for your desired outcomes - either:
    • all four - Pass, Slow, Warning, and Fail. This means that passing API calls will resolve alerts.
    • Slow, Warning, Fail - Alerts will not resolve. You want to use PagerDuty's auto-resolve feature.
  • Select the Severity for the alert you want
  • Press Save

📘

Custom Component or Group

If you want the alerts to have a custom component or group set, use a tag on your API calls - in the format pagerduty_group:value or pagerduty_component:value