schema.yaml

$schema: http://json-schema.org/draft-07/schema#
definitions:

  # Either a single string OR an array of strings
  arrayOfStrings: &arrayOfString
    type: [string, array]
    items: {type: string}

  # Either a single string OR an array of strings OR an array of arrays
  arrayOfStringsOrOtherArrays: &arrayOfStringsOrOtherArray
    type: [string, array]
    items: {type: [string, array]}

  # Either a single string OR an array of strings OR an array of objects
  stringOrArrayOfStringsOrObjects: &stringOrArrayOfStringsOrObjects
    type: [string, array]
    items: {type: [string, object]}

  timedelta: &timedelta
    type: object
    additionalProperties: false
    properties:
      days: {type: number}
      weeks: {type: number}
      hours: {type: number}
      minutes: {type: number}
      seconds: {type: number}
      milliseconds: {type: number}

  timeFrame: &timeframe
    type: object
    additionalProperties: false
    properties:
      days: {type: number}
      weeks: {type: number}
      hours: {type: number}
      minutes: {type: number}
      seconds: {type: number}
      milliseconds: {type: number}
      schedule: {type: string}

  slackField: &slackField
    type: object
    additionalProperties: false
    properties:
      title: {type: string}
      value: {type: string}
      short: {type: boolean}

  arrayOfSlackFields: &arrayOfSlackField
    type: array
    items: *slackField

  msTeamsFact: &msTeamsFact
    type: object
    additionalProperties: false
    properties:
      name: {type: string}
      value: {type: string}

  msPowerAutomateFact: &msPowerAutomateFact
    type: object
    additionalProperties: false
    properties:
      name: {type: string}
      value: {type: string}    

  arrayOfMsTeamsFacts: &arrayOfMsTeamsFacts
    type: array
    items: *msTeamsFact

  arrayOfMsPowerAutomateFacts: &arrayOfMsPowerAutomateFacts
    type: array
    items: *msPowerAutomateFact

  mattermostField: &mattermostField
    type: object
    additionalProperties: false
    properties:
      title: {type: string}
      value: {type: string}
      args: *arrayOfString
      short: {type: boolean}

  arrayOfMattermostFields: &arrayOfMattermostField
    type: array
    items: *mattermostField

  filter: &filter {}

  irisIocField: &irisIocField
    type: object
    additionalProperties: false
    properties:
      ioc_value: {type: string}
      ioc_description: {type: string}
      ioc_tlp_id: {type: integer, enum: [1, 2, 3]}
      ioc_type_id: {type: integer}
      ioc_tags: {type: string}

  arrayOfIrisIocFields: &arrayOfIrisIocFields
    type: array
    items: *irisIocField
  
  opsGenieArgs: &opsGenieArgs
    type: object
    additionalProperties: false
    minProperties: 0
    patternProperties:
      "^.+$":
        type: string

required: [type, index, alert]
type: object

