Workflows.Steps

Overview

Available Operations

• get - Retrieve workflow step

get

Retrieves data for a specific step in a workflow

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.WorkflowControllerGetWorkflowStepDataResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        WorkflowControllerGetWorkflowStepDataResponse res = sdk.workflows().steps().get()
                .workflowId("<id>")
                .stepId("<id>")
                .call();

        if (res.stepResponseDto().isPresent()) {
            System.out.println(res.stepResponseDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
workflowId	String	:heavy_check_mark:	N/A
stepId	String	:heavy_check_mark:	N/A
idempotencyKey	Optional<String>	:heavy_minus_sign:	A header for idempotency purposes

Response

WorkflowControllerGetWorkflowStepDataResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*