Retrieve workflow step

Retrieves data for a specific step in a workflow

get/v2/workflows/{workflowId}/steps/{stepId}

Path parameters

workflowIdstring required

stepIdstring required

Response

controlValuesobject

Control values for the step (alias for controls.values)

providerOverridesobject nullable

Per-provider content overrides keyed by providerId. Stored separately from controlValues and merged over the default body at send time. Keys are ChatProviderIdEnum / ToolProviderIdEnum values (e.g. slack, whatsapp-business, pagerduty).

variablesobject required

JSON Schema for variables, follows the JSON Schema standard

stepIdstring required

Unique identifier of the step

_idstring required

Database identifier of the step

namestring required

Name of the step

slugstring required

Slug of the step

Type of the step

origin'novu-cloud' | 'novu-cloud-v1' | 'external' required

Origin of the layout

workflowIdstring required

Workflow identifier

workflowDatabaseIdstring required

Workflow database identifier

stepResolverHashstring

Hash identifying the deployed Cloudflare Worker for this step

Example response

{
  "providerOverrides": {
    "slack": {
      "text": "{{payload.title}}",
      "blocks": [
        {
          "type": "divider"
        }
      ]
    },
    "whatsapp-business": {
      "type": "text",
      "text": {
        "body": "{{payload.title}}"
      }
    },
    "pagerduty": {
      "severity": "warning",
      "source": "novu",
      "summary": "{{payload.title}}"
    }
  }
}

Changes

Changed in 5 of the 13 revisions of this API.174

Aug 16, 2026d7137c47680a1See the full diff
- ●
  added the new CHAT_EDITOR_SELECT enum value to the //////////// response property for the response status
  response-property-enum-value-added
Aug 11, 20260aeabb0041fd22See the full diff
- ●
  added the new CHAT_CARD_INVALID_BUTTON enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new CHAT_CARD_LIMIT_EXCEEDED enum value to the //////// response property for the response status
  response-property-enum-value-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
Jul 31, 202647f16ff4d42711See the full diff
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ○
  removed from the response property allOf list for the response status
  response-property-all-of-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026d48666bd891411See the full diff
- ●
  added the new UNSUPPORTED_PROPERTY enum value to the //////// response property for the response status
  response-property-enum-value-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 21, 20262e115ea8160c3See the full diff
- ●
  added the new TOOL enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new TOOL_BODY enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new tool enum value to the response property for the response status
  response-property-enum-value-added

Full history