### Rule Types section
oneOf:
  - title: Any
    properties:
      type: {enum: [any]}

  - title: Blacklist
    required: [blacklist, compare_key]
    properties:
      type: {enum: [blacklist]}
      compare_key: {'items': {'type': 'string'},'type': ['string', 'array']}
      blacklist: {type: array, items: {type: string}}

  - title: Whitelist
    required: [whitelist, compare_key, ignore_null]
    properties:
      type: {enum: [whitelist]}
      compare_key: {'items': {'type': 'string'},'type': ['string', 'array']}
      whitelist: {type: array, items: {type: string}}
      ignore_null: {type: boolean}

  - title: Change
    required: [query_key, compare_key, ignore_null]
    properties:
      type: {enum: [change]}
      compare_key: {'items': {'type': 'string'},'type': ['string', 'array']}
      ignore_null: {type: boolean}
      timeframe: *timeframe

  - title: Frequency
    required: [num_events, timeframe]
    properties:
      type: {enum: [frequency]}
      num_events: {type: integer}
      timeframe: *timeframe
      use_count_query: {type: boolean}
      use_terms_query: {type: boolean}
      terms_size: {type: integer}
      attach_related: {type: boolean}

  - title: Spike
    required: [spike_height, spike_type, timeframe]
    properties:
      type: {enum: [spike]}
      spike_height: {type: number}
      spike_type: {enum: ["up", "down", "both"]}
      timeframe: *timeframe
      use_count_query: {type: boolean}
      use_terms_query: {type: boolean}
      terms_size: {type: integer}
      alert_on_new_data: {type: boolean}
      threshold_ref: {type: integer}
      threshold_cur: {type: integer}
      field_value: {type: string}

  - title: Spike Aggregation
    required: [spike_height, spike_type, timeframe]
    properties:
      type: {enum: [spike_aggregation]}
      spike_height: {type: number}
      spike_type: {enum: ["up", "down", "both"]}
      metric_agg_type: {enum: ["min", "max", "avg", "sum", "cardinality", "value_count", "percentiles"]}
      timeframe: *timeframe
      use_count_query: {type: boolean}
      use_terms_query: {type: boolean}
      terms_size: {type: integer}
      alert_on_new_data: {type: boolean}
      threshold_ref: {type: number}
      threshold_cur: {type: number}
      min_doc_count: {type: integer}
      percentile_range: {type: integer}

  - title: Flatline
    required: [threshold, timeframe]
    properties:
      type: {enum: [flatline]}
      timeframe: *timeframe
      threshold: {type: integer}
      use_count_query: {type: boolean}
      use_terms_query: {type: boolean}
      terms_size: {type: integer}
      forget_keys: {type: boolean}

  - title: New Term
    required: []
    properties:
      type: {enum: [new_term]}
      fields: *arrayOfStringsOrOtherArray
      terms_window_size: *timeframe
      alert_on_missing_field: {type: boolean}
      use_terms_query: {type: boolean}
      terms_size: {type: integer}
      window_step_size: *timeframe
      use_keyword_postfix: {type: boolean}

  - title: Cardinality
    required: [cardinality_field, timeframe]
    properties:
      type: {enum: [cardinality]}
      max_cardinality: {type: integer}
      min_cardinality: {type: integer}
      cardinality_field: {type: string}
      timeframe: *timeframe

  - title: Metric Aggregation
    required: [metric_agg_key,metric_agg_type]
    properties:
      type: {enum: [metric_aggregation]}
      metric_agg_type: {enum: ["min", "max", "avg", "sum", "cardinality", "value_count", "percentiles"]}
      percentile_range: {type: integer}
      max_threshold: {type: number}
      min_threshold: {type: number}
      min_doc_count: {type: integer}
      use_run_every_query_size: {type: boolean}
      allow_buffer_time_overlap: {type: boolean}
      bucket_interval: *timeframe
      sync_bucket_interval: {type: boolean}
      metric_format_string: {type: string}

  - title: Percentage Match
    required: [match_bucket_filter]
    properties:
      type: {enum: [percentage_match]}
      min_percentage: {type: number}
      max_percentage: {type: number}
      use_run_every_query_size: {type: boolean}
      allow_buffer_time_overlap: {type: boolean}
      bucket_interval: *timeframe
      sync_bucket_interval: {type: boolean}
      percentage_format_string: {type: string}
      min_denominator: {type: integer}

  - title: Custom Rule from Module
    properties:
      # custom rules include a period in the rule type
      type: {pattern: "[.]"}

