Skip to content

Bridge protocol

The Bridge protocol is the HTTP protocol between Muster and a bridge, the separate service through which Muster delivers Alert Groups to a messenger it has no native support for: Muster calls the bridge to post, edit and reply, and the bridge reports presses, Thread messages, Account link requests and deleted messages back.

This is version 1.0.0 of the protocol. Every path is under /v1/, and a bridge reports protocol_version "1" in its answer to GET /v1/info. New optional fields and features keep version 1; a change that breaks existing bridges gets a new major path. The protocol is published under the MIT licence, so a bridge may stay closed.

  • The Bridge protocol reference is rendered from api/bridge.yaml, the OpenAPI document of the protocol, so it describes the protocol this version of Muster speaks.
  • The specification itself, as a raw file, is api/bridge.yaml on master.
  • Write a bridge is the guide: the bridge libraries first, then the protocol step by step.