Novu Workflows API
Multi-channel notification workflow definitions.
Novu Workflows API is one of 13 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 7 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against 2 base URLs: https://api.novu.co/v1, https://eu.api.novu.co/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Novu Workflows API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (apiKeyAuth).
By default, every request must be authenticated.
apiKeyAuth— Novu secret API key from the Dashboard API Keys page, sent as Authorization: ApiKey .
Paths & Operations 7
Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Multi-channel notification workflow definitions.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are WorkflowInput (6 properties), Error (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Novu 12
Other APIs Novu publishes across the network.