Work with Workflows

The following are Apex classes for the Slack workflows API methods.

WorkflowsStepCompletedRequest Class

Sends a request to indicate that an app's step in a workflow completed execution.

Usage

See Slack’s workflows.stepCompleted method.

WorkflowsStepCompletedRequest Methods

The following are methods for WorkflowsStepCompletedRequest.

builder()

Builds a request object that's used when executing the API call.

Signature

public static Slack.WorkflowsStepCompletedRequest.Builder builder()

Return Value

Type: Slack.WorkflowsStepCompletedRequest.Builder

WorkflowsStepCompletedRequest.Builder Class

Contains methods to build an instance of the Slack.WorkflowsStepCompletedRequest class.

A Builder object is obtained by invoking one of the WorkflowsStepCompletedRequest.Builder methods defined by the WorkflowsStepCompletedRequest class.

WorkflowsStepCompletedRequest.Builder Methods

The following are methods for WorkflowsStepCompletedRequest.Builder. These methods are optional unless specified otherwise.

build()

Required. Returns an instance of Slack.WorkflowsStepCompletedRequest.

Signature

public Slack.WorkflowsStepCompletedRequest build()

Return Value

Type: Slack.WorkflowsStepCompletedRequest

outputs(outputs)

Signature

public Slack.WorkflowsStepCompletedRequest.Builder outputs(Map<String,Object> outputs)

Parameters

outputs

Type: Map<String,Object>

Return Value

Type: Slack.WorkflowsStepCompletedRequest.Builder

outputsAsString(outputsAsString)

Signature

public Slack.WorkflowsStepCompletedRequest.Builder outputsAsString(String outputsAsString)

Parameters

outputsAsString

Type: String

Return Value

Type: Slack.WorkflowsStepCompletedRequest.Builder

workflowStepExecuteId(workflowStepExecuteId)

Required. Context identifier that maps to the correct workflow step execution.

Signature

public Slack.WorkflowsStepCompletedRequest.Builder workflowStepExecuteId(String workflowStepExecuteId)

Parameters

workflowStepExecuteId

Type: String

Return Value

Type: Slack.WorkflowsStepCompletedRequest.Builder

WorkflowsStepCompletedResponse Class

Indicates that an app's step in a workflow completed execution.

Usage

See Slack’s workflows.stepCompleted method.

WorkflowsStepCompletedResponse Methods

This class contains standard response methods.

WorkflowsStepFailedRequest Class

Sends a request to indicate that an app's step in a workflow failed to execute.

Usage

See Slack’s workflows.stepFailed method.

WorkflowsStepFailedRequest Methods

The following are methods for WorkflowsStepFailedRequest.

builder()

Builds a request object that's used when executing the API call.

Signature

public static Slack.WorkflowsStepFailedRequest.Builder builder()

Return Value

Type: Slack.WorkflowsStepFailedRequest.Builder

WorkflowsStepFailedRequest.Builder Class

Contains methods to build an instance of the Slack.WorkflowsStepFailedRequest class.

A Builder object is obtained by invoking one of the WorkflowsStepFailedRequest.Builder methods defined by the WorkflowsStepFailedRequest class.

WorkflowsStepFailedRequest.builder Methods

The following are methods for WorkflowsStepFailedRequest.Builder.

build()

Required. Returns an instance of Slack.WorkflowsStepFailedRequest.

Signature

public Slack.WorkflowsStepFailedRequest build()

Return Value

Type: Slack.WorkflowsStepFailedRequest

error(error)

Required. A JSON-based object with a message property that contains an error message.

Signature

public Slack.WorkflowsStepFailedRequest.Builder error(Map<String,Object> error)

Parameters

error

Type: Map<String,Object>

Return Value

Type: Slack.WorkflowsStepFailedRequest.Builder

workflowStepExecuteId(workflowStepExecuteId)

Required. Context identifier that maps to the correct workflow step execution.

Signature

public Slack.WorkflowsStepFailedRequest.Builder workflowStepExecuteId(String workflowStepExecuteId)

Parameters

workflowStepExecuteId

Type: String

Return Value

Type: Slack.WorkflowsStepFailedRequest.Builder

WorkflowsStepFailedResponse Class

Indicates that an app's step in a workflow failed to execute.

Usage

See Slack’s workflows.stepFailed method.

WorkflowsStepFailedResponse Methods

This class contains standard response methods.

WorkflowStepInput Class

WorkflowStepInput Methods

The following are methods for WorkflowStepInput.

getSkipVariableReplacement()

Signature

public Boolean getSkipVariableReplacement()

Return Value

Type: Boolean

getValue()

Signature

public Object getValue()

