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 Channel Connections API

The Channel Connections API from Novu — 2 operation(s) for channel connections.

Novu Channel Connections 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 Channel Connections. 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 5 operations across 2 paths, and defines 10 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.

5 operations 2 paths 10 schemas 1 DELETE2 GET1 PATCH1 POST

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 Channel Connections 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 5

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

Channel Connections 5
GET
/v1/channel-connections
Novu List All Channel Connections
ChannelConnectionsController_listChannelConnections 11 params → 200400401403404405409413
POST
/v1/channel-connections
Novu Create a Channel Connection
ChannelConnectionsController_createChannelConnection body → 201400401403404405409413
GET
/v1/channel-connections/{identifier}
Novu Retrieve a Channel Connection
ChannelConnectionsController_getChannelConnectionByIdentifier 1 param → 200400401403404405409413
PATCH
/v1/channel-connections/{identifier}
Novu Update a Channel Connection
ChannelConnectionsController_updateChannelConnection 1 param body → 200400401403404405409413
DELETE
/v1/channel-connections/{identifier}
Novu Delete a Channel Connection
ChannelConnectionsController_deleteChannelConnection 1 param → 204400401403404405409413

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are GetChannelConnectionResponseDto (10 properties), ValidationErrorDto (7 properties), CreateChannelConnectionRequestDto (7 properties), ErrorDto (6 properties). Each schema is shown below with its type and property counts.

CreateChannelConnectionRequestDto
object
7 properties 3 required
ProvidersIdEnum
string
Provider ID of the job
WorkspaceDto
object
2 properties 1 required
ErrorDto
object
6 properties 3 required
ValidationErrorDto
object
7 properties 4 required
ConstraintValidation
object
2 properties 1 required
ListChannelConnectionsResponseDto
object
5 properties 5 required
GetChannelConnectionResponseDto
object
10 properties 10 required
UpdateChannelConnectionRequestDto
object
2 properties 2 required
AuthDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-channel-connections-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 Endpoints API
Novu Contexts API
Novu Domains API
Novu Environment Variables API
Novu Environments API
Novu Events API
Novu Integrations API
Novu Layouts API