properties:

  # Common Settings
  es_host: {type: string}
  es_port: {type: integer}
  index: {type: string}
  name: {type: string}

  use_ssl: {type: boolean}
  verify_certs: {type: boolean}
  es_username: {type: string}
  es_password: {type: string}
  es_bearer: {type: string}
  use_strftime_index: {type: boolean}

  # Optional Settings
  es_hosts: {type: array, items: {type: string}}
  import:
    anyOf:
      - type: array
        items:
          type: string
      - type: string
  aggregation: *timeframe
  aggregation_alert_time_compared_with_timestamp_field: {type: boolean}
  realert: *timeframe
  realert_key: {type: string}
  exponential_realert: *timeframe

  buffer_time: *timeframe
  query_delay: *timeframe
  max_query_size: {type: integer}
  max_scrolling: {type: integer}
  max_threads: {type: integer}
  misfire_grace_time: {type: integer}

  owner: {type: string}
  priority: {type: integer}

  filter :
    type: array
    items: *filter

  include: {type: array, items: {type: string}}
  include_fields: {type: array, item: {type: string}}
  include_rule_params_in_matches: {type: array, items: {type: string}}
  include_rule_params_in_first_match_only: {type: boolean}
  top_count_keys: {type: array, items: {type: string}}
  top_count_number: {type: integer}
  raw_count_keys: {type: boolean}
  kibana_url: {type: string, format: uri}
  kibana_username: {type: string}
  kibana_password: {type: string}
  kibana_verify_certs: {type: boolean}
  use_local_time: {type: boolean}
  custom_pretty_ts_format: {type: string}
  match_enhancements: {type: array, items: {type: string}}
  query_key: *arrayOfString
  replace_dots_in_field_names: {type: boolean}
  scan_entire_timeframe: {type: boolean}
  
  ## System Error Notifications
  notify_alert: *stringOrArrayOfStringsOrObjects
  notify_all_errors: {type: boolean}

  ### summary table
  summary_table_fields: {type: array, items: {type: string}}
  summary_table_type: {type: string, enum: ['ascii', 'html', 'markdown']}
  summary_table_max_rows: {type: integer, minimum: 0}
  summary_prefix: {type: string}
  summary_suffix: {type: string}

  ### Kibana Discover App Link
  generate_kibana_discover_url: {type: boolean}
  shorten_kibana_discover_url: {type: boolean}
  kibana_discover_app_url: {type: string}
  kibana_discover_version: {type: string, enum: ['8.17','8.16','8.15','8.14','8.13','8.12','8.11', '8.10', '8.9', '8.8', '8.7', '8.6', '8.5', '8.4', '8.3', '8.2', '8.1', '8.0', '7.17', '7.16', '7.15', '7.14', '7.13', '7.12', '7.11', '7.10', '7.9', '7.8', '7.7', '7.6', '7.5', '7.4', '7.3', '7.2', '7.1', '7.0']}
  kibana_discover_index_pattern_id: {type: string, minLength: 1}
  kibana_discover_columns: {type: array, items: {type: string, minLength: 1}, minItems: 1}
  kibana_discover_from_timedelta: *timedelta
  kibana_discover_to_timedelta: *timedelta
  kibana_discover_security_tenant: {type:string}

  ### Opensearch discover App Link
  generate_opensearch_discover_url: {type: boolean}
  opensearch_url: {type: string, format: uri}
  opensearch_discover_app_url: {type: string}
  opensearch_discover_version: {type: string, enum: ['2.11']}
  opensearch_discover_index_pattern_id: {type: string, minLength: 1}
  opensearch_discover_columns: {type: array, items: {type: string, minLength: 1}, minItems: 1}
  opensearch_discover_from_timedelta: *timedelta
  opensearch_discover_to_timedelta: *timedelta
  
  # Alert Content
  alert_text: {type: string} # Python format string
  alert_text_args: {type: array, items: {type: string}}
  alert_text_kw: {type: object}
  alert_text_type: {enum: [alert_text_only, alert_text_jinja, exclude_fields, aggregation_summary_only]}
  alert_missing_value: {type: string}
  timestamp_field: {type: string}
  field: {}

  ### Alerta
  alerta_api_url: {type: string}
  alerta_api_key: {type: string}
  alerta_use_qk_as_resource: {type: boolean}
  alerta_use_match_timestamp: {type: boolean}
  alerta_api_skip_ssl: {type: boolean}
  alerta_severity: {type: string}
  alerta_timeout: {type: integer}
  alerta_type: {type: string}
  alerta_resource: {type: string}   # Python format string
  alerta_service: {type: array, items: {type: string}}  # Python format string
  alerta_origin: {type: string}   # Python format string
  alerta_environment: {type: string}  # Python format string
  alerta_group: {type: string}  # Python format string
  alerta_correlate: {type: array, items: {type: string}}  # Python format string
  alerta_tags: {type: array, items: {type: string}}   # Python format string
  alerta_event: {type: string} # Python format stringalerta_use_match_timestamp
  alerta_text: {type: string} # Python format string
  alerta_value: {type: string} # Python format string
  alerta_attributes_keys: {type: array, items: {type: string}}
  alerta_attributes_values: {type: array, items: {type: string}}  # Python format string

  ### Alertmanager
  alertmanager_alertname: {type: string}
  alertmanager_hosts: {type: array, items: {type: string}}
  alertmanager_api_version: {type: string, enum: ['v1', 'v2']}
  alertmanager_alert_subject_labelname: {type: string}
  alertmanager_alert_text_labelname: {type: string}
  alertmanager_proxy: {type: string}
  alertmanager_ca_certs: {type: [boolean, string]}
  alertmanager_ignore_ssl_errors: {type: boolean}
  alertmanager_timeout: {type: integer}
  alertmanager_resolve_time: *timedelta
  alertmanager_basic_auth_login: {type: string}
  alertmanager_basic_auth_password: {type: string}
  alertmanager_labels:
    type: object
    minProperties: 1
    patternProperties:
      "^.+$":
        oneOf:
          - type: string
          - type: object
            additionalProperties: false
            required: [field]
            properties:
              field: {type: string, minLength: 1}
  alertmanager_annotations:
    type: object
    minProperties: 1
    patternProperties:
      "^.+$":
        oneOf:
          - type: string
          - type: object
            additionalProperties: false
            required: [field]
            properties:
              field: {type: string, minLength: 1}
  alertmanager_fields:
    type: object
    minProperties: 1
    patternProperties:
      "^.+$":
        oneOf:
          - type: string
          - type: object
            additionalProperties: false
            required: [field]
            properties:
              field: {type: string, minLength: 1}

  ### AWS SES
  ses_email: *arrayOfString
  ses_from_addr: {type: string}
  ses_aws_access_key: {type: string}
  ses_aws_secret_key: {type: string}
  ses_aws_region: {type: string}
  ses_aws_profile: {type: string}
  ses_email_reply_to: {type: string}
  ses_cc: *arrayOfString
  ses_bcc: *arrayOfString

  ### AWS SNS
  sns_topic_arn: {type: string}
  sns_aws_access_key_id: {type: string}
  sns_aws_secret_access_key: {type: string}
  sns_aws_region: {type: string}
  sns_aws_profile: {type: string}

  ### Chatwork
  chatwork_apikey: {type: string}
  chatwork_room_id: {type: string}
  chatwork_proxy: {type: string}
  chatwork_proxy_login: {type: string}
  chatwork_proxy_pass: {type: string}

  ### Command
  command: *arrayOfString
  pipe_match_json: {type: boolean}
  pipe_alert_text: {type: boolean}
  fail_on_non_zero_exit: {type: boolean}

  ### Datadog
  datadog_api_key: {type: string}
  datadog_app_key: {type: string}

  ### Dingtalk
  dingtalk_access_token: {type: string}
  dingtalk_msgtype: {type: string, enum: ['text', 'markdown', 'single_action_card', 'action_card']}
  dingtalk_single_title: {type: string}
  dingtalk_single_url: {type: string}
  dingtalk_btn_orientation: {type: string}
  dingtalk_proxy: {type: string}
  dingtalk_proxy_login: {type: string}
  dingtalk_proxy_pass: {type: string}
  dingtalk_sign: {type: string}

  ## Discord
  discord_webhook_url: {type: string}
  discord_emoji_title: {type: string}
  discord_proxy: {type: string}
  discord_proxy_login: {type: string}
  discord_proxy_password: {type: string}
  discord_embed_color: {type: integer}
  discord_embed_footer: {type: string}
  discord_embed_icon_url: {type: string}

  ### Email
  email: *arrayOfString
  email_from_field: {type: string}
  email_add_domain: {type: string}
  smtp_host: {type: string}
  smtp_port: {type: integer}
  smtp_ssl: {type: boolean}
  smtp_auth_file: {type: string}
  smtp_cert_file: {type: string}
  smtp_key_file: {type: string}
  email_reply_to: {type: string}
  from_addr: {type: string}
  cc: *arrayOfString
  bcc: *arrayOfString
  email_format: {type: string}
  assets_dir: {type: string}
  email_image_keys: {type: array, items: {type: string}}
  email_image_values: {type: array, items: {type: string}}
  notify_email: *arrayOfString # if rule is slow or erroring, send to this email

  ### Exotel
  exotel_account_sid: {type: string}
  exotel_auth_token: {type: string}
  exotel_to_number: {type: string}
  exotel_from_number: {type: string}
  exotel_message_body: {type: string}

  ### Gitter
  gitter_webhook_url: {type: string}
  gitter_msg_level: {enum: [info, error]}
  gitter_proxy: {type: string}

  ### Gelf
  gelf_type: {type: string, enum: ['http', 'tcp']}
  gelf_endpoint: {type: string}
  gelf_host: {type: string}
  gelf_port: {type: integer}
  gelf_payload:
    type: object
    minProperties: 1
    patternProperties:
      "^.+$":
        oneOf:
          - type: string
          - type: object
            additionalProperties: false
            required: [field]
            properties:
              field: {type: string, minLength: 1}
  gelf_log_level: {type: integer, enum: ['0', 1', '2', '3', '4', '5', '6', '7']}
  gelf_http_headers:
    type: object
    minProperties: 1
    patternProperties:
      "^.+$":
        oneOf:
          - type: string
          - type: object
            additionalProperties: false
            required: [ field ]
            properties:
              field: { type: string, minLength: 1 }
  gelf_ca_cert: {type: [boolean, string]}
  gelf_http_ignore_ssl_errors: {type: boolean}
  gelf_timeout: {type: integer}

  ### GoogleChat
  googlechat_webhook_url: *arrayOfString
  googlechat_format: {type: string, enum: ['basic', 'card']}
  googlechat_header_title: {type: string}
  googlechat_header_subtitle: {type: string}
  googlechat_header_image: {type: string}
  googlechat_footer_kibanalink: {type: string}
  googlechat_proxy: {type: string}

  ### HTTP POST
  http_post_url: *arrayOfString
  http_post_proxy: {type: string}
  http_post_ca_certs: {type: [boolean, string]}
  http_post_ignore_ssl_errors: {type: boolean}
  http_post_timeout: {type: integer}

  ### HTTP POST 2
  http_post2_url: *arrayOfString
  http_post2_proxy: {type: string}
  http_post2_ca_certs: {type: [boolean, string]}
  http_post2_ignore_ssl_errors: {type: boolean}
  http_post2_timeout: {type: integer}

  ### INDEXER
  indexer_alerts_name: {type: string}
  indexer_config: {type: string}
  indexer_connection:
    type: object
    properties:
      es_host: {type: string}
      es_hosts: {type: array, items: {type: string}}
      es_port: {type: integer}
      ssl_show_warn: {type: boolean}
      use_ssl: {type: boolean}
      verify_certs: {type: boolean}
      ca_cert: {type: string}
      es_username: {type: string}
      es_password: {type: string}
      index_alerts_name: {type: string}
  indexer_alert_config:
    type: object
    minProperties: 1
    patternProperties:
      "^.+$":
        oneOf:
          - type: [boolean, string, integer]
          - type: array
            items:
                type: object
                properties:
                  name: { type: string , minLength: 1 }
                  value: { type: [boolean, string, integer] , minLength: 1 }
                  "^.+$": { type: [boolean, string, integer], minLength: 1 }
          - type: object
            properties:
              "^.+$": { type: [boolean, string, integer], minLength: 1 }

  ### IRIS
  iris_host: {type: string}
  iris_api_token: {type: string}
  iris_type: {type: string, enum: ['alert', 'case']}
  iris_customer_id: {type: integer}
  iris_ignore_ssl_errors: {type: boolean}
  iris_ca_cert: {type: [boolean, string]}
  iris_overwrite_timestamp: {type: boolean}
  iris_case_template_id: {type: integer}
  iris_description: {type: string}
  iris_alert_note: {type: string}
  iris_alert_tags: {type: string}
  iris_alert_status_id: {type: integer, enum: [1, 2, 3, 4, 5, 6, 7]}
  iris_alert_source: {type: string}
  iris_alert_source_link: {type: string}
  iris_alert_severity_id: {type: integer, enum: [1, 2, 3, 4, 5, 6]}
  iris_iocs: *arrayOfIrisIocFields
  iris_alert_context:
    type: object
    minProperties: 1
    patternProperties:
      "^.+$":
        oneOf:
          - type: string
          - type: object
            additionalProperties: false
            required: [ field ]
            properties:
              field: { type: string, minLength: 1 }

  ### Jira
  jira_server: {type: string}
  jira_project: {type: string}
  jira_issuetype: {type: string}
  jira_account_file: {type: string} # a Yaml file that includes the keys {user:, password:}
  jira_assignee: {type: string}
  jira_component: *arrayOfString
  jira_components: *arrayOfString
  jira_description: {type: string}
  jira_label: *arrayOfString
  jira_labels: *arrayOfString
  jira_priority: {type: number}
  jira_watchers: *arrayOfString
  jira_bump_tickets: {type: boolean}
  jira_ignore_in_title: {type: string}
  jira_max_age: {type: number}
  jira_bump_not_in_statuses: *arrayOfString
  jira_bump_in_statuses: *arrayOfString
  jira_bump_only: {type: boolean}
  jira_transition_to: {type: string}
  jira_bump_after_inactivity: {type: number}

  ### Lark
  lark_bot_id: { type: string }
  lark_msgtype: { type: string, enum: [ 'text' ] }

  ### Line Notify
  linenotify_access_token: {type: string}

  ### Matrix Hookshot
  matrixhookshot_ca_certs: {type: [boolean, string]}
  matrixhookshot_webhook_url: *arrayOfString
  matrixhookshot_username: {type: string}
  matrixhookshot_html: {type: string}
  matrixhookshot_text: {type: string}
  matrixhookshot_proxy: {type: string}
  matrixhookshot_ignore_ssl_errors: {type: boolean}
  matrixhookshot_timeout: {type: integer}

  ### Mattermost
  mattermost_webhook_url: *arrayOfString
  mattermost_proxy: {type: string}
  mattermost_ignore_ssl_errors: {type: boolean}
  mattermost_username_override: {type: string}
  mattermost_channel_override: *arrayOfString
  mattermost_emoji_override: {type: string}
  mattermost_icon_url_override: {type: string}
  mattermost_msg_pretext: {type: string}
  mattermost_msg_color: {enum: [good, warning, danger]}
  mattermost_msg_fields: *arrayOfMattermostField
  mattermost_title: {type: string}
  mattermost_title_link: {type: string}
  mattermost_footer: {type: string}
  mattermost_footer_icon: {type: string}
  mattermost_image_url: {type: string}
  mattermost_thumb_url: {type: string}
  mattermost_author_name: {type: string}
  mattermost_author_link: {type: string}
  mattermost_author_icon: {type: string}
  mattermost_attach_kibana_discover_url: {type: boolean}
  mattermost_kibana_discover_color: {type: string}
  mattermost_kibana_discover_title: {type: string}
  mattermost_attach_opensearch_discover_url: {type: boolean}
  mattermost_opensearch_discover_color: {type: string}
  mattermost_opensearch_discover_title: {type: string}


  ### Microsoft Teams
  ms_teams_webhook_url: *arrayOfString
  ms_teams_alert_summary: {type: string}
  ms_teams_theme_color: {type: string}
  ms_teams_proxy: {type: string}
  ms_teams_alert_fixed_width: {type: boolean}
  ms_teams_alert_facts: *arrayOfMsTeamsFacts
  ms_teams_attach_kibana_discover_url: {type: boolean}
  ms_teams_kibana_discover_title: {type: string}
  ms_teams_ca_certs: {type: [boolean, string]}
  ms_teams_ignore_ssl_errors: {type: boolean}
  ms_teams_attach_opensearch_discover_url: {type: boolean}
  ms_teams_opensearch_discover_title: {type: string}


  ### Microsoft Power Automate
  ms_power_automate_webhook_url: *arrayOfString
  ms_power_automate_webhook_url_from_field: { type: string }
  ms_power_automate_alert_summary: {type: string}
  ms_power_automate_summary_text_size: {type: string, enum: ['default', 'small', 'medium', 'large', 'extraLarge']}
  ms_power_automate_body_text_size: {type: string, enum: ['default', 'small', 'medium', 'large', 'extraLarge']}
  ms_power_automate_proxy: {type: string}
  ms_power_automate_alert_facts: *arrayOfMsPowerAutomateFacts
  ms_power_automate_kibana_discover_attach_url: {type: boolean}
  ms_power_automate_kibana_discover_title: {type: string}
  ms_power_automate_kibana_discover_color: {type: string, enum: ['default', 'positive', 'destructive']}
  ms_power_automate_ca_certs: {type: [boolean, string]}
  ms_power_automate_ignore_ssl_errors: {type: boolean}
  ms_power_automate_opensearch_discover_attach_url: {type: boolean}
  ms_power_automate_opensearch_discover_title: {type: string}
  ms_power_automate_opensearch_discover_color: {type: string, enum: ['default', 'positive', 'destructive']}
  ms_power_automate_teams_card_width_full: {type: boolean}

  ### Opsgenie
  opsgenie_account: {type: string}
  opsgenie_addr: {type: string}
  opsgenie_alias: {type: string}
  opsgenie_default_recipients: *arrayOfString
  opsgenie_default_teams: *arrayOfString
  opsgenie_description: {type:string}
  opsgenie_details:
    type: object
    minProperties: 1
    patternProperties:
      "^.+$":
        oneOf:
          - type: string
          - type: object
            additionalProperties: false
            required: [field]
            properties:
              field: {type: string, minLength: 1}
  opsgenie_entity: {type: string}
  opsgenie_key: {type: string}
  opsgenie_message: {type: string}
  opsgenie_priority: {type: string}
  opsgenie_proxy: {type: string}
  opsgenie_recipients_args: *opsGenieArgs
  opsgenie_recipients: *arrayOfString
  opsgenie_source: {type: string}
  opsgenie_subject: {type: string}
  opsgenie_subject_args: *arrayOfString
  opsgenie_tags: *arrayOfString
  opsgenie_teams_args: *opsGenieArgs
  opsgenie_teams: *arrayOfString


  ### PagerDuty
  pagerduty_service_key: {type: string}
  pagerduty_client_name: {type: string}
  pagerduty_event_type: {enum: [none, trigger, resolve, acknowledge]}
  pagerduty_incident_key: {type: string}
  pagerduty_incident_key_args: {type: array, items: {type: string}}
  pagerduty_proxy: {type: string}
  pagerduty_ca_certs: {type: [boolean, string]}
  pagerduty_ignore_ssl_errors: {type: boolean}
  pagerduty_api_version: {type: string, enum: ['v1', 'v2']}
  pagerduty_v2_payload_class: {type: string}
  pagerduty_v2_payload_class_args: {type: array, items: {type: string}}
  pagerduty_v2_payload_component: {type: string}
  pagerduty_v2_payload_component_args: {type: array, items: {type: string}}
  pagerduty_v2_payload_group: {type: string}
  pagerduty_v2_payload_group_args: {type: array, items: {type: string}}
  pagerduty_v2_payload_severity: {type: string, enum: ['critical', 'error', 'warning', 'info']}
  pagerduty_v2_payload_source: {type: string}
  pagerduty_v2_payload_source_args: {type: array, items: {type: string}}
  pagerduty_v2_payload_include_all_info: {type: boolean}

  ### PagerTree
  pagertree_integration_url: {type: string}
  pagertree_proxy: {type: string}

  ### RocketChat
  rocket_chat_webhook_url: *arrayOfString
  rocket_chat_username_override: {type: string}
  rocket_chat_channel_override: *arrayOfString
  rocket_chat_emoji_override: {type: string}
  rocket_chat_msg_color: {enum: [good, warning, danger]}
  rocket_chat_text_string: {type: string}
  rocket_chat_proxy: {type: string}
  rocket_chat_attach_kibana_discover_url: {type: boolean}
  rocket_chat_kibana_discover_color: {type: string}
  rocket_chat_kibana_discover_title: {type: string}
  rocket_chat_ca_certs: {type: [boolean, string]}
  rocket_chat_ignore_ssl_errors: {type: boolean}
  rocket_chat_timeout: {type: integer}

  ### ServiceNow
  servicenow_rest_url: {type: string}
  username: {type: string}
  password: {type: string}
  short_description: {type: string}
  comments: {type: string}
  assignment_group: {type: string}
  category: {type: string}
  subcategory: {type: string}
  cmdb_ci: {type: string}
  caller_id: {type: string}
  servicenow_proxy: {type: string}
  servicenow_impact: {type: integer, minimum: 1, maximum: 3}
  servicenow_urgency: {type: integer, minimum: 1, maximum: 3}

  ### Slack
  slack_webhook_url: *arrayOfString
  slack_username_override: {type: string}
  slack_channel_override: *arrayOfString
  slack_emoji_override: {type: string}
  slack_icon_url_override: {type: string}
  slack_msg_color: {enum: [good, warning, danger]}
  slack_parse_override: {enum: [none, full]}
  slack_text_string: {type: string}
  slack_proxy: {type: string}
  slack_alert_fields: *arrayOfSlackField
  slack_ignore_ssl_errors: {type: boolean}
  slack_title: {type: string}
  slack_title_link: {type: string}
  slack_timeout: {type: integer}
  slack_attach_kibana_discover_url: {type: boolean}
  slack_kibana_discover_color: {type: string}
  slack_kibana_discover_title: {type: string}
  slack_attach_opensearch_discover_url: {type: boolean}
  slack_opensearch_discover_color: {type: string}
  slack_opensearch_discover_title: {type: string}
  slack_attach_jira_ticket_url: {type: boolean}
  slack_jira_ticket_color: {type: string}
  slack_jira_ticket_title: {type: string}
  slack_ca_certs: {type: [boolean, string]}
  slack_footer: {type: string}
  slack_footer_icon: {type: string}
  slack_image_url: {type: string}
  slack_thumb_url: {type: string}
  slack_author_name: {type: string}
  slack_author_link: {type: string}
  slack_author_icon: {type: string}
  slack_msg_pretext: {type: string}

  ### Splunk On-Call (Formerly VictorOps)
  victorops_api_key: {type: string}
  victorops_routing_key: {type: string}
  victorops_message_type: {enum: [INFO, WARNING, ACKNOWLEDGEMENT, CRITICAL, RECOVERY]}
  victorops_entity_id: {type: string}
  victorops_entity_display_name: {type: string}
  victorops_proxy: {type: string}

  ### Stomp
  stomp_hostname: {type: string}
  stomp_hostport: {type: string}
  stomp_login: {type: string}
  stomp_password: {type: string}
  stomp_destination: {type: string}

  ### Telegram
  telegram_bot_token: {type: string}
  telegram_room_id: {type: string}
  telegram_api_url: {type: string}
  telegram_proxy: {type: string}
  telegram_proxy_login: {type: string}
  telegram_proxy_pass: {type: string}
  telegram_parse_mode: {type: string, enum: ['markdown', 'markdownV2', 'html']}
  telegram_thread_id: {type: number}

  ### Tencent SMS
  tencent_sms_secret_id: {type: string}
  tencent_sms_secret_key: {type: string}
  tencent_sms_sdk_appid: {type: string}
  tencent_sms_to_number: {type: array, items: {type: string}}
  tencent_sms_region: {type: string}
  tencent_sms_sign_name: {type: string}
  tencent_sms_template_id: {type: string}
  tencent_sms_template_parm: {type: array, items: {type: string}}
  
  ### Twilio
  twilio_account_sid: {type: string}
  twilio_auth_token: {type: string}
  twilio_to_number: {type: string}
  twilio_from_number: {type: string}
  twilio_message_service_sid: {type: string}
  twilio_use_copilot: {type: boolean}

  ### WorkWechat
  work_wechat_bot_id: { type: string }
  work_wechat_msgtype: { type: string }

  ### Zabbix
  zbx_sender_host: {type: string}
  zbx_sender_port: {type: integer}
  zbx_host_from_field: {type: boolean}
  zbx_host: {type: string}
  zbx_key: {type: string}