Webhooks allow you to subscribe to certain incidents created in the Superwise platform. When one of the relevant incidents is triggered, we'll send an HTTP POST payload to the configured webhook URL. Webhooks can be used to update an external issue tracker, connect to a communication app such as Slack, or even trigger a public API that your application exposes. For example, a drift incident could trigger a retraining API by configuring a Webhook.

Superwise webhook response format:

{
  "subject": string,
  "description" :string,
  "attributes": Dict[string],
  "severity": Enum[Info,Medium,Error,Critical],
  "timestamp": string -ISOFormat,
  "link" : string
}

Details:

  • subject - Name of the event.
  • description - Short description of the event.
  • attributes - Dict of relevant metadata on the event.
  • severity - Level of severity for the event.
  • timestamp - Event timestamp.
  • link - Link for the event in Superwise UI.

Add Webhook integration channel via the SDK

πŸ“˜

Install the SDK

To install and get started with our SDK visit our SDK docs

import os
from superwise import Superwise

os.environ['SUPERWISE_CLIENT_ID'] = '[REPLACE_WITH_YOUR_CLIENT]'
os.environ['SUPERWISE_SECRET'] = '[REPLACE_WITH_YOUR_SECRET]'

sw = Superwise()
notification = sw.notification.create_webhook_notification('Webhook Channel', '<Webhook URL>')