Node.js SDKResources

Steps

Node.js SDK - Workflow step execution resource

Steps

Resource for Workflow step execution. Access via client.steps.

Methods

runAsync(params, options?)

Runs a workflow step asynchronously with a .wait() method for polling.

const status = await client.steps.runAsync({
  stepId: 'step_abc123',
  conversionId: 'conv_xyz',
});

const result = await status.wait();
console.log(result.status, result.data);

Parameters: StepsRunParams Returns: Promise<StepExecutionStatus & { wait(): Promise<StepExecutionStatus> }>

getStatus(executionId, options?)

Retrieves the current status of a step execution.

const status = await client.steps.getStatus('exec_abc123');

Parameters: executionId: string Returns: Promise<StepExecutionStatus>

Raw Responses

Access raw HTTP response details via withRawResponse:

const raw = await client.steps.withRawResponse.runAsync({
  stepId: 'step_abc123',
  conversionId: 'conv_xyz',
});

console.log(raw.statusCode);
const data = await raw.parse();

On this page