workflows.updateStep
Update the configuration for a workflow step.
Facts
Method URL: | https://slack.com/api/workflows.updateStep | ||||
---|---|---|---|---|---|
Preferred HTTP method: | POST | ||||
Accepted content types: | application/x-www-form-urlencoded , application/json | ||||
Rate limiting: | Tier 2 | ||||
Works with: |
|
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
workflow_step_edit_id
A context identifier provided with view_submission
payloads used to call back to workflows.updateStep
.
inputs
A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here.
Example{"title":{"value":"The Title"},"submitter":{"value":"{{user}}"}}
outputs
An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.
Example[{"name":"ticket_id","type":"text","label":"Ticket ID"},{"name":"title","type":"text","label":"Title"}]
step_image_url
An optional field that can be used to override app image that is shown in the Workflow Builder.
step_name
An optional field that can be used to override the step name that is shown in the Workflow Builder.
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
Errors
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok
params in the response.
Error | Description |
---|---|
not_found | Error returned when the |
invalid_payload | Error returned when the payload is invalid |
invalid_inputs | Error returned when an input is missing the required |
invalid_trigger | Error returned when the provided |
unsupported_context_type | The |
trigger_expired | Error returned when there was a timeout between view submission and |
invalid_token | Error returned when the token used is invalid. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
not_authed | No authentication token provided. |
invalid_auth | Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
account_inactive | Authentication token is for a deleted user or workspace when using a |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed when using a |
no_permission | The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
not_allowed_token_type | The token type used in this request is not allowed. |
method_deprecated | The method has been deprecated. |
deprecated_endpoint | The endpoint has been deprecated. |
two_factor_setup_required | Two factor setup is required. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
is_bot | This method cannot be called by a bot user. |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_array_arg | The method was passed an array as an argument. Please only input valid strings. |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
ratelimited | The request has been ratelimited. Refer to the |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
Warnings
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |