Novu · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Novu Channel Connections API
6 actions
6 updates
phrasing
extends
openapi/novu-channel-connections-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Novu's API. It is a proposal applied on top of the contract, not a document Novu publishes.
What the actions change
x-apievangelist-phrasing
Targets 6
$.info
$.paths['/v1/channel-connections'].get
$.paths['/v1/channel-connections'].post
$.paths['/v1/channel-connections/{identifier}'].get
$.paths['/v1/channel-connections/{identifier}'].delete
$.paths['/v1/channel-connections/{identifier}'].patch
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Novu Channel Connections API
version: 1.0.0
extends: openapi/novu-channel-connections-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/v1/channel-connections'].get
update:
x-apievangelist-phrasing:
intent: List channel connections
effect: read
questions:
- Which chat workspace connections have been set up for my subscribers?
- Can I filter channel connections by subscriber, channel or integration?
- How do I page through all the channel connections in Novu?
instructions:
- text: List all channel connections for subscriber {subscriberId}.
slots:
subscriberId: query.subscriberId
- text: Show the channel connections that use integration {integrationIdentifier}.
slots:
integrationIdentifier: query.integrationIdentifier
- text: List every channel connection on the {channel} channel.
slots:
channel: query.channel
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/channel-connections'].post
update:
x-apievangelist-phrasing:
intent: Create a channel connection
effect: write
questions:
- How do I connect a chat workspace to an integration with its auth credentials?
- Can a resource have more than one channel connection for the same integration?
- What do I need to supply to create a new workspace connection for a subscriber?
instructions:
- text: Create a channel connection for integration {integrationIdentifier} to workspace {workspace} using auth {auth}.
slots:
integrationIdentifier: requestBody.integrationIdentifier
workspace: requestBody.workspace
auth: requestBody.auth
- text: Connect subscriber {subscriberId} to workspace {workspace} through integration {integrationIdentifier} with auth {auth}.
slots:
subscriberId: requestBody.subscriberId
workspace: requestBody.workspace
integrationIdentifier: requestBody.integrationIdentifier
auth: requestBody.auth
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/channel-connections/{identifier}'].get
update:
x-apievangelist-phrasing:
intent: Get a channel connection
effect: read
questions:
- How can I look up the details of one channel connection by its identifier?
- What workspace and integration is a specific channel connection tied to?
instructions:
- text: Show me channel connection {identifier}.
slots:
identifier: path.identifier
- text: Fetch the workspace details stored on channel connection {identifier}.
slots:
identifier: path.identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/channel-connections/{identifier}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a channel connection
effect: destructive
questions:
- How do I remove a chat workspace connection I no longer use?
- Can I disconnect a single channel connection without deleting the integration?
instructions:
- text: Delete channel connection {identifier}.
slots:
identifier: path.identifier
- text: Disconnect and remove the workspace connection {identifier}.
slots:
identifier: path.identifier
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/channel-connections/{identifier}'].patch
update:
x-apievangelist-phrasing:
intent: Update a channel connection
effect: write
questions:
- How do I refresh the auth credentials on an existing channel connection?
- Can I change the workspace an existing channel connection points to?
instructions:
- text: Update channel connection {identifier} with workspace {workspace} and auth {auth}.
slots:
identifier: path.identifier
workspace: requestBody.workspace
auth: requestBody.auth
- text: Replace the auth token on existing connection {identifier} with {auth}, keeping workspace {workspace}.
slots:
identifier: path.identifier
auth: requestBody.auth
workspace: requestBody.workspace
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay 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 openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/novu-channel-connections-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?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.
A second provider on the same verified email joins the account you already have.