aid: novu name: Novu description: >- Novu is the open-source notification infrastructure for developers. A single REST API and workflow engine route a triggered event across in-app inbox, email, SMS, push, chat (Slack / Discord / MS Teams / WhatsApp) and custom channels — with subscriber preferences, topics, digest, snooze, and full workflow orchestration on top. Ships with the embeddable React Inbox component, the Novu Framework for code-first workflow authoring, language SDKs for nine ecosystems, a Postman collection, an MCP server, GitHub Action sync, the Maily block-based email editor, framework starters for Next.js / Remix / Nuxt / SvelteKit, and webhook bridges for Stripe / Clerk / Segment. type: Index deliveryModel: model: unknown license_evidence: repo: novuhq/novu spdx: NOASSERTION stars: 40063 open_source: unknown commercial: true callable_host: true label: Delivery model not determined — needs a product licence on record confidence: low source: - openapi - pricing - repository-unlicensed generated: '2026-09-25' method: derived accessModel: pricing: freemium onboarding: self-serve trial: false try_now: true public: false label: Freemium · Self-serve signup confidence: medium source: - plans - authentication - security generated: '2026-09-03' method: derived image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/novu.png url: https://raw.githubusercontent.com/api-evangelist/novu/refs/heads/main/apis.yml created: '2026-05-23' modified: '2026-10-06' specificationVersion: '0.23' x-docs-platform: mintlify x-docs-platform-confidence: medium x-docs-platform-checked: 2026-10-04 tags: - Notification - Messaging - In-App - Email - SMS - Push - Chat - Workflows - Open Source - Subscribers - Topic - Inbox - Workflow Orchestration - Multi-Channel - Digest - MCP - Framework - React - Real-Time tags_raw: - Notifications - Messaging - In App - Email - SMS - Push - Chat - Workflows - Open Source - Subscribers - Topics - Inbox - Workflow Orchestration - Multi Channel - Digest - MCP - Framework - React - Open-Source - Real-Time apis: - aid: novu:inbox-api name: Novu Inbox / In-App API description: >- Client-side API and React Inbox component for rendering an embedded in-app notification center, marking notifications as read / archived / snoozed, and managing per-user notification preferences directly in the browser. Ships with @novu/react, @novu/react-native, and @novu/js (vanilla) packages, plus pre-built Notion / Linear / Novu themes and full headless API access. humanURL: https://docs.novu.co/platform/inbox/overview baseURL: https://api.novu.co tags: - In-App - Inbox - React - React Native - Client SDK - Headless tags_raw: - In App - Inbox - React - React Native - Client SDK - Headless properties: - type: Documentation url: https://docs.novu.co/platform/inbox/overview - type: AsyncAPI url: asyncapi/novu-asyncapi.yml title: Notification Center WebSocket (Socket.IO) — AsyncAPI 2.6 - type: GettingStarted url: https://docs.novu.co/platform/quickstart/react - type: SDKs url: https://www.npmjs.com/package/@novu/react title: React Inbox SDK - type: SDKs url: https://www.npmjs.com/package/@novu/react-native title: React Native Inbox SDK - type: SDKs url: https://www.npmjs.com/package/@novu/js title: Headless JS Inbox SDK - type: SDKs url: https://www.npmjs.com/package/@novu/nextjs title: Next.js Inbox helpers - type: CodeExamples url: https://github.com/novuhq/inbox-playground title: Inbox Playground - aid: novu:framework name: Novu Framework (Code-First Workflows) description: >- Code-first workflow framework that lets developers define notification workflows in TypeScript / JavaScript using `@novu/framework`, then sync them to Novu Cloud (or a self-hosted instance) via the `npx novu-sync` CLI or the `novuhq/actions-novu-sync` GitHub Action. Supports Express, Next.js, NestJS, Remix, SvelteKit, Nuxt, H3, AWS Lambda, and any node-runtime HTTP handler. The framework owns the workflow source-of-truth — the Dashboard editor stays in sync via a deterministic bridge URL. humanURL: https://docs.novu.co/framework/overview baseURL: https://docs.novu.co/framework tags: - Framework - Code-First - Workflows - TypeScript - Next.js - Express - NestJS - Remix - SvelteKit - Nuxt - AWS Lambda tags_raw: - Framework - Code First - Workflows - TypeScript - Next.js - Express - NestJS - Remix - SvelteKit - Nuxt - AWS Lambda properties: - type: Documentation url: https://docs.novu.co/framework/overview - type: GettingStarted url: https://docs.novu.co/framework/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/framework title: '@novu/framework' - type: CLI url: https://www.npmjs.com/package/novu title: npx novu-sync - type: CodeExamples url: https://github.com/novuhq/novu-framework-nextjs-react-email-example title: Next.js + React Email - type: CodeExamples url: https://github.com/novuhq/novu-framework-remix-example title: Remix - type: CodeExamples url: https://github.com/novuhq/novu-framework-nuxt-example title: Nuxt - type: CodeExamples url: https://github.com/novuhq/novu-framework-nuxt-vue-email-example title: Nuxt + VueEmail - type: CodeExamples url: https://github.com/novuhq/novu-framework-newsletter-app-example title: Newsletter App - aid: novu:mcp-server name: Novu MCP Server description: >- Official Model Context Protocol server exposing the Novu REST API surface as MCP tools so AI agents (Claude Desktop, Cursor, agent frameworks) can trigger workflows, manage subscribers, list workflows, and inspect activity without bespoke wrapping. Distributed as a stdio server runnable via `npx @novu/mcp-server`. humanURL: https://github.com/novuhq/novu-mcp-server baseURL: https://github.com/novuhq/novu-mcp-server tags: - MCP - AI Agents - LLM - Tools - Notification tags_raw: - MCP - AI Agents - LLM - Tools - Notifications properties: - type: Documentation url: https://github.com/novuhq/novu-mcp-server - type: SourceCode url: https://github.com/novuhq/novu-mcp-server - aid: novu:novu-activity-api name: Novu Activity API description: The Activity API from Novu — 1 operation(s) for activity. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Activity properties: - type: OpenAPI url: openapi/novu-activity-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-channel-connections-api name: Novu Channel Connections API description: The Channel Connections API from Novu — 2 operation(s) for channel connections. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Channel Connections properties: - type: OpenAPI url: openapi/novu-channel-connections-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-channel-endpoints-api name: Novu Channel Endpoints API description: The Channel Endpoints API from Novu — 2 operation(s) for channel endpoints. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Channel Endpoints properties: - type: OpenAPI url: openapi/novu-channel-endpoints-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-contexts-api name: Novu Contexts API description: The Contexts API from Novu — 2 operation(s) for contexts. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Context tags_raw: - Contexts properties: - type: OpenAPI url: openapi/novu-contexts-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-domains-api name: Novu Domains API description: Used to manage your inbound email domains. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Domains properties: - type: OpenAPI url: openapi/novu-domains-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-environment-variables-api name: Novu Environment Variables API description: The Environment Variables API from Novu — 3 operation(s) for environment variables. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Environment Variables properties: - type: OpenAPI url: openapi/novu-environment-variables-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-environments-api name: Novu Environments API description: >- Environments allow you to manage different stages of your application development lifecycle. Each environment has its own set of API keys and configurations, enabling you to separate development, staging, and production workflows. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Environment tags_raw: - Environments properties: - type: OpenAPI url: openapi/novu-environments-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-events-api name: Novu Events API description: >- Events represent a change in state of a subscriber. They are used to trigger workflows, and enable you to send notifications to subscribers based on their actions. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Event tags_raw: - Events properties: - type: OpenAPI url: openapi/novu-events-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-integrations-api name: Novu Integrations API description: >- 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. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Integration tags_raw: - Integrations properties: - type: OpenAPI url: openapi/novu-integrations-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-layouts-api name: Novu Layouts API description: Layouts are reusable wrappers for your email notifications. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Layouts properties: - type: OpenAPI url: openapi/novu-layouts-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-messages-api name: Novu Messages API description: >- A message in Novu represents a notification delivered to a recipient on a particular channel. Messages contain information about the request that triggered its delivery, a view of the data sent to the recipient, and a timeline of its lifecycle events. Learn more about messages. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Message tags_raw: - Messages properties: - type: OpenAPI url: openapi/novu-messages-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-notifications-api name: Novu Notifications API description: The Notifications API from Novu — 2 operation(s) for notifications. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Notification tags_raw: - Notifications properties: - type: OpenAPI url: openapi/novu-notifications-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-subscribers-api name: Novu Subscribers API description: >- A subscriber in Novu represents someone who should receive a message. A subscriber's profile information contains important attributes about the subscriber that will be used in messages (name, email). The subscriber object can contain other key-value pairs that can be used to further personalize your messages. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Subscribers properties: - type: OpenAPI url: openapi/novu-subscribers-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-topics-api name: Novu Topics API description: >- Topics are a way to group subscribers together so that they can be notified of events at once. A topic is identified by a custom key. This can be helpful for things like sending out marketing emails or notifying users of new features. Topics can also be used to send notifications to the subscribers who have been grouped together based on their interests, location, activities and much more. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Topic tags_raw: - Topics properties: - type: OpenAPI url: openapi/novu-topics-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-translations-api name: Novu Translations API description: Used to localize your notifications to different languages. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Translation tags_raw: - Translations properties: - type: OpenAPI url: openapi/novu-translations-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-workflows-api name: Novu Workflows API description: >- All notifications are sent via a workflow. Each workflow acts as a container for the logic and blueprint that are associated with a type of notification in your system. humanURL: https://docs.novu.co/api-reference/overview baseURL: https://api.novu.co tags: - Workflows properties: - type: OpenAPI url: openapi/novu-workflows-api-openapi.yml - type: Documentation url: https://docs.novu.co/api-reference/overview - type: APIReference url: https://docs.novu.co/api-reference/overview - type: Swagger url: https://api.novu.co/api - type: Postman url: https://github.com/novuhq/novu-postman - type: Authentication url: https://docs.novu.co/api-reference/overview#authentication - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: GettingStarted url: https://docs.novu.co/platform/quickstart/nextjs - type: SDKs url: https://www.npmjs.com/package/@novu/api - type: SDKs url: https://pypi.org/project/novu-py/ - type: SDKs url: https://github.com/novuhq/novu-go - type: SDKs url: https://github.com/novuhq/php-novu - type: SDKs url: https://github.com/novuhq/novu-csharp - type: SDKs url: https://github.com/novuhq/novu-java - type: SDKs url: https://github.com/novuhq/novu-elixir - type: SDKs url: https://github.com/novuhq/novu-kotlin - type: SDKs url: https://github.com/novuhq/novu-ruby - type: SDKs url: https://github.com/novuhq/novu-rust - type: SDKs url: https://github.com/novuhq/novu-dotnet - type: CodeExamples url: https://github.com/novuhq/examples - type: JSONSchema url: json-schema/novu-trigger-event-request-dto-schema.json - type: JSONSchema url: json-schema/novu-trigger-event-response-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-trigger-event-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-subscriber-request-dto-schema.json - type: JSONSchema url: json-schema/novu-bulk-subscriber-create-dto-schema.json - type: JSONSchema url: json-schema/novu-create-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-environment-request-dto-schema.json - type: JSONSchema url: json-schema/novu-environment-response-dto-schema.json - type: JSONSchema url: json-schema/novu-topic-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-update-integration-request-dto-schema.json - type: JSONSchema url: json-schema/novu-integration-response-dto-schema.json - type: JSONSchema url: json-schema/novu-message-response-dto-schema.json - type: JSONSchema url: json-schema/novu-create-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-update-workflow-dto-schema.json - type: JSONSchema url: json-schema/novu-workflow-response-dto-schema.json - type: JSONSchema url: json-schema/novu-layout-response-dto-schema.json - type: JSONSchema url: json-schema/novu-subscriber-payload-dto-schema.json - type: JSONSchema url: json-schema/novu-error-dto-schema.json - type: JSONStructure url: json-structure/novu-trigger-event-request-dto-structure.json - type: JSONStructure url: json-structure/novu-subscriber-response-dto-structure.json - type: JSONStructure url: json-structure/novu-workflow-response-dto-structure.json - type: JSONStructure url: json-structure/novu-message-response-dto-structure.json - type: JSONStructure url: json-structure/novu-topic-response-dto-structure.json - type: JSONStructure url: json-structure/novu-integration-response-dto-structure.json - type: Examples url: examples/novu-trigger-event-example.json - type: Examples url: examples/novu-trigger-event-bulk-example.json - type: Examples url: examples/novu-broadcast-event-example.json - type: Examples url: examples/novu-create-subscriber-example.json - type: Examples url: examples/novu-bulk-create-subscribers-example.json - type: Examples url: examples/novu-create-topic-example.json - type: Examples url: examples/novu-add-subscribers-to-topic-example.json - type: Examples url: examples/novu-create-environment-example.json - type: Examples url: examples/novu-create-integration-example.json - type: Examples url: examples/novu-workflow-response-example.json - type: Examples url: examples/novu-list-messages-example.json - type: Examples url: examples/novu-error-response-example.json - aid: novu:novu-webhooks-api name: Novu Webhooks API description: The Webhooks API from Novu — 0 operation(s) for webhooks. humanURL: https://docs.novu.co/platform/inbox/overview baseURL: https://api.novu.co tags: - Webhook tags_raw: - Webhooks properties: - type: OpenAPI url: openapi/novu-webhooks-api-openapi.yml common: - type: CapabilityMap url: capabilities/novu-capability-edges.yml name: Novu Business Capability Map - url: https://www.novu.co/blog/ type: Blog - url: https://www.novu.co/blog/rss.xml type: BlogRSS - type: IssueTracker url: https://github.com/novuhq/novu-mcp-server/issues - type: AgenticAccess url: agentic-access/novu-agentic-access.yml - type: DomainSecurity url: security/novu-domain-security.yml - type: Authentication url: authentication/novu-authentication.yml - type: PostmanWorkspace url: https://www.postman.com/kinlaneapi/novu/overview - type: Arazzo url: arazzo/novu-bulk-onboard-and-broadcast-workflow.yml name: Novu Bulk Onboard Subscribers and Broadcast an Announcement - type: Arazzo url: arazzo/novu-create-workflow-and-trigger-workflow.yml name: Novu Create a Workflow and Trigger It - type: Arazzo url: arazzo/novu-offboard-subscriber-workflow.yml name: Novu Offboard a Subscriber - type: Arazzo url: arazzo/novu-onboard-subscriber-and-notify-workflow.yml name: Novu Onboard a Subscriber and Send Their First Notification - type: Arazzo url: arazzo/novu-provision-integration-and-set-primary-workflow.yml name: Novu Provision a Delivery Integration and Make It Primary - type: Arazzo url: arazzo/novu-set-preferences-then-notify-workflow.yml name: Novu Set Subscriber Preferences Then Notify - type: Arazzo url: arazzo/novu-subscribe-existing-to-topic-workflow.yml name: Novu Subscribe an Existing Subscriber to a Topic - type: Arazzo url: arazzo/novu-subscriber-inbox-triage-workflow.yml name: Novu Subscriber Inbox Triage - type: Arazzo url: arazzo/novu-topic-broadcast-campaign-workflow.yml name: Novu Topic Broadcast Campaign - type: Arazzo url: arazzo/novu-trigger-and-verify-delivery-workflow.yml name: Novu Trigger a Notification and Verify Delivery - type: Arazzo url: arazzo/novu-trigger-then-cancel-workflow.yml name: Novu Trigger a Deferred Notification and Cancel It - type: Arazzo url: arazzo/novu-unsubscribe-from-topic-workflow.yml name: Novu Unsubscribe Subscribers From a Topic - type: Website url: https://novu.co - type: Portal url: https://docs.novu.co - type: Documentation url: https://docs.novu.co - type: Signup url: https://web.novu.co/auth/signup - type: Login url: https://web.novu.co - type: Pricing url: https://novu.co/pricing - type: Plans url: plans/novu-plans-pricing.yml - type: FinOps url: finops/novu-finops.yml - type: RateLimits url: rate-limits/novu-rate-limits.yml - type: Blog url: https://novu.co/blog - type: GitHub url: https://github.com/novuhq - type: GitHubOrganization url: https://github.com/novuhq - type: GitHubRepository url: https://github.com/novuhq/novu title: novuhq/novu (main monorepo, 39k+ stars) - type: SourceCode url: https://github.com/novuhq/novu - type: License url: https://github.com/novuhq/novu/blob/next/LICENSE title: MIT License - type: SDKs url: https://docs.novu.co/sdks/introduction - type: CLI url: https://docs.novu.co/community/run-in-local-machine title: Novu CLI - type: Framework url: https://docs.novu.co/framework/overview title: Novu Framework - type: Inbox url: https://docs.novu.co/platform/inbox/overview title: Novu Inbox - type: Integrations url: https://docs.novu.co/platform/integrations - type: ChangeLog url: https://novu.co/changelog - type: ReleaseNotes url: https://github.com/novuhq/novu/releases - type: StatusPage url: https://status.novu.co - type: TermsOfService url: https://novu.co/terms - type: PrivacyPolicy url: https://novu.co/privacy - type: Community url: https://discord.gg/novu title: Novu Discord - type: StackOverflow url: https://stackoverflow.com/questions/tagged/novu - type: YouTube url: https://www.youtube.com/@novuhq - type: LlmsText url: https://docs.novu.co/llms.txt - type: SpectralRules url: rules/novu-spectral-rules.yml - type: Vocabulary url: vocabulary/novu-vocabulary.yml - type: JSONLD url: json-ld/novu-context.jsonld - type: Tools url: https://github.com/novuhq/novu-mcp-server title: Novu MCP Server - type: Tools url: https://github.com/novuhq/maily.to title: Maily — block-based email editor (used by Novu Cloud) - type: Tools url: https://github.com/novuhq/actions-novu-sync title: actions-novu-sync — GitHub Action to sync workflows to Novu Cloud - type: Tools url: https://github.com/novuhq/stripe-to-novu-webhooks title: Stripe → Novu webhook bridge - type: Tools url: https://github.com/novuhq/clerk-to-novu-webhooks title: Clerk → Novu webhook bridge - type: Tools url: https://github.com/novuhq/segment-to-novu-webhooks title: Segment → Novu webhook bridge - type: Tools url: https://github.com/novuhq/community-k8s title: Community Kubernetes manifests for self-hosting - type: Tutorials url: https://github.com/novuhq/inbox-playground title: Inbox Playground - type: Tutorials url: https://github.com/novuhq/examples title: Novu Examples - type: Tutorials url: https://github.com/novuhq/awesome-novu title: Awesome Novu - type: Tutorials url: https://docs.novu.co/guides - type: Skills url: https://github.com/novuhq/skills title: Novu Skill Set for AI Agents - data: - name: Multi-channel Workflow Orchestration description: >- Author a single workflow tree that fans out across in-app, email, SMS, push, and chat with branching, delay, and digest steps. - name: Embedded React Inbox description: >- Drop-in React (and React Native) component with per-user preferences, read / archive / snooze, themes (Novu / Notion / Linear), and full headless API access. - name: Subscriber Identity description: First-class Subscribers resource with credentials per channel, locale, timezone, preferences, and bulk import. - name: Topics for Fan-out description: Named broadcast groups subscribed by users for one-call fan-out to thousands of subscribers. - name: Digest Engine description: Aggregate high-frequency triggers into a single delivery using configurable digest windows and back-off keys. - name: Code-First Framework description: Define workflows in TypeScript using @novu/framework and sync to Novu Cloud via novu-sync or a GitHub Action. - name: Block-Based Email Editor description: WYSIWYG block-based editor (open-sourced as Maily.to) powered by React Email under the hood. - name: Tenant / Context Objects description: Reusable tenant and organization context objects referenced by trigger payloads for multi-tenant routing. - name: Idempotency + RateLimit Headers description: IETF-style RateLimit-* headers on every response, Idempotency-Key on every mutating request. - name: MCP Server description: Official Model Context Protocol server exposing the Novu REST API to AI agents. - name: Self-Hosting description: >- Apache-/MIT-licensed monorepo with Docker Compose and community Kubernetes manifests for fully self-hosted deployments. - name: 9 Language SDKs description: TypeScript, Python, Go, PHP, C#, Java, Elixir, Kotlin, Ruby, Rust, .NET clients. type: Features - data: - name: Product Onboarding description: Welcome sequences combining transactional email, in-app inbox messages, and reminders. - name: Transactional Notifications description: Order confirmations, password resets, magic links, payment receipts, and shipping updates. - name: Real-Time Collaboration Alerts description: Comment mentions, document shares, and review requests delivered to the in-app inbox and email. - name: Subscription Lifecycle description: Trial reminders, renewal warnings, dunning, and cancellation flows driven by billing events. - name: Authentication Events description: Sign-up confirmations, MFA prompts, suspicious-login alerts, and OTP codes. - name: Marketing Broadcasts description: Product announcements and weekly digests fanned out via topics. - name: Operational Alerts description: On-call paging, deploy notifications, and incident updates routed through Slack / MS Teams. - name: Multi-Tenant SaaS description: Per-customer routing using tenant context and subscriber data inheritance. - name: AI Agent Notifications description: Agent workflows triggering Novu via the MCP server to keep humans in the loop. type: UseCases - data: - name: SendGrid description: Outbound email integration via SendGrid credentials. - name: Mailgun description: Outbound email integration via Mailgun. - name: Resend description: Outbound email integration via Resend. - name: Postmark description: Outbound transactional email via Postmark. - name: AWS SES description: Outbound email via Amazon Simple Email Service. - name: Twilio description: SMS delivery via Twilio. - name: MessageBird description: SMS delivery via MessageBird. - name: Plivo description: SMS delivery via Plivo. - name: Firebase Cloud Messaging description: Mobile push delivery via FCM. - name: Apple Push Notification Service description: iOS push delivery via APNs. - name: OneSignal description: Push delivery via OneSignal. - name: Slack description: Chat notifications to Slack channels and users. - name: Microsoft Teams description: Chat notifications to MS Teams channels. - name: Discord description: Chat notifications to Discord channels. - name: WhatsApp description: Conversational notifications via WhatsApp. - name: Stripe description: Billing-event-to-notification bridge via stripe-to-novu-webhooks. - name: Clerk description: Authentication-event-to-notification bridge via clerk-to-novu-webhooks. - name: Segment description: CDP-event-to-notification bridge via segment-to-novu-webhooks. - name: React description: First-class React Inbox component and Next.js helpers. - name: GitHub Actions description: actions-novu-sync syncs framework workflows to Novu Cloud on every push. type: Integrations - data: - name: Novu Cloud description: Managed Novu hosted by the Novu team. Free / Pro / Team / Enterprise plans. - name: Self-Hosted Open Source description: >- Run the full Novu monorepo on your own infrastructure under MIT license. Docker Compose for development, community Kubernetes manifests for production. - name: Novu EU Cloud description: EU-resident Novu Cloud deployment at eu.api.novu.co. - name: Enterprise (HIPAA, SSO, SCIM) description: >- HIPAA BAA, custom SSO, SCIM directory sync, and custom data-residency regions (US, EU, UK, Singapore, Australia, Japan, South Korea). type: Solutions maintainers: - FN: Kin Lane email: kinlane@gmail.com