Other types
EmailAttachment
One file attached to an outgoing email.
| Field | Type | Description |
|---|---|---|
filename | string | Required. Filename shown to the recipient. |
content | string | Required. 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_type | string (nullable) | MIME type, e.g. text/csv, application/pdf. Defaults to application/octet-stream. |
encoding | string (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
| Field | Type | Description |
|---|---|---|
channels | any | Required. Channel key(s) to publish to: a string, an array of strings, or an a|... marker resolving to either. |
data | any | The payload pushed to subscribers. An a|... marker or inline JSON. Defaults to the request/message body when omitted. |
retain | any | Store 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
| Field | Type | Description |
|---|---|---|
topics | any | Required. Topic(s) to publish to: a string, an array of strings, or an a|... marker resolving to either. |
data | any | The 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… |
qos | number (nullable) | MQTT quality of service for the published message: 0 (at most once, default), 1 (at least once), or 2 (exactly once). |
retain | any | Whether 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.
| Field | Type | Description |
|---|---|---|
over | string (nullable) | JSONPath to the array to aggregate. Omit to aggregate the whole data when it is itself an array. |
key | string (nullable) | Output field to hold the summary. Omit to replace the data with the summary. |
sum | Array<string> (nullable) | Fields to sum. |
avg | Array<string> (nullable) | Fields to average. |
min | Array<string> (nullable) | Fields to take the minimum of. |
max | Array<string> (nullable) | Fields to take the maximum of. |
count | boolean (nullable) | Include a row count in the summary (default true when no other op is given). |
group_by | Array<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
| Field | Type | Description |
|---|---|---|
key | string | Required. Output key the computed digest is written to. |
data | string | Required. The message to sign. Supports interpolation. |
secret | string | Required. The signing secret. Supports interpolation — use a|ap_var::NAME| or a per-recipient secret read from a prior action. |
algorithm | string (nullable) | Hash algorithm: sha1, sha256 (default), or sha512. |
encoding | string (nullable) | Digest encoding: hex (default) or base64. |