Cyclium.Output.Adapter behaviour (Cyclium v0.5.2)

Copy Markdown View Source

Behaviour for output delivery adapters (email, Slack, issues, etc.). The consuming app provides implementations per output type.

Adapters are registered via app config:

config :cyclium, :output_adapters, %{
  email: MyApp.Adapters.Email,
  slack: MyApp.Adapters.Slack
}

Summary

Callbacks

deliver(type, payload, ctx)
redact(payload)

Optional: the payload as it may be stored in cyclium_outputs.payload_redacted. The router stores the full payload when an adapter does not implement this; Cyclium.Redaction still strips values under credential-like keys either way.

Functions

all()

List all registered output adapter type names.

resolve(type)

Resolve an output adapter module by type name. Returns nil if no adapter is registered for the given type.

Callbacks

deliver(type, payload, ctx)

@callback deliver(type :: atom() | binary(), payload :: map(), ctx :: map()) ::
  {:ok, ref :: map()} | {:error, reason :: term()}

redact(payload)

(optional) 
@callback redact(payload :: map()) :: map()

Optional: the payload as it may be stored in cyclium_outputs.payload_redacted. The router stores the full payload when an adapter does not implement this; Cyclium.Redaction still strips values under credential-like keys either way.

Functions

all()

List all registered output adapter type names.

resolve(type)

Resolve an output adapter module by type name. Returns nil if no adapter is registered for the given type.