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 Messages API

A message in Novu represents a notification delivered to a recipient on a particular channel. Messages contain information about the request that triggered its delivery, a view of the data sent to the recipient, and a timeline of its lifecycle events. Learn more about messages.

Novu Messages 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 Message. 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 3 operations across 3 paths, and defines 41 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.

3 operations 3 paths 41 schemas 2 DELETE1 GET

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 Messages 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 3

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

Messages 3

A message in Novu represents a notification delivered to a recipient on a particular channel. Messages contain information about the request that triggered its delivery, a view of…

GET
/v1/messages
Novu List All Messages
MessagesController_getMessages 6 params → 200400401403404405409413
DELETE
/v1/messages/{messageId}
Novu Delete a Message
MessagesController_deleteMessage 1 param → 200400401403404405409413
DELETE
/v1/messages/transaction/{transactionId}
Novu Delete Messages by TransactionId
MessagesController_deleteMessagesByTransactionId 2 params → 204400401403404405409413

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are MessageResponseDto (35 properties), WorkflowResponse (21 properties), SubscriberResponseDto (20 properties), NotificationStepDto (12 properties). Each schema is shown below with its type and property counts.

ReplyCallback
object
2 properties
DelayScheduledMetadata
object
2 properties 2 required
EmailBlock
object
4 properties 2 required
DigestRegularMetadata
object
8 properties 1 required
MessagesResponseDto
object
5 properties 4 required
MessageActionResult
object
2 properties
DigestTimedMetadata
object
5 properties 1 required
ChatOrPushProviderEnum
string
The provider identifier for the credentials
NotificationTrigger
object
4 properties 3 required
MessageCTAData
object
1 property
FieldFilterPartDto
object
4 properties 4 required
NotificationStepDto
object
12 properties
SubscriberPreferenceChannels
object
5 properties
MessageCTA
object
3 properties
EmailBlockStyles
object
1 property 1 required
MessageTemplate
object
DelayRegularMetadata
object
3 properties 1 required
MessageAction
object
3 properties
SubscriberResponseDto
object
20 properties 6 required
ErrorDto
object
6 properties 3 required
ConstraintValidation
object
2 properties 1 required
WorkflowResponse
object
21 properties 16 required
BuilderFieldTypeEnum
string
MessageActionStatusEnum
string
Status of the message action
NotificationStepData
object
11 properties
StepFilterDto
object
4 properties 4 required
ValidationErrorDto
object
7 properties 4 required
EmailBlockTypeEnum
string
Type of the email block
ButtonTypeEnum
string
Type of button for the action result
TimedConfig
object
6 properties
NotificationTriggerVariable
object
1 property 1 required
MessageButton
object
3 properties 2 required
ChannelCredentials
object
8 properties
ChannelTypeEnum
string
Channel type through which the message is sent
ChannelSettingsDto
object
4 properties 3 required
NotificationGroup
object
5 properties 3 required
DeleteMessageResponseDto
object
2 properties 2 required
TextAlignEnum
string
Text alignment for the email block
ChannelCTATypeEnum
string
Type of call to action
MessageResponseDto
object
35 properties 11 required
MessageStatusEnum
string
Status of the message

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-messages-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 Messages 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.