Novu

Novu Workflows API

All notifications are sent via a workflow. Each workflow acts as a container for the logic and blueprint that are associated with a type of notification in your system.

Documentation GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/workflows Create a workflow · Novu Create a Workflow #

Ask an LLM

“How do I create a new notification workflow with email and in-app steps?”

“Can I define a payload schema and validate it when creating a workflow?”

Tell an agent

Create workflow {name} with id {workflowId} and steps {steps}.

Create a new {severity} severity workflow {workflowId} named {name} with steps {steps}.

GET /v2/workflows List workflows · Novu List All Workflows #

Ask an LLM

“What notification workflows exist in my environment?”

“Can I filter workflows by tag or status?”

Tell an agent

List all my workflows.

Find workflows tagged {tags}.

PUT /v2/workflows/{workflowId}/sync Sync a workflow to another environment · Novu Sync a Workflow #

Ask an LLM

“Can I copy a single workflow to my production environment?”

“Is it possible to sync one workflow without publishing the whole environment?”

Tell an agent

Sync workflow {workflowId} to environment {targetEnvironmentId}.

Push just workflow {workflowId} over to {targetEnvironmentId}.

PUT /v2/workflows/{workflowId} Replace a workflow's definition · Novu Update a Workflow #

Ask an LLM

“How do I fully replace a workflow's steps and preferences?”

“What fields must I send when doing a full workflow update?”

Tell an agent

Replace workflow {workflowId} with name {name}, steps {steps}, preferences {preferences} and origin {origin}.

Overwrite all steps of workflow {workflowId} with {steps}, keeping name {name}, preferences {preferences}, origin {origin}.

GET /v2/workflows/{workflowId} Get a workflow · Novu Retrieve a Workflow #

Ask an LLM

“How do I fetch the full definition of one workflow?”

“Can I look up a workflow as it exists in a specific environment?”

Tell an agent

Show me workflow {workflowId}.

Fetch workflow {workflowId} from environment {environmentId}.

DELETE /v2/workflows/{workflowId} Delete a workflow · Novu Delete a Workflow #

Ask an LLM

“What's the way to delete a workflow I no longer need?”

“Can I remove a workflow by its identifier?”

Tell an agent destructive · confirm first

Delete workflow {workflowId}.

Remove the {workflowId} workflow permanently.

PATCH /v2/workflows/{workflowId} Partially update a workflow · Novu Update a Workflow #

Ask an LLM

“How do I deactivate a workflow without resending its steps?”

“Can I change just a workflow's tags or description?”

Tell an agent

Set workflow {workflowId} active to {active}.

Change only the tags on workflow {workflowId} to {tags}.

POST /v2/workflows/{workflowId}/step/{stepId}/preview Preview a workflow step · Novu Generate a Step Preview #

Ask an LLM

“How can I see what a workflow step's message will look like with test data?”

“Can I preview a step with draft control values before saving them?”

Tell an agent

Preview step {stepId} of workflow {workflowId}.

Render step {stepId} in workflow {workflowId} with payload {previewPayload}.

GET /v2/workflows/{workflowId}/steps/{stepId} Get a workflow step · Novu Retrieve Workflow Step #

Ask an LLM

“Where can I read the configuration of one step in a workflow?”

“What controls and settings does a particular workflow step have?”

Tell an agent

Show step {stepId} of workflow {workflowId}.

Fetch the data for step {stepId} in {workflowId}.

Novu Workflows API

Operations 9

Documentation

Specifications

Code Examples

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification