Skip to content
Macro DeckMacro Deck Docs

Overview

Macro Deck plugin protocol - REST surface 1

Section titled “Macro Deck plugin protocol - REST surface 1”

Registration, session exchange and pre-registration discovery for out-of-process Macro Deck plugins. The wire envelope carried over the WebSocket upgrade at the end of this surface is specified in asyncapi.yaml, not here. Paths are deliberately unversioned - the protocol version is negotiated over POST /sessions, never encoded in the URL.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/api/plugins/protocol
POST
/api/plugins/registration
DELETE
/api/plugins/registration/{pluginId}
POST
/api/plugins/pairing
GET
/api/plugins/pairing/{requestId}
POST
/api/plugins/pairing/{requestId}/redemption
POST
/api/plugins/sessions
DELETE
/api/plugins/sessions/{sessionId}
GET
/plugins/ws

Authentication

Section titled “Authentication”

enrollmentToken

Section titled “enrollmentToken”

Security scheme type: apiKey

Header parameter name: X-MacroDeck-Enrollment-Token

pluginCredential

Section titled “pluginCredential”

Sent alongside the X-MacroDeck-Plugin-Id header. Session exchange only - never sent on the WebSocket upgrade.

Security scheme type: apiKey

Header parameter name: X-MacroDeck-Plugin-Secret

sessionBearer

Section titled “sessionBearer”

Authorization: Bearer , scope “plugin”.

Security scheme type: http

Bearer format: JWT

adminBearer

Section titled “adminBearer”

Authorization: Bearer , scope “admin”.

Security scheme type: http

Bearer format: JWT