Retrieve workflow step
Retrieves data for a specific step in a workflow
Authorization
Authorization
<token>API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
In: header
Path Parameters
workflowId
RequiredstringstepId
RequiredstringHeader Parameters
idempotency-key
stringA header for idempotency purposes
Response Body
OK
controls
RequiredobjectControls metadata for the step
controlValues
objectControl values for the step (alias for controls.values)
variables
RequiredobjectJSON Schema for variables, follows the JSON Schema standard
stepId
RequiredstringUnique identifier of the step
_id
RequiredstringDatabase identifier of the step
name
RequiredstringName of the step
slug
RequiredobjectSlug of the step
type
RequiredstringType of the step
Value in:
"in_app" | "email" | "sms" | "chat" | "push" | "digest" | "trigger" | "delay" | "custom"
origin
RequiredstringOrigin of the workflow
Value in:
"novu-cloud" | "novu-cloud-v1" | "external"
workflowId
RequiredstringWorkflow identifier
workflowDatabaseId
RequiredstringWorkflow database identifier
issues
objectIssues associated with the step