GET /workflows.updateStep

Update the configuration for a workflow extension step.

Servers

Request headers

Name Type Required Description
token String Yes

Authentication token. Requires scope: workflow.steps:execute

Query parameters

Name Type Required Description
workflow_step_edit_id String Yes

A context identifier provided with view_submission payloads used to call back to workflows.updateStep.

inputs String No

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.

outputs String No

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.

step_name String No

An optional field that can be used to override the step name that is shown in the Workflow Builder.

step_image_url String No

An optional field that can be used to override app image that is shown in the Workflow Builder.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.