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

The Contexts API from Novu — 2 operation(s) for contexts.

Novu Contexts 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 Contexts. 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 7 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 7 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 Contexts 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.

Contexts 5
POST
/v2/contexts
Novu Create a Context
ContextsController_createContext body → 201400401403404405409413
GET
/v2/contexts
Novu List All Contexts
ContextsController_listContexts 8 params → 200400401403404405409413
PATCH
/v2/contexts/{type}/{id}
Novu Update a Context
ContextsController_updateContext 2 params body → 200400401403404405409413
GET
/v2/contexts/{type}/{id}
Novu Retrieve a Context
ContextsController_getContext 2 params → 200400401403404405409413
DELETE
/v2/contexts/{type}/{id}
Novu Delete a Context
ContextsController_deleteContext 2 params → 204400401403404405409413

Schemas 7

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

GetContextResponseDto
object
5 properties 5 required
ValidationErrorDto
object
7 properties 4 required
ErrorDto
object
6 properties 3 required
ConstraintValidation
object
2 properties 1 required
CreateContextRequestDto
object
3 properties 2 required
ListContextsResponseDto
object
5 properties 5 required
UpdateContextRequestDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-contexts-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 Domains API
Novu Environment Variables API
Novu Environments API
Novu Events API
Novu Integrations API
Novu Layouts API