Workflows: workflow_step object

workflow_step object

A workflow_step object holds information about an app's workflow step. This object is used during configuration and execution of a step as well as view submissions. The format of inputs and outputs will depend on the context of the step.

Arguments

Example

{
	"workflow_id": "12312",
	"step_id": "123894",
	"step_name": "Create Acme Issue",
	"step_image_url": "https://acmecorp.cdn/path/to/square/image.png",
	"inputs": {
		"title": {
			"value": "{{user}} submitted an issue",
			"skip_variable_replacement": false
		},
		"submitter": {
			"value": "{{user}}",
			"skip_variable_replacement": false
		},
		"channel": {
			"value": "{{channel}}",
			"skip_variable_replacement": false
		}
	},
	"outputs": [
		{
			"name": "ticket_id",
			"type": "text",
			"label": "Ticket ID"
		},
		{
			"name": "title",
			"type": "text",
			"label": "Title"
		}
	]
}

input object

An object that holds information about the user inputs for that workflow step.

You can specify variables in your input's value object using a handlebar-like format, e.g. {{variable}}. During workflow execution, those variables will be replaced with their actual runtime value, unless you have skip_variable_replacement enabled. value can be any valid JSON value.

Example

"inputs": {
	"title": {
		"value": "{{user}} submitted an issue",
		"skip_variable_replacement": false
	}
}

output object

An object that holds information about outputs this workflow step will produce. Outputs can be used in subsequent steps of a workflow.

Arguments

Example

{
	"name":"ticket_id",
	"type":"text",
	"label":"Ticket ID"
}