Skip to main content
APIContext
Talk to salesStart free
Start HereGuidesConceptsCLIReferenceChangelog

Using Webhooks

Key Concepts​

A webhook is a mechanism for connecting systems together simply. Webhooks can be used to link APImetrics to management and other systems so that data and alerts can easily be pushed to the external systems from APImetrics.

For most webhooks, you will need to enter a key or some other information that is provided to you by the service associated with the webhook. When a condition you set is met within APImetrics, a message will be generated that is pushed to the service by the webhook.

Supported Webhooks​

APImetrics supports the following services:

  • Generic
  • Axiom (OpenTelemetry API)
  • Email
  • Email (plain text)
  • Email (template)
  • BigPanda
  • DataDog Metric
  • DataDog Event
  • Flowdock
  • HipChat
  • Hydrolix
  • Microsoft Teams
  • New Relic
  • OpenTelemetry
  • OpsGenie
  • PagerDuty
  • Slack
  • StatusPage
  • VictorOps

If you don't see the service you need in that list, please contact us. It is usually quick and easy for us to add a new webhook.

Alerts & Webhooks Page​

You can use webhooks to create alerts for all your APIs or for particular APIs. The Alerts & Webhooks item under the Alerting section of the navbar and will take you to the page that allows you to create and edit alerts for all your APIs.

Alerts and Webhooks page header with the Add new alert and Add new action buttons

If you have already created alerts, these will be shown on this page and you can edit the alerts by expanding your desired alert.

Alerts list showing Email, Datadog, and Microsoft Teams webhooks with their trigger conditions

Add a New Webhook​

Click on the +Add New Alert button.

Alerts list with the Add new alert button highlighted

From the dropdown, choose the type of webhook you want to create.

New alert with the Type dropdown open listing webhook options such as Email and Axiom

Enter a name for the alert. The alert will automatically be Active but this can be toggled on and off without removing the alert. From the Trigger alerts options, toggle the conditions you want to trigger the alert. The conditions are Pass, Slow, Warning, & Fail. By default, Slow, Warning, and Fail are enabled.

Alert Settings with the Trigger alerts toggles for Pass, Slow, Warning, and Fail highlighted

Enter the details needed for your alert. For this example, it is an email address. APImetrics will automatically populate with email addresses linked to the project so a dropdown will appear and select which should receive the alert.

Save your alert. If you have enabled it, it will now be active and alerts will start appearing through the relevant webhook when the trigger conditions are met.

Snoozing Alerts​

If you are aware of maintenance or have known issues with your service and want to snooze your alerts, you can simply do this by selecting the desired length of time from the right-hand side.

Email webhook with the Snooze options for 6, 12, and 24 hours highlighted on the right

After the allotted time, the alerts will begin again.