RapidAPI · Schema

AlertInput

API MarketplaceAPI ManagementAPI TestingAPI GatewayAPI DesignEnterprise

Properties

Name Type Description
testId string The test to monitor for failures
channel string Notification channel
configuration object Channel-specific configuration
enabled boolean Whether the alert should be active
View JSON Schema on GitHub

JSON Schema

rapidapi-alertinput-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AlertInput",
  "title": "AlertInput",
  "type": "object",
  "required": [
    "testId",
    "channel",
    "configuration"
  ],
  "properties": {
    "testId": {
      "type": "string",
      "description": "The test to monitor for failures"
    },
    "channel": {
      "type": "string",
      "enum": [
        "email",
        "slack",
        "pagerduty",
        "twilio"
      ],
      "description": "Notification channel"
    },
    "configuration": {
      "type": "object",
      "additionalProperties": true,
      "description": "Channel-specific configuration"
    },
    "enabled": {
      "type": "boolean",
      "default": true,
      "description": "Whether the alert should be active"
    }
  }
}