Adder API and Event Reference
Adder API and Event Reference
Section titled “Adder API and Event Reference”Overview
Section titled “Overview”This reference describes the public /events replay option and the Go API shutdown contract.
/events replay behavior
Section titled “/events replay behavior”Connect to /events to receive Adder events. Add the optional replay query parameter when a connection needs a specific delivery mode:
/events?replay=falseThe endpoint applies these rules:
- When a client omits the parameter, Adder uses
replay=trueand enables buffered replay. replay=trueenables buffered replay.replay=falsedelivers live events only. Adder does not replay buffered events.
Tray connections
Section titled “Tray connections”The built-in tray requests /events?replay=false for its initial connection. When the tray reconnects, it requests /events?replay=true, and the server replays buffered events. Other API clients can choose their own connection policy.
Go API shutdown contract
Section titled “Go API shutdown contract”The api.API interface requires this method:
Shutdown(context.Context) errorAPIv1 implements Shutdown to shut down its listener. Code that implements or calls api.API must provide or handle this method and its returned error.
Docs authored by Doc Holiday