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

Individual channel messages produced by workflow executions.

Novu Messages 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 Messages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 2 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.

2 operations 2 paths 2 schemas 1 DELETE1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.novu.co/v1
Authentication
API Key
Contact
License
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 (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 2

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

Messages 2

Individual channel messages produced by workflow executions.

GET
/messages
List all messages
listMessages 5 params → 200401
DELETE
/messages/{messageId}
Delete a message
deleteMessage 1 param → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Message (7 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties
Message
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-co-messages-api-openapi.yml Raw ↑

Other APIs Novu publishes across the network.

Novu Inbox Realtime API
Novu Environments API
Novu Events API
Novu Inbox API
Novu Integrations API
Novu Layouts API
Novu Notifications API
Novu Preferences API
Novu Subscribers API
Novu Topics API
Novu Translations API
Novu Workflows API