Element types

Types List

Actions

action/convert

Options

Asset Object Structure

You can serve Assets either with an (unprotected) URL or Base64 encoded.

action/set

Tells the client via a Webhook response to set some internal values. Usually, the object being set on the client side are fields in a resource create or edit view. Useful for dynamically filling fields based on other fields or based on data that is only available in backend.

Inputs

Outputs

Options

Response

Webhook-JSON of type set.

Example (1)

{
	"name": "Set",
	"type": "action/set",
	"options": {
		"values": {
			"shipping_street": "client_street",
			"positions[*].discount": "client_discount"
		}
	}
}

client_street and client_discount are fields present in the default-input resource. The keys are JSONPath selectors. shipping_street refers to the key with the same name in the client’s object that is to be set. positions[*].discount is a JSONPath selecting all discount fields of all entries in the positions array.

Example (2) – Full Workflow

{
	"identifier": "SetEmailWorkflow",
	"title": "Set",
	"async": false,
	"elements": [
		{
			"name": "Select",
			"type": "op/selector",
			"set": {
				"eventSelector": ":selector"
			}
		},
		{
			"name": "Set",
			"type": "action/set",
			"options": {
				"values": {
					"${eventSelector}.email": "user.email"
				}
			}
		}
	],
	"events": [
		{
			"identifier": "SetEmailEvent",
			"type": "on_change"
		}
	]
}

Graph view

graph TB
  classDef element fill:#c4c7ff;

  subgraph "SetEmailWorkflow"
  SelectInDefault((in))
  SelectInNone((in))
  SelectOutContext>$eventSelector]

  SelectInDefault -- default --> Select 
  Select -. :selector .-> SelectOutContext
  Select --> Set
  class Select element
  class Set element
  end

  subgraph "Event Bus"
  Event[SetEmailEvent] -- original --> SelectInNone
  Event[SetEmailEvent] -- default, prototype --> SelectInDefault
  Event[SetEmailEvent] -- selector --> Select
end

Note that the on_change-Event gives three inputs into the workflow. default/prototype (the current values of the resource frontend at time of the event), original (resource in edit mode, empty in create mode), and selector (the JSONPath of the parent of the field that fired the event). In this case, if the event was fired at the top-most level, the selector would be “$” and hence change the root “email” field of the resource. If the event was fired in a list field, the selector could look like “$.mylist[2]”, and the email field of this list item would be changed instead.

In this case, we expect the selector to describe a list item, so we first select only the list item with the op/selector element. In the “Set”-element, we would then set the field $.mylist[2].email to the email of the user field in the previously selected list item. This example therefore shows

• how we can select sub-fields based on the event emitter (in op/selector)
• how we can tell the client what fields we want to set with which values.

Adding an event emitter to a field

We have to set the “events” option, and in there set the “on_change” value to a list of event identifiers.

{
	"identifier": "user",
	"type": "select",
	"options": {
		"references": "users",
		"events": {
			"on_change": ["SetEmailEvent"]
		}
	}
}

action/run

Runs another Workflow. This can be either sync or async.
If New Scope is set to false the context will not change. This means all Variables will be accessible.

If New Scope is set to true a new context will be created for the action/run. Variables kann be passed to the new Context. These are set on the context not passed via the Workflowflow. This means that they are normally accessible. The output will be the output of the last Element of the executed Workflow.
The old context will automatically be restored one the action/run is done.

Api

api/http

Inputs

Outputs

Request data

Use JSON input for setting up request data, i.e.

• uri
• method
• params
  • base_uri
  • headers
• response_type

Example

{
    "uri": "/track/v1/details/$tracking_number",
    "method": "GET",
    "params": {
        "base_uri": "https://wwwcie.ups.com",
        "headers": {        
            "Accept": "application/json",
            "AccessLicenseNumber": "***********"
        }    
    },
    "response_type": "json"
}