Aporia Documentation
Get StartedBook a Demo🚀 Cool StuffBlog
V1
V1
  • Welcome to Aporia!
  • 🤗Introduction
    • Quickstart
    • Support
  • 💡Core Concepts
    • Why Monitor ML Models?
    • Understanding Data Drift
    • Analyzing Performance
    • Tracking Data Segments
    • Models & Versions
    • Explainability
  • 🏠Storing your Predictions
    • Overview
    • Real-time Models (Postgres)
    • Real-time Models (Kafka)
    • Batch Models
    • Kubeflow / KServe
    • Logging to Aporia directly
  • 🚀Model Types
    • Regression
    • Binary Classification
    • Multiclass Classification
    • Multi-Label Classification
    • Ranking
  • 📜NLP
    • Intro to NLP Monitoring
    • Example: Text Classification
    • Example: Token Classification
    • Example: Question Answering
  • 🍪Data Sources
    • Overview
    • Amazon S3
    • Athena
    • BigQuery
    • Delta Lake
    • Glue Data Catalog
    • PostgreSQL
    • Redshift
    • Snowflake
  • ⚡Monitors
    • Overview
    • Data Drift
    • Metric Change
    • Missing Values
    • Model Activity
    • Model Staleness
    • New Values
    • Performance Degradation
    • Prediction Drift
    • Value Range
    • Custom Metric
  • 📡Integrations
    • Slack
    • JIRA
    • New Relic
    • Single Sign On (SAML)
    • Webhook
    • Bodywork
  • 🔑API Reference
    • Custom Metric Definition Language
    • REST API
    • SDK Reference
    • Metrics Glossary
Powered by GitBook
On this page
  • Add a Webhook integration
  • Alert's format
  1. 📡Integrations

Webhook

PreviousSingle Sign On (SAML)NextBodywork

Last updated 2 years ago

Aporia allows you to send alerts generated from Aporia’s monitors to any system using webhooks.

Add a Webhook integration

  1. Log into Aporia’s console. On the navbar on the left, click on Integrations and choose Webhook.

  2. Enter your Integration Name, Webhook URL and Custom Headers(optional). The url should include the schema (http/ https).

  3. Click Save. On success the save button will become disable, and you'll be able to Test or Remove the integration.

Congratulations: You’ve now successfully add your webhook integration to Aporia!

After Integrating your webhook you'll be able to select sending alerts to your webhook in the Custome mode of the monitor builder.

Alert's format

The alert will be sent by POST action to the URL defined in the integration, as a JSON in the following format:

Key
Description

alert_id

The ID of the alert.

monitor_type

The type of the monitor that rose the alert.

monitor_id

The ID of the monitor that rose the alert.

monitor_name

The name of the monitor that rose the alert.

model_id

The ID of the model that the monitor created on.

model_name

The name of the model that the monitor created on.

severity

The severity of the alert as defined when building the monitor.

environment

The environment the model received alert at.

pretty_description

A short pretty summery about the specific alert.

dashboard_link

A link for the alert in the Aporia's dashboard for farther investigation.

You'll be able to see an example alert by clicking on Test in the Webhook Integration page mentioned in the previous section.

Happy Monitoring!

Webhook Integration