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

With the help of the Integration Store, you can easily integrate your favorite delivery provider. During the runtime of the API, the Integrations Store is responsible for storing the configurations of all the providers.

Novu Integrations 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 Integration. 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 10 operations across 8 paths, and defines 16 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.

10 operations 8 paths 16 schemas 1 DELETE2 GET6 POST1 PUT

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 Integrations 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 10

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

Integrations 10

With the help of the Integration Store, you can easily integrate your favorite delivery provider. During the runtime of the API, the Integrations Store is responsible for storing…

GET
/v1/integrations
Novu List All Integrations
IntegrationsController_listIntegrations → 200400401403404405409413
POST
/v1/integrations
Novu Create an Integration
IntegrationsController_createIntegration body → 201400401403404405409413
GET
/v1/integrations/active
Novu List Active Integrations
IntegrationsController_getActiveIntegrations → 200400401403404405409413
PUT
/v1/integrations/{integrationId}
Novu Update an Integration
IntegrationsController_updateIntegrationById 1 param body → 200400401403404405409413
DELETE
/v1/integrations/{integrationId}
Novu Delete an Integration
IntegrationsController_removeIntegration 1 param → 200400401403404405409413
POST
/v1/integrations/{integrationId}/auto-configure
Novu Auto-configure an Integration for Inbound Webhooks
IntegrationsController_autoConfigureIntegration 1 param → 200400401403404405409413
POST
/v1/integrations/{integrationId}/set-primary
Novu Update Integration as Primary
IntegrationsController_setIntegrationAsPrimary 1 param → 200400401403404405409413
POST
/v1/integrations/chat/oauthdeprecated
Novu Generate Chat OAuth URL
IntegrationsController_getChatOAuthUrl body → 201400401403404405409413
POST
/v1/integrations/channel-connections/oauth
Novu Generate OAuth URL for a Workspace/tenant Connection
IntegrationsController_generateConnectOAuthUrl body → 201400401403404405409413
POST
/v1/integrations/channel-endpoints/oauth
Novu Generate OAuth URL to Link a Subscriber User Identity
IntegrationsController_generateLinkUserOAuthUrl body → 201400401403404405409413

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CredentialsDto (53 properties), IntegrationResponseDto (16 properties), CreateIntegrationRequestDto (11 properties), GenerateChatOauthUrlRequestDto (9 properties). Each schema is shown below with its type and property counts.

AutoConfigureIntegrationResponseDto
object
3 properties 1 required
CredentialsDto
object
53 properties
ConfigurationsDto
object
2 properties
FieldFilterPartDto
object
4 properties 4 required
GenerateConnectOauthUrlRequestDto
object
7 properties 1 required
CreateIntegrationRequestDto
object
11 properties
UpdateIntegrationRequestDto
object
8 properties
ErrorDto
object
6 properties 3 required
GenerateChatOAuthUrlResponseDto
object
1 property 1 required
ConstraintValidation
object
2 properties 1 required
BuilderFieldTypeEnum
string
StepFilterDto
object
4 properties 4 required
ValidationErrorDto
object
7 properties 4 required
GenerateLinkUserOauthUrlRequestDto
object
5 properties 2 required
IntegrationResponseDto
object
16 properties 8 required
GenerateChatOauthUrlRequestDto
object
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-integrations-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 Layouts API
Where this information came from

This is an independent, third-party profile of Novu Integrations 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.