Skip to content

Milky V1 Protocol Configuration

Complete configuration guide for Milky V1 protocol.

Configuration Location

Can be set in general as default values, or configured individually at account level:

yaml
# Global default configuration
general:
  milky.v1:
    use_http: true
    use_ws: false

# Account level configuration (overrides general)
{platform}.{account_id}:
  milky.v1:
    use_http: true
    use_ws: true

Configuration Fields

FieldTypeRequiredDescriptionDefault
use_httpboolean | HttpConfigNoWhether to enable HTTP API or HTTP config objecttrue
use_wsboolean | WsConfigNoWhether to enable WebSocket or WebSocket config objectfalse
access_tokenstringNoAccess token for authentication-
secretstringNoHMAC signature key-
heartbeatnumberNoHeartbeat interval (seconds)-
post_message_formatstringNoMessage format: string or arraystring
http_reversestring[] | HttpReverseConfig[]NoHTTP reverse push configuration list[]
ws_reversestring[] | WsReverseConfig[]NoWebSocket reverse connection configuration list[]
filtersanyNoEvent filters-