Novu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Novu Channel Endpoints API

6 actions 6 updates phrasing extends openapi/novu-channel-endpoints-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/channel-endpoints'].get
$.paths['/v1/channel-endpoints'].post
$.paths['/v1/channel-endpoints/{identifier}'].get
$.paths['/v1/channel-endpoints/{identifier}'].delete
$.paths['/v1/channel-endpoints/{identifier}'].patch

OpenAPI Overlay

Raw ↑
# 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 Endpoints API
  version: 1.0.0
extends: openapi/novu-channel-endpoints-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-endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List channel endpoints
      effect: read
      questions:
      - Which chat endpoints are registered for a given subscriber?
      - Can I filter channel endpoints by the connection they belong to?
      - How do I list the endpoints on a specific channel or provider in Novu?
      instructions:
      - text: List channel endpoints for subscriber {subscriberId}.
        slots:
          subscriberId: query.subscriberId
      - text: Show the endpoints registered under connection {connectionIdentifier}.
        slots:
          connectionIdentifier: query.connectionIdentifier
      - text: List channel endpoints for provider {providerId}.
        slots:
          providerId: query.providerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/channel-endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a channel endpoint
      effect: write
      questions:
      - How do I register a new channel endpoint for a resource?
      - Can I add a chat destination endpoint for a subscriber through the API?
      instructions:
      - text: Create a new channel endpoint for this resource.
      - text: Register a new chat delivery endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/channel-endpoints/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a channel endpoint
      effect: read
      questions:
      - How do I look up one channel endpoint by its identifier?
      - What destination is stored on a particular channel endpoint?
      instructions:
      - text: Show me channel endpoint {identifier}.
        slots:
          identifier: path.identifier
      - text: Fetch the destination details of endpoint {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/channel-endpoints/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a channel endpoint
      effect: destructive
      questions:
      - How do I remove a channel endpoint so no more messages go to it?
      - Can I delete a single chat endpoint without touching its connection?
      instructions:
      - text: Delete channel endpoint {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove the chat endpoint {identifier} permanently.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/channel-endpoints/{identifier}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a channel endpoint
      effect: write
      questions:
      - How do I change where an existing channel endpoint delivers to?
      - Can I edit the endpoint value on a channel endpoint I already created?
      instructions:
      - text: Update channel endpoint {identifier} to point at {endpoint}.
        slots:
          identifier: path.identifier
          endpoint: requestBody.endpoint
      - text: Change the destination of existing endpoint {identifier} to {endpoint}.
        slots:
          identifier: path.identifier
          endpoint: requestBody.endpoint
      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.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/novu-channel-endpoints-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.