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 19 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.1.0, at version 3.15.0.
Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.
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 (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.
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.
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), SmsStepResponseDto (13 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.