Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Novu Notifications API

The Notifications API from Novu — 2 operation(s) for notifications.

Novu Notifications 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 Notifications. 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 2 operations across 2 paths, and defines 31 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.

2 operations 2 paths 31 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.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 Notifications 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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Notifications 2
GET
/v1/notifications
Novu List All Events
NotificationsController_listNotifications 14 params → 200400401403404405409413
GET
/v1/notifications/{notificationId}
Novu Retrieve an Event
NotificationsController_getNotification 1 param → 200400401403404405409413

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are ActivityNotificationResponseDto (21 properties), ActivityNotificationStepResponseDto (12 properties), ActivityNotificationJobResponseDto (11 properties), DigestMetadataDto (10 properties). Each schema is shown below with its type and property counts.

DigestTypeEnum
string
The Digest Type
DigestMetadataDto
object
10 properties 1 required
OrdinalValueEnum
string
Value of the ordinal
NotificationTriggerVariable
object
1 property 1 required
SeverityLevelEnum
string
Severity of the workflow
MessageTemplateDto
object
ProvidersIdEnum
string
Provider ID of the job
ActivityNotificationJobResponseDto
object
11 properties 6 required
ConstraintValidation
object
2 properties 1 required
ActivityNotificationTemplateResponseDto
object
4 properties 2 required
ActivityTopicDto
object
2 properties 2 required
FieldFilterPartDto
object
4 properties 4 required
ResourceOriginEnum
string
Origin of the layout
ValidationErrorDto
object
7 properties 4 required
MonthlyTypeEnum
string
Type of monthly schedule
ErrorDto
object
6 properties 3 required
ActivityNotificationResponseDto
object
21 properties 4 required
ActivitiesResponseDto
object
4 properties 4 required
ActivityNotificationStepResponseDto
object
12 properties 4 required
NotificationTriggerDto
object
4 properties 3 required
StepFilterDto
object
4 properties 4 required
ChannelTypeEnum
string
Channel type through which the message is sent
DigestTimedConfigDto
object
8 properties
StepTypeEnum
string
Type of the step
ActivityNotificationExecutionDetailResponseDto
object
9 properties 6 required
BuilderFieldTypeEnum
string
DigestUnitEnum
string
Regular digest: Unit for backoff
OrdinalEnum
string
Ordinal position for the digest
ActivityNotificationSubscriberResponseDto
object
6 properties 2 required
ExecutionDetailsStatusEnum
string
Status of the execution detail
ExecutionDetailsSourceEnum
string
Source of the execution detail

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-notifications-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