Skip to main content

Automations

An automation does something when data changes: it watches for an action (such as update) on an item and then calls an automation target (such as sending an email or running a process). See Automations.


Automation​

Service: Automation (automation/v1).

FieldTypeRequiredWhat it is
_idStringNoAn object id, made for you when you create an automation
_typeStringPlatformVarAutomation
targetStringYesThe id of the automation target to call, for example odsl.email_attachment
templateStringYesThe sentence that describes the automation, with the property names in square brackets
propertiesObjectYesThe values for the target, by name. Names that start with @ are options of the automation itself, for example @transformer
conditionsArrayYesWhat fires the automation, see below
enabledBooleanNoDefaults to true
iconStringNoThe icon shown with the automation
groupStringNoA group, used to keep related automations together
nameStringPlatformThe template with the property values filled in
ownerStringPlatformWho saved it: the automation runs with their access
tid, environmentStringPlatformYour tenant and the data environment

Condition​

FieldTypeRequiredWhat it is
sourceStringYesprivate, public or common
serviceStringYesThe service of the item, for example data, object, event or dataset
idStringYesThe id of the item
actionStringYesThe action that fires it, for example create, update or delete
didStringNoA dependent id: when id is an event list, the event curve or timeseries built from it
keyStringNoA name for the item in the target system: the data's _id is changed to this
{
"_type": "VarAutomation",
"target": "odsl.email_attachment",
"enabled": true,
"template": "When 'NGE.POWER.DE:BASE' is updated, transform the data using [@transformer], then send an email to [to] with subject [subject], add the data as an attachment named [attachmentName]",
"properties": {
"to": "risk@northgate-energy.com",
"subject": "German power curve updated",
"attachment": true,
"attachmentName": "de_power_${date:yyyy-MM-dd}.csv",
"@transformer": "#VarCurve_CSV"
},
"conditions": [
{"source": "private", "service": "data", "id": "NGE.POWER.DE:BASE", "action": "update"}
]
}

Automation target​

An automation target is what an automation calls: a script with the information it needs. Service: Automation Target (automationtarget/v1/{source}).

FieldTypeRequiredWhat it is
_idStringPlatformpublisher.code
_typeStringPlatformVarAutomationTarget
publisherStringYesThe publisher
codeStringYesThe code of the target
scriptStringYesThe script that does the work
nameStringNoThe name
descriptionStringNoWhat it does
iconStringNoThe icon shown with the target
templateStringNoThe sentence used to collect the information, with input names in square brackets
inputsObjectNoThe inputs the user fills in, by name
propertiesObjectNoFixed values sent to the script
servicesString[]NoThe services the target works with, * for all
actionsString[]NoThe actions the target works with, * for all
tagsString[]NoTags for finding the target
allowTransformationBooleanNoTrue to let users choose a transformer for the data
allowPropertyChangeBooleanNoTrue to let users fire the automation when a property changes to a value

See the Automation Target service for the format of inputs and full examples.


Automation log entry​

Each time an automation fires, the platform writes a log entry. Service: Automation Log (automationlog/v1), read-only.

FieldTypeWhat it is
_idStringAn object id
_typeStringVarAutomationLogEntry
source, service, keyStringThe item that fired the automation
ondateStringThe date of the data, if any
propertyStringThe property that changed, for a property change
actionStringThe action
methodStringHow it was fired, for example Direct (api)
reasonStringWhy it was fired
targetStringThe target called
automationStringThe automation id
timestampDateTimeWhen it fired
statusStringsuccess, failed or running
messageStringThe answer from the target
invocationId, rootInvocationId, traceStringThe request that fired it, the request that started the chain, and the trace
{
"_id": "685526aa1001b079c8ed0c7e",
"_type": "VarAutomationLogEntry",
"source": "private",
"service": "data",
"key": "NGE.POWER.DE:BASE",
"action": "update",
"method": "Direct (api)",
"target": "odsl.email_attachment",
"automation": "68527adfe438ee467f057624",
"timestamp": "2026-11-18T18:13:22.757",
"status": "success",
"message": "Successfully sent email(German power curve updated) to risk@northgate-energy.com"
}