OpenZeppelin · Schema

NotificationResponse

Represents a notification channel configuration for the OpenZeppelin Relayer, supporting Slack, Discord, Email, Telegram, Webhooks, and custom scripts.

Web3Smart ContractsBlockchainSecurityEthereumDeFiSolidityRelayerMonitoringAuditing

Properties

Name Type Description
id string Unique identifier for the notification channel
name string Human-readable name for the notification channel
notification_type string The type of notification delivery mechanism
config object Type-specific configuration for the notification channel (webhook URL, email address, etc.)
created_at string Timestamp when the notification channel was created
updated_at string Timestamp when the notification channel was last updated
View JSON Schema on GitHub

JSON Schema

notification.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/openzeppelin/main/json-schema/notification.json",
  "title": "NotificationResponse",
  "description": "Represents a notification channel configuration for the OpenZeppelin Relayer, supporting Slack, Discord, Email, Telegram, Webhooks, and custom scripts.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the notification channel"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the notification channel"
    },
    "notification_type": {
      "type": "string",
      "enum": ["slack", "discord", "email", "telegram", "webhook", "datadog", "pagerduty", "opsgenie"],
      "description": "The type of notification delivery mechanism"
    },
    "config": {
      "type": "object",
      "description": "Type-specific configuration for the notification channel (webhook URL, email address, etc.)"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the notification channel was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the notification channel was last updated"
    }
  },
  "required": ["id", "name", "notification_type"]
}