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 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 Integrations. 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.1.0, at version 3.15.0.
Requests are made against 2 base URLs: https://api.novu.co, https://eu.api.novu.co.
Metadata
The identity and technical contract details declared by the specification.
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.
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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Novu 12
Other APIs Novu publishes across the network.