Novu

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.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/integrations List all channel integrations · Novu List All Integrations #
Ask an LLM
“Which delivery providers have I integrated with Novu, active or not?”
“How do I see every email, SMS, push and chat integration in my organization?”
Tell an agent
List all my channel integrations, including inactive ones.
Show every provider integration configured in the organization.
POST /v1/integrations Add a delivery provider integration · Novu Create an Integration #
Ask an LLM
“How do I connect a new email or SMS provider to Novu?”
“Can I create an integration that starts out inactive?”
Tell an agent
Create a {channel} integration for provider {providerId}.
Add provider {providerId} as integration {name} with credentials {credentials}.
GET /v1/integrations/active List active integrations · Novu List Active Integrations #
Ask an LLM
“Which of my integrations are currently turned on?”
“What providers are actually live for delivering notifications right now?”
Tell an agent
List only my active integrations.
Show the integrations that are currently enabled.
PUT /v1/integrations/{integrationId} Update an integration · Novu Update an Integration #
Ask an LLM
“How do I rotate the API key on an existing provider integration?”
“Can I deactivate an integration without deleting it?”
Tell an agent
Update integration {integrationId} with new credentials {credentials}.
Set integration {integrationId} active to {active}.
DELETE /v1/integrations/{integrationId} Delete an integration · Novu Delete an Integration #
Ask an LLM
“How do I remove a provider integration permanently?”
“Is deleting an integration reversible?”
Tell an agent destructive · confirm first
Delete integration {integrationId}.
Permanently remove the provider integration {integrationId}.
POST /v1/integrations/{integrationId}/auto-configure Auto-configure inbound webhooks for an integration · Novu Auto-configure an Integration for Inbound Webhooks #
Ask an LLM
“Can Novu set up the webhook signing keys and endpoints for a provider automatically?”
“How do I enable inbound webhook support on one of my integrations?”
Tell an agent
Auto-configure inbound webhooks for integration {integrationId}.
Generate webhook signing keys and endpoints for integration {integrationId}.
POST /v1/integrations/{integrationId}/set-primary Make an integration the primary provider · Novu Update Integration as Primary #
Ask an LLM
“How do I choose which email provider is used by default in a workflow?”
“Can I switch the primary SMS integration for this environment?”
Tell an agent
Set integration {integrationId} as the primary one for its channel.
Make {integrationId} the default provider for delivery.
POST /v1/integrations/chat/oauth Generate a chat OAuth URL (deprecated) · Novu Generate Chat OAuth URL #
Ask an LLM
“What was the older, deprecated endpoint for generating a chat OAuth link?”
“Does the legacy chat OAuth URL endpoint still let a subscriber authorize a chat integration?”
Tell an agent
Use the deprecated chat OAuth endpoint to build a link for integration {integrationIdentifier}.
Generate a legacy chat OAuth URL for subscriber {subscriberId} on integration {integrationIdentifier}.
POST /v1/integrations/channel-connections/oauth Generate an OAuth URL for a workspace install · Novu Generate OAuth URL for a Workspace/tenant Connection #
Ask an LLM
“How do I get a link to install my Slack app into a customer's workspace?”
“How long does a workspace connection OAuth link stay valid?”
Tell an agent
Generate a workspace install OAuth URL for integration {integrationIdentifier}.
Create a tenant connection OAuth link for {integrationIdentifier} with connection id {connectionIdentifier}.
POST /v1/integrations/channel-endpoints/oauth Generate an OAuth URL to link a subscriber's chat user · Novu Generate OAuth URL to Link a Subscriber User Identity #
Ask an LLM
“How do I link a subscriber to their own Slack user ID?”
“Can a subscriber connect their MS Teams identity so messages reach them directly?”
Tell an agent
Generate a user-link OAuth URL for subscriber {subscriberId} on integration {integrationIdentifier}.
Let subscriber {subscriberId} link their chat identity through {integrationIdentifier} using scope {userScope}.

Documentation

📖
Documentation
https://docs.novu.co/api-reference/overview
📖
APIReference
https://docs.novu.co/api-reference/overview
📖
Authentication
https://docs.novu.co/api-reference/overview#authentication
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/rate-limits/novu-rate-limits.yml
📖
GettingStarted
https://docs.novu.co/platform/quickstart/nextjs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/openapi/novu-integrations-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/novuhq/examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-trigger-event-request-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-trigger-event-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-bulk-trigger-event-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-subscriber-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-create-subscriber-request-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-bulk-subscriber-create-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-create-environment-request-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-update-environment-request-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-environment-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-topic-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-create-integration-request-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-update-integration-request-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-integration-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-message-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-create-workflow-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-update-workflow-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-workflow-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-layout-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-subscriber-payload-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-schema/novu-error-dto-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-trigger-event-request-dto-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-subscriber-response-dto-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-workflow-response-dto-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-message-response-dto-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-topic-response-dto-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/json-structure/novu-integration-response-dto-structure.json

Other Resources

🔗
Swagger
https://api.novu.co/api
🔗
Postman
https://github.com/novuhq/novu-postman
🔗
SDKs
https://www.npmjs.com/package/@novu/api
🔗
SDKs
https://pypi.org/project/novu-py/
🔗
SDKs
https://github.com/novuhq/novu-go
🔗
SDKs
https://github.com/novuhq/php-novu
🔗
SDKs
https://github.com/novuhq/novu-csharp
🔗
SDKs
https://github.com/novuhq/novu-java
🔗
SDKs
https://github.com/novuhq/novu-elixir
🔗
SDKs
https://github.com/novuhq/novu-kotlin
🔗
SDKs
https://github.com/novuhq/novu-ruby
🔗
SDKs
https://github.com/novuhq/novu-rust
🔗
SDKs
https://github.com/novuhq/novu-dotnet
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-trigger-event-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-trigger-event-bulk-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-broadcast-event-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-create-subscriber-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-bulk-create-subscribers-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-create-topic-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-add-subscribers-to-topic-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-create-environment-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-create-integration-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-workflow-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-list-messages-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/examples/novu-error-response-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/novu:novu-integrations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

novu-integrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Novu Integrations API
  description: Novu REST API. Please see https://docs.novu.co/api-reference for more details.
  version: 3.15.0
  contact:
    name: Novu Support
    url: https://discord.gg/novu
    email: support@novu.co
  termsOfService: https://novu.co/terms
  license:
    name: MIT
    url: https://opensource.org/license/mit
servers:
- url: https://api.novu.co
- url: https://eu.api.novu.co
security:
- secretKey: []
tags:


# --- truncated at 32 KB (144 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/openapi/novu-integrations-api-openapi.yml