How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

Novu Workflows API is one of 20 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, a getting-started guide, and 26 JSON Schemas.

This API exposes 9 operations across 5 paths, and defines 96 schemas. It is described by OpenAPI 3.2.0, at version 3.15.0.

Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.

9 operations 5 paths 96 schemas 1 DELETE3 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.15.0
Base URL
https://api.novu.co
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Novu Workflows API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (secretKey). By default, every request must be authenticated.

  • secretKey — API key authentication. Allowed headers-- "Authorization: ApiKey ".

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflows 9

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.

POST
/v2/workflows
Novu Create a Workflow
WorkflowController_create body → 201400401403404405409413
GET
/v2/workflows
Novu List All Workflows
WorkflowController_searchWorkflows 7 params → 200400401403404405409413
PUT
/v2/workflows/{workflowId}/sync
Novu Sync a Workflow
WorkflowController_sync 1 param body → 200400401403404405409413
PUT
/v2/workflows/{workflowId}
Novu Update a Workflow
WorkflowController_update 1 param body → 200400401403404405409413
GET
/v2/workflows/{workflowId}
Novu Retrieve a Workflow
WorkflowController_getWorkflow 2 params → 200400401403404405409413
DELETE
/v2/workflows/{workflowId}
Novu Delete a Workflow
WorkflowController_removeWorkflow 1 param → 204400401403404405409413
PATCH
/v2/workflows/{workflowId}
Novu Update a Workflow
WorkflowController_patchWorkflow 1 param body → 200400401403404405409413
POST
/v2/workflows/{workflowId}/step/{stepId}/preview
Novu Generate a Step Preview
WorkflowController_generatePreview 2 params body → 201400401403404405409413
GET
/v2/workflows/{workflowId}/steps/{stepId}
Novu Retrieve Workflow Step
WorkflowController_getWorkflowStepData 2 params → 200400401403404405409413

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are WorkflowResponseDto (23 properties), WorkflowListResponseDto (16 properties), SubscriberResponseDtoOptional (14 properties), StepResponseDto (13 properties). Each schema is shown below with its type and property counts.

ThrottleStepUpsertDto
object
5 properties 2 required
LookBackWindowDto
object
2 properties 2 required
TimeUnitEnum
string
Time unit
GeneratePreviewRequestDto
object
2 properties
EmailStepUpsertDto
object
5 properties 2 required
DigestStepUpsertDto
object
5 properties 2 required
GeneratePreviewResponseDto
object
4 properties 2 required
ListWorkflowResponse
object
2 properties 2 required
DigestControlsMetadataResponseDto
object
3 properties 1 required
ConstraintValidation
object
2 properties 1 required
DigestRegularOutput
object
4 properties 2 required
InAppStepUpsertDto
object
5 properties 2 required
StepContentIssueDto
object
3 properties 2 required
PreferencesRequestDto
object
2 properties
PushControlDto
object
3 properties
UiComponentEnum
string
Component type for the UI Schema Property
HttpRequestKeyValuePairDto
object
2 properties 2 required
EmailControlsMetadataResponseDto
object
3 properties 1 required
WorkflowPreferencesDto
object
2 properties 2 required
InAppRenderOutput
object
7 properties 1 required
ChatRenderOutput
object
1 property 1 required
PushStepUpsertDto
object
5 properties 2 required
InAppStepResponseDto
object
13 properties 10 required
DigestControlDto
object
7 properties
ChannelPreferenceDto
object
1 property 1 required
StepListResponseDto
object
3 properties 2 required
ContentIssueEnum
string
Type of step content issue
UiSchemaGroupEnum
string
Group of the UI Schema
ThrottleControlsMetadataResponseDto
object
3 properties 1 required
SmsRenderOutput
object
1 property 1 required
DelayStepUpsertDto
object
5 properties 2 required
UserResponseDto
object
4 properties 1 required
EmailControlDto
object
6 properties 2 required
HttpRequestControlsMetadataResponseDto
object
3 properties 1 required
InAppControlDto
object
9 properties
SeverityLevelEnum
string
Severity of the workflow
WorkflowPreferenceDto
object
2 properties 2 required
SmsControlDto
object
2 properties
ChatStepUpsertDto
object
5 properties 2 required
HttpRequestStepUpsertDto
object
5 properties 2 required
ChatControlDto
object
2 properties
SubscriberResponseDtoOptional
object
14 properties
DelayControlDto
object
5 properties 1 required
StepResponseDto
object
13 properties 10 required
SmsControlsMetadataResponseDto
object
3 properties 1 required
StepIntegrationIssue
object
3 properties 2 required
HttpMethodEnum
string
HTTP method
WorkflowPreferencesResponseDto
object
2 properties 1 required
PatchWorkflowDto
object
7 properties
ThrottleControlDto
object
7 properties 1 required
DelayStepResponseDto
object
13 properties 10 required
WorkflowListResponseDto
object
16 properties 10 required
ErrorDto
object
6 properties 3 required
SyncWorkflowDto
object
1 property 1 required
PushStepResponseDto
object
13 properties 10 required
RedirectDto
object
2 properties 1 required
CreateWorkflowDto
object
12 properties 3 required
ControlsMetadataDto
object
2 properties
InAppControlsMetadataResponseDto
object
3 properties 1 required
WorkflowCreationSourceEnum
string
Source of workflow creation
CustomStepResponseDto
object
13 properties 10 required
HttpRequestStepResponseDto
object
13 properties 10 required
ChannelCredentials
object
8 properties
StepTypeEnum
string
Type of the step
RuntimeIssueDto
object
SmsStepUpsertDto
object
5 properties 2 required
CustomControlDto
object
1 property
StepIssuesDto
object
2 properties
PreviewErrorDto
object
3 properties 3 required
DigestStepResponseDto
object
13 properties 10 required
CustomControlsMetadataResponseDto
object
3 properties 1 required
WorkflowResponseDtoSortField
string
ChatOrPushProviderEnum
string
The provider identifier for the credentials
WorkflowResponseDto
object
23 properties 11 required
DelayControlsMetadataResponseDto
object
3 properties 1 required
ActionDto
object
2 properties
ChatStepResponseDto
object
13 properties 10 required
EmailRenderOutput
object
2 properties 2 required
UpdateWorkflowDto
object
12 properties 4 required
EmailStepResponseDto
object
13 properties 10 required
ResourceOriginEnum
string
Origin of the layout
PushControlsMetadataResponseDto
object
3 properties 1 required
UiSchema
object
2 properties
UiSchemaProperty
object
3 properties 1 required
DirectionEnum
string
ChatControlsMetadataResponseDto
object
3 properties 1 required
ValidationErrorDto
object
7 properties 4 required
ChannelSettingsDto
object
4 properties 3 required
HttpRequestControlDto
object
7 properties 2 required
ThrottleStepResponseDto
object
13 properties 10 required
CustomStepUpsertDto
object
5 properties 2 required
PushRenderOutput
object
2 properties 2 required
WorkflowStatusEnum
string
Status of the workflow
PreviewPayloadDto
object
5 properties
IntegrationIssueEnum
string
Type of integration issue
SmsStepResponseDto
object
13 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-workflows-api-openapi.yml Raw ↑

Other APIs Novu publishes across the network.

Novu Inbox / In-App API
Novu Framework (Code-First Workflows)
Novu MCP Server
Novu Activity API
Novu Channel Connections API
Novu Channel Endpoints API
Novu Contexts API
Novu Domains API
Novu Environment Variables API
Novu Environments API
Novu Events API
Novu Integrations API
Where this information came from

This is an independent, third-party profile of Novu Workflows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.