Return Value

Type: Object

getVariables()

Signature

public Map<String,Object> getVariables()

Return Value

Type: Map<String,Object>

setSkipVariableReplacement(skipVariableReplacement)

Signature

public void setSkipVariableReplacement(Boolean skipVariableReplacement)

Parameters

skipVariableReplacement

Type: Boolean

Return Value

Type: void

setValue(value)

Signature

public void setValue(Object value)

Parameters

value

Type: Object

Return Value

Type: void

setVariables(variables)

Signature

public void setVariables(Map<String,Object> variables)

Parameters

variables

Type: Map<String,Object>

Return Value

Type: void

WorkflowStepOutput Class

WorkflowStepOutput Methods

The following are methods for WorkflowStepOutput.

getLabel()

Signature

public String getLabel()

Return Value

Type: String

getName()

Signature

public String getName()

Return Value

Type: String

getType()

Signature

public String getType()

Return Value

Type: String

setLabel(label)

Signature

public void setLabel(String label)

Parameters

label

Type: String

Return Value

Type: void

setName(name)

Signature

public void setName(String name)

Parameters

name

Type: String

Return Value

Type: void

setType(type)

Signature

public void setType(String type)

Parameters

type

Type: String

Return Value

Type: void

WorkflowsUpdateStepRequest Class

Sends a request to update the configuration for a workflow step.

Usage

See Slack’s workflows.updateStep method.

WorkflowsUpdateStepRequest Methods

The following are methods for WorkflowsUpdateStepRequest.

builder()

Signature

public static Slack.WorkflowsUpdateStepRequest.Builder builder()

Return Value

Type: Slack.WorkflowsUpdateStepRequest.Builder

WorkflowsUpdateStepRequest.Builder Class

Contains methods to build an instance of the Slack.WorkflowsStepFailedRequest class.

A Builder object is obtained by invoking one of the WorkflowsStepFailedRequest.Builder methods defined by the WorkflowsStepFailedRequest class.

WorkflowsUpdateStepRequest.Builder Methods

The following are methods for WorkflowsUpdateStepRequest.Builder. These methods are optional unless specified otherwise.

build()

Required. Returns an instance of Slack.WorkflowsUpdateStepRequest.

Signature

public Slack.WorkflowsUpdateStepRequest build()

Return Value

Type: Slack.WorkflowsUpdateStepRequest

inputs(inputs)

Signature

public Slack.WorkflowsUpdateStepRequest.Builder inputs(Map<String,Slack.WorkflowStepInput> inputs)

Parameters

inputs

Type: Map<String,Slack.WorkflowStepInput>

Return Value

Type: Slack.WorkflowsUpdateStepRequest.Builder

inputsAsString(inputsAsString)

Signature

public Slack.WorkflowsUpdateStepRequest.Builder inputsAsString(String inputsAsString)

Parameters

inputsAsString

Type: String

Return Value

Type: Slack.WorkflowsUpdateStepRequest.Builder

outputs(outputs)

Signature

public Slack.WorkflowsUpdateStepRequest.Builder outputs(List<Slack.WorkflowStepOutput> outputs)

Parameters

outputs

Type: List<Slack.WorkflowStepOutput>

Return Value

Type: Slack.WorkflowsUpdateStepRequest.Builder

outputsAsString(outputsAsString)

Signature

public Slack.WorkflowsUpdateStepRequest.Builder outputsAsString(String outputsAsString)

Parameters

outputsAsString

Type: String

Return Value

Type: Slack.WorkflowsUpdateStepRequest.Builder

stepImageUrl(stepImageUrl)

Signature

public Slack.WorkflowsUpdateStepRequest.Builder stepImageUrl(String stepImageUrl)

Parameters

stepImageUrl

Type: String

Return Value

Type: Slack.WorkflowsUpdateStepRequest.Builder

stepName(stepName)

Signature

public Slack.WorkflowsUpdateStepRequest.Builder stepName(String stepName)

Parameters

stepName

Type: String

Return Value

Type: Slack.WorkflowsUpdateStepRequest.Builder

workflowStepEditId(workflowStepEditId)

Required. A context identifier provided with view_submission payloads used to call back to WorkflowsUpdateStepRequest.

Signature

public Slack.WorkflowsUpdateStepRequest.Builder workflowStepEditId(String workflowStepEditId)

Parameters

workflowStepEditId

Type: String

Return Value

Type: Slack.WorkflowsUpdateStepRequest.Builder

WorkflowsUpdateStepResponse Class

Update the configuration for a workflow step.

Usage

See Slack’s workflows.updateStep method.

WorkflowsUpdateStepResponse Methods

This class contains standard response methods.