NewTarget

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blockdaemon/main/json-schema/blockdaemon-new-target-schema.json",
  "title": "NewTarget",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blockdaemon-event-streaming-api-openapi.yml#/components/schemas/NewTarget",
  "type": "object",
  "required": [
    "name",
    "type",
    "settings"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the target"
    },
    "description": {
      "type": "string",
      "description": "Optional information about the target"
    },
    "status": {
      "type": "string",
      "default": "active",
      "enum": [
        "disconnected",
        "active",
        "failed"
      ],
      "description": "Current status of the target"
    },
    "type": {
      "type": "string",
      "enum": [
        "webhook",
        "websocket"
      ],
      "description": "The type of target, indicating the communication protocol."
    },
    "settings": {
      "anyOf": [
        {
          "$ref": "#/$defs/WebhookSettings"
        },
        {
          "$ref": "#/$defs/WebsocketSettings"
        },
        {
          "$ref": "#/$defs/EmailSettings"
        }
      ],
      "description": "Configuration settings specific to the target type."
    },
    "max_buffer_count": {
      "$ref": "#/$defs/MaxBufferCount"
    }
  },
  "$defs": {
    "EmailSettings": {
      "title": "Email Settings",
      "description": "Used to send notifications or alerts to a specified recipient via email.",
      "type": "object",
      "required": [
        "name",
        "email"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The display name of the recipient."
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "The recipient's email address."
        }
      }
    },
    "MaxBufferCount": {
      "type": "integer",
      "default": 10000,
      "minimum": 10,
      "maximum": 10000,
      "description": "Maximum number of events that can be buffered before delivery."
    },
    "WebhookSettings": {
      "title": "Webhook Settings",
      "description": "Configuration for webhook-based targets. Includes the HTTP method, destination URL, and a secret used for signing and validating webhook messages.",
      "type": "object",
      "required": [
        "method",
        "destination",
        "secret"
      ],
      "properties": {
        "destination": {
          "type": "string",
          "description": "The destination URL where webhook events will be sent."
        },
        "method": {
          "type": "string",
          "description": "HTTP method used to deliver webhook events.",
          "enum": [
            "POST",
            "GET"
          ]
        },
        "secret": {
          "type": "string",
          "minLength": 10,
          "description": "Secret key used to sign webhook payloads. Must be at least 10 characters long."
        }
      }
    },
    "WebsocketSettings": {
      "title": "WebSocket Settings",
      "description": "Configuration for WebSocket-based targets. Used to establish a connection and authenticate event delivery.",
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "secret": {
          "type": "string",
          "minLength": 10,
          "description": "Secret used to authenticate the WebSocket connection. Must be at least 10 characters long."
        }
      }
    }
  }
}