Skip to main content

Other types

EmailAttachment

One file attached to an outgoing email.

FieldTypeDescription
filenamestringRequired. Filename shown to the recipient.
contentstringRequired. The file contents. base64 by default — pair it with the b64_encode post-transform, which is also what makes binary files (PDF, images) work. Use encoding: utf8 to attach…
content_typestring (nullable)MIME type, e.g. text/csv, application/pdf. Defaults to application/octet-stream.
encodingstring (nullable)How content is encoded: base64 (default) or utf8.

WsPublish

Publish a payload to realtime WebSocket channels (server push / fan-out). Every socket subscribed to any listed channel — on this node AND every peer node — receives the payload. Fire-and-forget: it does not wait for delivery.

Example

- name: Broadcast
ws_publish:
channels: a|body::rooms| # a string, an array, or an a|...| marker
data: a|OrderAction| # defaults to a|body| when omitted
FieldTypeDescription
channelsanyRequired. Channel key(s) to publish to: a string, an array of strings, or an a|... marker resolving to either.
dataanyThe payload pushed to subscribers. An a|... marker or inline JSON. Defaults to the request/message body when omitted.
retainanyStore the payload as the channel's RETAINED value, so a subscriber that connects (or reconnects) later immediately receives the current value on subscribe. Defaults to false.…

MqttPublish

A mqtt_publish action publishes a message from a pipeline to one or more MQTT topics. Every subscriber to a listed topic — on this node AND every peer node (via the realtime mesh) — receives the payload. This is the pipeline→topic direction (the inbound topic→pipeline direction is the ingest consumer). Fire-and-forget: it does not wait for broker acknowledgement.

Example

- name: Push
mqtt_publish:
topics: a|body::topic| # a string, an array, or an a|...| marker
data: a|Reading| # defaults to a|body| when omitted
qos: 1 # 0 (default) | 1 | 2
retain: false # default false
FieldTypeDescription
topicsanyRequired. Topic(s) to publish to: a string, an array of strings, or an a|... marker resolving to either.
dataanyThe payload published to subscribers. An a|... marker or inline JSON. A JSON string publishes as raw text; any other value publishes as its JSON encoding. Defaults to the…
qosnumber (nullable)MQTT quality of service for the published message: 0 (at most once, default), 1 (at least once), or 2 (exactly once).
retainanyWhether the broker retains this message as the topic's last-known-good value, delivered to future subscribers on subscribe. Defaults to false. Accepts a literal boolean OR an…

TransformAggregate

Reduce a JSON array to a summary (sum / avg / min / max / count), optionally grouped.

FieldTypeDescription
overstring (nullable)JSONPath to the array to aggregate. Omit to aggregate the whole data when it is itself an array.
keystring (nullable)Output field to hold the summary. Omit to replace the data with the summary.
sumArray<string> (nullable)Fields to sum.
avgArray<string> (nullable)Fields to average.
minArray<string> (nullable)Fields to take the minimum of.
maxArray<string> (nullable)Fields to take the maximum of.
countboolean (nullable)Include a row count in the summary (default true when no other op is given).
group_byArray<string> (nullable)Group rows by these fields; the summary is computed per group under groups.

HmacSign

Parameters for the hmac post-transform (signing).

Example

hmac:
key: signature
data: a|BuildPayload::body|
secret: a|Subscriber::secret|
algorithm: sha256
encoding: hex
FieldTypeDescription
keystringRequired. Output key the computed digest is written to.
datastringRequired. The message to sign. Supports interpolation.
secretstringRequired. The signing secret. Supports interpolation — use a|ap_var::NAME| or a per-recipient secret read from a prior action.
algorithmstring (nullable)Hash algorithm: sha1, sha256 (default), or sha512.
encodingstring (nullable)Digest encoding: hex (default) or base64.