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

Trigger, bulk trigger, broadcast, and cancel workflow executions.

Novu Events API is one of 13 APIs that Novu publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.novu.co/v1, https://eu.api.novu.co/v1.

4 operations 4 paths 3 schemas 1 DELETE3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.novu.co/v1
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Novu Events API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Novu secret API key from the Dashboard API Keys page, sent as Authorization: ApiKey .

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 DELETE, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Events 4

Trigger, bulk trigger, broadcast, and cancel workflow executions.

POST
/events/trigger
Trigger event
triggerEvent body → 201401
POST
/events/trigger/bulk
Bulk trigger event
bulkTriggerEvents body → 201401
POST
/events/broadcast
Broadcast event to all
broadcastEvent body → 201401
DELETE
/events/trigger/{transactionId}
Cancel triggered event
cancelTriggeredEvent 1 param → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TriggerEventRequest (5 properties), Error (3 properties), TriggerEventResponse (1 property). Each schema is shown below with its type and property counts.

TriggerEventRequest
object
5 properties 2 required
Error
object
3 properties
TriggerEventResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novu-co-events-api-openapi.yml Raw ↑

Other APIs Novu publishes across the network.

Novu Inbox Realtime API
Novu Environments API
Novu Inbox API
Novu Integrations API
Novu Layouts API
Novu Messages API
Novu Notifications API
Novu Preferences API
Novu Subscribers API
Novu Topics API
Novu Translations API
Novu Workflows API