# Novu Documentation > Notification infrastructure for developers. ## API Reference - [Novu API Reference Overview](/api-reference.md): Complete Novu API reference covering authentication, endpoints, rate limits, and server-side integration for notifications. - [Track provider activity and engagement events](/api-reference/activity/track-provider-activity-and-engagement-events.md): Track activity and engagement events for a specific delivery provider - [Create a channel connection](/api-reference/channel-connections/create-a-channel-connection.md): Create a new channel connection for a resource for given integration. Only one channel connection is allowed per resource and integration. - [Delete a channel connection](/api-reference/channel-connections/delete-a-channel-connection.md): Delete a specific channel connection by its unique identifier. - [List all channel connections](/api-reference/channel-connections/list-all-channel-connections.md): List all channel connections for a resource. - [Retrieve a channel connection](/api-reference/channel-connections/retrieve-a-channel-connection.md): Retrieve a specific channel connection by its unique identifier. - [Update a channel connection](/api-reference/channel-connections/update-a-channel-connection.md): Update an existing channel connection by its unique identifier. - [Create a channel endpoint](/api-reference/channel-endpoints/create-a-channel-endpoint.md): Create a new channel endpoint for a resource. - [Delete a channel endpoint](/api-reference/channel-endpoints/delete-a-channel-endpoint.md): Delete a specific channel endpoint by its unique identifier. - [List all channel endpoints](/api-reference/channel-endpoints/list-all-channel-endpoints.md): List all channel endpoints for a resource based on query filters. - [Retrieve a channel endpoint](/api-reference/channel-endpoints/retrieve-a-channel-endpoint.md): Retrieve a specific channel endpoint by its unique identifier. - [Update a channel endpoint](/api-reference/channel-endpoints/update-a-channel-endpoint.md): Update an existing channel endpoint by its unique identifier. - [Context schema Model API Reference (Contexts)](/api-reference/contexts/context-schema.md): Reference the Novu context schema used in API requests and responses. Review fields, data types, and object structure for this resource. - [Create a context](/api-reference/contexts/create-a-context.md): Create a new context with the specified type, id, and data. Returns 409 if context already exists. type and id are required fields, data is optional, if the context already exists, it returns the 409 response - [Delete a context](/api-reference/contexts/delete-a-context.md): Delete a context by its type and id. type and id are required fields, if the context does not exist, it returns the 404 response - [List all contexts](/api-reference/contexts/list-all-contexts.md): Retrieve a paginated list of all contexts, optionally filtered by type and key pattern. type and id are optional fields, if provided, only contexts with the matching type and id will be returned. search is an optional field, if provided, only contexts with the matching key pattern will be returned. Checkout all possible parameters in the query section below for more details - [Retrieve a context](/api-reference/contexts/retrieve-a-context.md): Retrieve a specific context by its type and id. type and id are required fields, if the context does not exist, it returns the 404 response - [Update a context](/api-reference/contexts/update-a-context.md): Update the data of an existing context. type and id are required fields, data is required. Only the data field is updated, the rest of the context is not affected. If the context does not exist, it returns the 404 response - [Create a domain](/api-reference/domains/create-a-domain.md): Registers a new inbound-email domain. The response includes the DNS records customers must add at their DNS provider before the domain can receive mail. - [Create a route](/api-reference/domains/create-a-route.md): Creates a route on the domain that forwards inbound mail addressed to
@ to either a webhook or an agent. Each address on a domain may only have a single route. - [Delete a domain](/api-reference/domains/delete-a-domain.md): Removes the domain and cascades the deletion to all of its routes. Inbound mail for that domain stops being processed immediately. - [Delete a route](/api-reference/domains/delete-a-route.md): Removes the route bound to
@. Inbound mail for that address will no longer be processed. - [Diagnose inbound DNS for a domain](/api-reference/domains/diagnose-inbound-dns-for-a-domain.md): Runs live DNS checks for inbound email readiness (MX correctness, apex CNAME collision, and common DNS blocklists for the Novu mail host). Returns structured issues with plain-language fixes. - [List domains for an environment](/api-reference/domains/list-domains-for-an-environment.md): Returns a paginated list of inbound-email domains in the current environment. Supports cursor pagination and a name contains filter. - [List routes for a domain](/api-reference/domains/list-routes-for-a-domain.md): Returns a paginated list of routes attached to the domain. Optionally filter by an agent identifier to find routes pointing to a specific agent. - [Retrieve a domain by name](/api-reference/domains/retrieve-a-domain-by-name.md): Returns the domain configuration and the DNS records that must be in place. This is a pure read; call domains.verify to refresh verification status from DNS. - [Retrieve a route by address](/api-reference/domains/retrieve-a-route-by-address.md): Returns the route bound to
@. Use * as the address to retrieve the wildcard route for the domain. - [Retrieve auto-configuration availability](/api-reference/domains/retrieve-auto-configuration-availability.md): Returns whether DNS auto-configuration (Domain Connect) is available for this domain. When available is false, manualRecords lists the DNS records the customer must add manually. - [Start DNS auto-configuration](/api-reference/domains/start-dns-auto-configuration.md): Generates a signed redirect URL the customer can follow to apply Novu DNS records at their DNS provider. After the provider completes the flow, it redirects back to redirectUri. - [Test an inbound route](/api-reference/domains/test-an-inbound-route.md): Sends a synthetic inbound email through the same delivery path as production (outbound webhooks for webhook routes, signed HTTP to the agent for agent routes). Use dryRun: true to preview the payload without delivering. - [Update a domain](/api-reference/domains/update-a-domain.md): Updates optional domain fields. When data is provided, it replaces the entire metadata object; omit data to leave it unchanged. - [Update a route](/api-reference/domains/update-a-route.md): Updates the destination of the route bound to
@. The address itself is the resource identity and cannot be changed; delete and recreate the route to rename it. - [Verify a domain](/api-reference/domains/verify-a-domain.md): Performs a live DNS lookup to refresh the MX record status of the domain and updates the verification status accordingly. Returns the latest domain configuration. - [Create a variable](/api-reference/environment-variables/create-a-variable.md): Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses. - [Delete environment variable](/api-reference/environment-variables/delete-environment-variable.md): Deletes an environment variable by key. - [Environment variable schema Model API Reference (Environment Variables)](/api-reference/environment-variables/environment-variable-schema.md): Reference the Novu environment variable schema used in API requests and responses. Review fields, data types, and object structure for this resource. - [Get environment variable](/api-reference/environment-variables/get-environment-variable.md): Returns a single environment variable by key. Secret values are masked. - [List all variables](/api-reference/environment-variables/list-all-variables.md): Returns all environment variables for the current organization. Secret values are masked. - [Retrieve a variable usage](/api-reference/environment-variables/retrieve-a-variable-usage.md): Returns the workflows that reference this environment variable via {{env.KEY}} in their step controls. variableId is required. - [Update a variable](/api-reference/environment-variables/update-a-variable.md): Updates an existing environment variable. Providing values merges them into the existing per-environment values by _environmentId; envs not present in the request keep their stored value. Submitting the masked secret placeholder (the value returned by read endpoints for secret variables) as a real value is rejected. - [Compare resources between environments](/api-reference/environments/compare-resources-between-environments.md): Compares workflows and other resources between the source and target environments, returning detailed diff information including additions, modifications, and deletions. - [Create an environment](/api-reference/environments/create-an-environment.md): Creates a new environment within the current organization. Environments allow you to manage different stages of your application development lifecycle. Each environment has its own set of API keys and configurations. - [Delete an environment](/api-reference/environments/delete-an-environment.md): Delete an environment by its unique identifier environmentId. This action is irreversible and will remove the environment and all its associated data. - [Environment schema Model API Reference (Environments)](/api-reference/environments/environment-schema.md): Reference the Novu environment schema used in API requests and responses. Review fields, data types, and object structure for this resource. - [List all environments](/api-reference/environments/list-all-environments.md): This API returns a list of environments for the current organization. Each environment contains its configuration, API keys (if user has access), and metadata. - [List environment tags](/api-reference/environments/list-environment-tags.md): Retrieve all unique tags used in workflows within the specified environment. These tags can be used for filtering workflows. - [Publish resources to target environment](/api-reference/environments/publish-resources-to-target-environment.md): Publishes all workflows and resources from the source environment to the target environment. Optionally specify specific resources to publish or use dryRun mode to preview changes. - [Update an environment](/api-reference/environments/update-an-environment.md): Update an environment by its unique identifier environmentId. You can modify the environment name, identifier, color, and other configuration settings. - [Broadcast event to all](/api-reference/events/broadcast-event-to-all.md): Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc. In the future could be used to trigger events to a subset of subscribers based on defined filters. - [Bulk trigger event](/api-reference/events/bulk-trigger-event.md): Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request. - [Cancel triggered event](/api-reference/events/cancel-triggered-event.md): Using a previously generated transactionId during the event trigger, will cancel any active or pending workflows. This is useful to cancel active digests, delays etc... - [Trigger event](/api-reference/events/trigger-event.md): Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below. To prevent duplicate triggers, you can optionally pass a transactionId in the request body. If the same transactionId is used again, the trigger will be ignored. The retention period depends on your billing tier. - [API Idempotency](/api-reference/idempotency.md): Learn how to use idempotency keys to safely retry API requests without causing duplicate operations - [Auto-configure an integration for inbound webhooks](/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks.md): Auto-configure an integration by its unique key identifier integrationId for inbound webhook support. This will automatically generate required webhook signing keys and configure webhook endpoints. - [Create an integration](/api-reference/integrations/create-an-integration.md): Create an integration for the current environment the user is based on the API key provided. Each provider supports different credentials, check the provider documentation for more details. - [Delete an integration](/api-reference/integrations/delete-an-integration.md): Delete an integration by its unique key identifier integrationId. This action is irreversible. - [Generate chat OAuth URL](/api-reference/integrations/generate-chat-oauth-url.md): Deprecated — use POST /integrations/channel-connections/oauth (connect) or POST /integrations/channel-endpoints/oauth (link_user) instead. Generate an OAuth URL for chat integrations like Slack and MS Teams. This URL allows subscribers to authorize the integration, enabling the system to send messages through their chat workspace. The generated URL expires after 5 minutes. - [Generate OAuth URL for a workspace/tenant connection](/api-reference/integrations/generate-oauth-url-for-a-workspacetenant-connection.md): Generate an OAuth URL that creates a workspace or tenant-level channel connection (Slack workspace install or MS Teams admin consent). The generated URL expires after 5 minutes. - [Generate OAuth URL to link a subscriber user identity](/api-reference/integrations/generate-oauth-url-to-link-a-subscriber-user-identity.md): Generate an OAuth URL that links a specific subscriber to their chat identity (Slack user ID or MS Teams user OID). The generated URL expires after 5 minutes. - [Integration schema Model API Reference (Integrations)](/api-reference/integrations/integration-schema.md): Reference the Novu integration schema used in API requests and responses. Review fields, data types, and object structure for this resource. - [List active integrations](/api-reference/integrations/list-active-integrations.md): List all the active integrations created in the organization - [List all integrations](/api-reference/integrations/list-all-integrations.md): List all the channels integrations created in the organization - [Update an integration](/api-reference/integrations/update-an-integration.md): Update an integration by its unique key identifier integrationId. Each provider supports different credentials, check the provider documentation for more details. - [Update integration as primary](/api-reference/integrations/update-integration-as-primary.md): Update an integration as primary by its unique key identifier integrationId. This API will set the integration as primary for that channel in the current environment. Primary integration is used to deliver notification for sms and email channels in the workflow. - [Create a layout](/api-reference/layouts/create-a-layout.md): Creates a new layout in the Novu Cloud environment - [Delete a layout](/api-reference/layouts/delete-a-layout.md): Removes a specific layout by its unique identifier layoutId - [Duplicate a layout](/api-reference/layouts/duplicate-a-layout.md): Duplicates a layout by its unique identifier layoutId. This will create a new layout with the content of the original layout. - [Generate layout preview](/api-reference/layouts/generate-layout-preview.md): Generates a preview for a layout by its unique identifier layoutId - [Get layout usage](/api-reference/layouts/get-layout-usage.md): Retrieves information about workflows that use the specified layout by its unique identifier layoutId - [List all layouts](/api-reference/layouts/list-all-layouts.md): Retrieves a list of layouts with optional filtering and pagination - [Retrieve a layout](/api-reference/layouts/retrieve-a-layout.md): Fetches details of a specific layout by its unique identifier layoutId - [Update a layout](/api-reference/layouts/update-a-layout.md): Updates the details of an existing layout, here layoutId is the identifier of the layout - [Delete a message](/api-reference/messages/delete-a-message.md): Delete a message entity from the Novu platform by messageId. This action is irreversible. messageId is required and of mongodbId type. - [Delete messages by transactionId](/api-reference/messages/delete-messages-by-transactionid.md): Delete multiple messages from the Novu platform using transactionId of triggered event. This API supports filtering by channel and delete all messages associated with the transactionId. - [List all messages](/api-reference/messages/list-all-messages.md): List all messages for the current environment. This API supports filtering by channel, subscriberId, and transactionId. This API returns a paginated list of messages. - [Message schema Model API Reference (Messages)](/api-reference/messages/message-schema.md): Reference the Novu message schema used in API requests and responses. Review fields, data types, and object structure for this resource. - [List all events](/api-reference/notifications/list-all-events.md): List all notification events (triggered events) for the current environment. This API supports filtering by channels, templates, emails, subscriberIds, transactionId, topicKey, severity, contextKeys. Checkout all available filters in the query section. This API returns event triggers, to list each channel notifications, check messages APIs. - [Notification event schema Model API Reference (Notifications)](/api-reference/notifications/notification-event-schema.md): Reference the Novu notification event schema used in API requests and responses. Review fields, data types, and object structure for this resource. - [Retrieve an event](/api-reference/notifications/retrieve-an-event.md): Retrieve an event by its unique key identifier notificationId. Here notificationId is of mongodbId type. This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step. - [API Payload Limits](/api-reference/payload-limits.md): Understand payload size limits for Novu API requests and workflow triggers. Structure event payloads to avoid validation failures and rejected requests. - [API Rate Limiting](/api-reference/rate-limiting.md): In this page you can learn about how rate limiting works with Novu's API - [Archive a notification](/api-reference/subscribers/archive-a-notification.md): Archive a specific in-app (inbox) notification by its unique identifier notificationId. - [Archive all notifications](/api-reference/subscribers/archive-all-notifications.md): Archive all in-app (inbox) notifications matching the specified filters. Supports context-based filtering. - [Archive all read notifications](/api-reference/subscribers/archive-all-read-notifications.md): Archive all read in-app (inbox) notifications matching the specified filters. Supports context-based filtering. - [Bulk create subscribers](/api-reference/subscribers/bulk-create-subscribers.md): Using this endpoint multiple subscribers can be created at once. The bulk API is limited to 500 subscribers per request. - [Bulk update subscriber preferences](/api-reference/subscribers/bulk-update-subscriber-preferences.md): Bulk update subscriber preferences by its unique key identifier subscriberId. This API allows updating multiple workflow preferences in a single request. - [Complete a notification action](/api-reference/subscribers/complete-a-notification-action.md): Mark a single in-app (inbox) notification's action (primary or secondary) as completed by its unique identifier notificationId and action type actionType. - [Create a subscriber](/api-reference/subscribers/create-a-subscriber.md): Create a subscriber with the subscriber attributes. subscriberId is a required field, rest other fields are optional, if the subscriber already exists, it will be updated - [Delete a notification](/api-reference/subscribers/delete-a-notification.md): Delete a specific in-app (inbox) notification permanently by its unique identifier notificationId. - [Delete a subscriber](/api-reference/subscribers/delete-a-subscriber.md): Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions. subscriberId is a required field. - [Delete all notifications](/api-reference/subscribers/delete-all-notifications.md): Permanently delete all in-app (inbox) notifications matching the specified filters. Supports context-based filtering. - [Delete provider credentials](/api-reference/subscribers/delete-provider-credentials.md): Delete subscriber credentials for a provider such as slack and FCM by providerId. This action is irreversible and will remove the credentials for the provider for particular subscriberId. - [Mark a notification as read](/api-reference/subscribers/mark-a-notification-as-read.md): Mark a specific in-app (inbox) notification as read by its unique identifier notificationId. - [Mark a notification as unread](/api-reference/subscribers/mark-a-notification-as-unread.md): Mark a specific in-app (inbox) notification as unread by its unique identifier notificationId. - [Mark all notifications as read](/api-reference/subscribers/mark-all-notifications-as-read.md): Mark all in-app (inbox) notifications matching the specified filters as read. Supports context-based filtering. - [Mark notifications as seen](/api-reference/subscribers/mark-notifications-as-seen.md): Mark specific and multiple in-app (inbox) notifications as seen. Supports context-based filtering. - [Retrieve a subscriber](/api-reference/subscribers/retrieve-a-subscriber.md): Retrieve a subscriber by its unique key identifier subscriberId. subscriberId field is required. - [Retrieve subscriber notifications](/api-reference/subscribers/retrieve-subscriber-notifications.md): Retrieve subscriber in-app (inbox) notifications by its unique key identifier subscriberId. - [Retrieve subscriber notifications count](/api-reference/subscribers/retrieve-subscriber-notifications-count.md): Retrieve count of in-app (inbox) notifications for a subscriber by its unique key identifier subscriberId. Supports multiple filters to count in-app (inbox) notifications by different criteria, including context keys. - [Retrieve subscriber preferences](/api-reference/subscribers/retrieve-subscriber-preferences.md): Retrieve subscriber channel preferences by its unique key identifier subscriberId. This API returns all five channels preferences for all workflows and global preferences. - [Retrieve subscriber subscriptions](/api-reference/subscribers/retrieve-subscriber-subscriptions.md): Retrieve subscriber's topic subscriptions by its unique key identifier subscriberId. Checkout all available filters in the query section. - [Retrieve unseen notifications count](/api-reference/subscribers/retrieve-unseen-notifications-count.md): Retrieve unseen in-app (inbox) notifications count for a subscriber by its unique key identifier subscriberId. - [Revert a notification action](/api-reference/subscribers/revert-a-notification-action.md): Revert a single in-app (inbox) notification's action (primary or secondary) to pending state by its unique identifier notificationId and action type actionType. - [Search subscribers](/api-reference/subscribers/search-subscribers.md): Search subscribers by their email, phone, subscriberId and name. The search is case sensitive and supports pagination.Checkout all available filters in the query section. - [Snooze a notification](/api-reference/subscribers/snooze-a-notification.md): Snooze a specific in-app (inbox) notification by its unique identifier notificationId until a specified time. - [Subscriber schema Model API Reference (Subscribers)](/api-reference/subscribers/subscriber-schema.md): Reference the Novu subscriber schema used in API requests and responses. Review fields, data types, and object structure for this resource. - [Unarchive a notification](/api-reference/subscribers/unarchive-a-notification.md): Unarchive a specific in-app (inbox) notification by its unique identifier notificationId. - [Unsnooze a notification](/api-reference/subscribers/unsnooze-a-notification.md): Unsnooze a specific in-app (inbox) notification by its unique identifier notificationId. - [Update a subscriber](/api-reference/subscribers/update-a-subscriber.md): Update a subscriber by its unique key identifier subscriberId. subscriberId is a required field, rest other fields are optional - [Update all notifications state](/api-reference/subscribers/update-all-notifications-state.md): Update all subscriber in-app (inbox) notifications state such as read, unread, seen or unseen by subscriberId. - [Update notification action status](/api-reference/subscribers/update-notification-action-status.md): Update in-app (inbox) notification's action status by its unique key identifier messageId and type field type. type field can be primary or secondary - [Update notifications state](/api-reference/subscribers/update-notifications-state.md): Update subscriber's multiple in-app (inbox) notifications state such as seen, read, unseen or unread by subscriberId. messageId is of type mongodbId of notifications - [Update provider credentials](/api-reference/subscribers/update-provider-credentials.md): Update credentials for a provider such as slack and FCM. providerId is required field. This API creates the deviceTokens or replaces the existing ones. - [Update subscriber online status](/api-reference/subscribers/update-subscriber-online-status.md): Update the subscriber online status by its unique key identifier subscriberId - [Update subscriber preferences](/api-reference/subscribers/update-subscriber-preferences.md): Update subscriber preferences by its unique key identifier subscriberId. workflowId is optional field, if provided, this API will update that workflow preference, otherwise it will update global preferences - [Upsert provider credentials](/api-reference/subscribers/upsert-provider-credentials.md): Upsert credentials for a provider such as slack and FCM. providerId is required field. This API creates deviceTokens or appends to the existing ones. - [Check topic subscriber](/api-reference/topics/check-topic-subscriber.md): Check if a subscriber belongs to a certain topic - [Create a topic](/api-reference/topics/create-a-topic.md): Creates a new topic if it does not exist, or updates an existing topic if it already exists. Use ?failIfExists=true to prevent updates. - [Create topic subscriptions](/api-reference/topics/create-topic-subscriptions.md): This api will create subscription for subscriberIds for a topic. Its like subscribing to a common interest group. if topic does not exist, it will be created. - [Delete a topic](/api-reference/topics/delete-a-topic.md): Delete a topic by its unique key identifier topicKey. This action is irreversible and will remove all subscriptions to the topic. - [Delete topic subscriptions](/api-reference/topics/delete-topic-subscriptions.md): Delete subscriptions for subscriberIds for a topic. - [List all topics](/api-reference/topics/list-all-topics.md): This api returns a paginated list of topics. Topics can be filtered by key, name, or includeCursor to paginate through the list. Checkout all available filters in the query section. - [List topic subscriptions](/api-reference/topics/list-topic-subscriptions.md): List all subscriptions of subscribers for a topic. Checkout all available filters in the query section. - [Retrieve a topic](/api-reference/topics/retrieve-a-topic.md): Retrieve a topic by its unique key identifier topicKey - [Retrieve a topic subscription](/api-reference/topics/retrieve-a-topic-subscription.md): Retrieve a subscription by its unique identifier for a topic. - [Topic schema Model API Reference (Topics)](/api-reference/topics/topic-schema.md): Reference the Novu topic schema used in API requests and responses. Review fields, data types, and object structure for this resource. - [Update a topic](/api-reference/topics/update-a-topic.md): Update a topic name by its unique key identifier topicKey - [Update a topic subscription](/api-reference/topics/update-a-topic-subscription.md): Update a subscription by its unique identifier for a topic. You can update the preferences and name associated with the subscription. - [Create a translation](/api-reference/translations/create-a-translation.md): Create a translation for a specific workflow and locale, if the translation already exists, it will be updated - [Delete a translation](/api-reference/translations/delete-a-translation.md): Delete a specific translation by resource type, resource ID and locale - [Delete a translation group](/api-reference/translations/delete-a-translation-group.md): Delete an entire translation group and all its translations - [Import master translations JSON](/api-reference/translations/import-master-translations-json.md): Import translations for multiple workflows from master JSON format for a specific locale - [Retrieve a translation](/api-reference/translations/retrieve-a-translation.md): Retrieve a specific translation by resource type, resource ID and locale - [Retrieve a translation group](/api-reference/translations/retrieve-a-translation-group.md): Retrieves a single translation group by resource type (workflow, layout) and resource ID (workflowId, layoutId) - [Retrieve master translations JSON](/api-reference/translations/retrieve-master-translations-json.md): Retrieve all translations for a locale in master JSON format organized by resourceId (workflowId) - [Upload master translations JSON file](/api-reference/translations/upload-master-translations-json-file.md): Upload a master JSON file containing translations for multiple workflows. Locale is automatically detected from filename (e.g., en_US.json) - [Upload translation files](/api-reference/translations/upload-translation-files.md): Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json. Supports both "files" and "files[]" field names for backwards compatibility. - [Create a workflow](/api-reference/workflows/create-a-workflow.md): Creates a new workflow in the Novu Cloud environment - [Delete a workflow](/api-reference/workflows/delete-a-workflow.md): Removes a specific workflow by its unique identifier workflowId - [Generate a step preview](/api-reference/workflows/generate-a-step-preview.md): Generates a preview for a specific workflow step by its unique identifier stepId - [List all workflows](/api-reference/workflows/list-all-workflows.md): Retrieves a list of workflows with optional filtering and pagination - [Retrieve a workflow](/api-reference/workflows/retrieve-a-workflow.md): Fetches details of a specific workflow by its unique identifier workflowId - [Retrieve workflow step](/api-reference/workflows/retrieve-workflow-step.md): Retrieves data for a specific step in a workflow - [Sync a workflow](/api-reference/workflows/sync-a-workflow.md): Synchronizes a workflow to the target environment - [Update a workflow](/api-reference/workflows/update-a-workflow.md): Updates the details of an existing workflow, here workflowId is the identifier of the workflow - [Workflow schema Model API Reference (Workflows)](/api-reference/workflows/workflow-schema.md): Reference the Novu workflow schema used in API requests and responses. Review fields, data types, and object structure for this resource. ## Agents - [Manage agent conversations](/agents/conversations.md): View agent conversations, their history, lifecycle, and observability in the Novu dashboard. - [Tutorial: Build your first Agent](/agents/custom-code-agent/build-your-first-agent.md): Build a Pipelinr support agent with handlers, cards, metadata, an LLM, and conversation resolution. - [Core concepts](/agents/custom-code-agent/concepts.md): Entities, lifecycle, and handler building blocks for a custom code agent with Novu. - [Going to Production](/agents/custom-code-agent/going-to-production.md): Learn how to run a conversational agent on your local machine, test it in a development environment, and deploy it to production. - [Get started with Novu for Agents](/agents/custom-code-agent/quickstart.md): Create your first agent and connect it to Slack in under 10 minutes. - [Connect Components](/agents/custom-code-agent/setup-your-agent/connect-components.md): Use prebuilt React components so your users can install and connect Slack, Microsoft Teams, Telegram and other communication platforms to your agent. - [Create an agent](/agents/custom-code-agent/setup-your-agent/create-an-agent.md): Create a new agent in the Novu dashboard and connect your first provider. - [Edit sent messages](/agents/custom-code-agent/setup-your-agent/edit-sent-messages.md): Update a message in place after sending it with ctx.reply() and ReplyHandle. - [Handlers and context](/agents/custom-code-agent/setup-your-agent/handle-events.md): Event handlers and the context object your agent code receives on every turn. - [Set up your agent: overview](/agents/custom-code-agent/setup-your-agent/overview.md): What you configure when setting up a Novu agent: dashboard settings, bridge, providers, and handler code. - [Reply](/agents/custom-code-agent/setup-your-agent/reply.md): Send plain text, markdown, attachments, and interactive cards from agent handlers. - [Scaffold your project](/agents/custom-code-agent/setup-your-agent/scaffold-your-project.md): Generate a Novu agent bridge application with the CLI and connect it to your dashboard agent. - [Signals](/agents/custom-code-agent/setup-your-agent/signals.md): Use signals in agent handlers for metadata, workflow triggers, and conversation resolution. - [Agents and providers](/agents/get-started/agents-and-providers.md): How agents and providers work together to enable agent communication across channels. - [Mental model](/agents/get-started/mental-model.md): How inbound messages flow from a messaging platform through Novu to your agent code and back. - [What is Agent Communication Infrastructure (ACI)?](/agents/get-started/what-is-aci.md): Learn what ACI is, what it solves, and how it helps agents communicate across channels. - [Add skills](/agents/managed-agent/add-skills.md): Upload custom SKILL.md files to give your managed agent domain-specific instructions. - [Managed Agent Concepts](/agents/managed-agent/concepts.md): Connectors, MCP servers, skills, system prompts, and conversation flow for managed agents. - [Configure MCP servers](/agents/managed-agent/configure-mcp-servers.md): Enable external tools like Linear, GitHub, and Notion on your managed agent using MCP servers. - [Overview of Managed Agents](/agents/managed-agent/overview.md): What managed agents are, how they work, and when to use them. - [Managed Agent Quickstart](/agents/managed-agent/quickstart.md): Create a managed agent with Claude, connect it to Slack, and get a reply in under 10 minutes. ## Guides - [Novu Guides and Tutorials](/guides.md): Step-by-step guides for integrating Novu with popular services like Clerk, Stripe, and Segment. - [Using Translations with @novu/framework](/guides/framework/using-translations.md): Learn how to use translations with @novu/framework based workflows - [Novu and Inngest integration guide](/guides/inngest.md): This guide walks you through integrating Inngest with Novu notifications - [Migrate from Courier to Novu](/guides/migrate-from-courier-to-novu.md): Learn how to migrate your notification infrastructure from Courier to Novu - [Managing workflows with the Novu API](/guides/recipes/managing-workflows.md): Update workflow definitions in Development with the Novu API, then publish them to other environments through CI/CD. - [Novu and Trigger.dev integration guide](/guides/triggerdotdev.md): Integrate Novu with Trigger.dev to send notifications from background jobs. Covers setup, subscribers, and practical examples. - [Novu and Clerk integration guide](/guides/webhooks/clerk.md): This guide walks you through integrating Clerk webhooks with Novu notifications in a Next.js application. - [How to integrate Segment with Novu](/guides/webhooks/segment.md): Learn how to set up Segment as a data source for Novu using Destination Functions. Send user events from Segment to trigger notifications in Novu. - [Novu and Stripe integration guide](/guides/webhooks/stripe.md): This guide walks you through integrating Stripe webhooks with Novu notifications in a Next.js application. ## Community - [Community](/community.md): Get started and get involved with the Novu Project - [Add a new provider](/community/add-a-new-provider.md): Steps to add a new provider to Novu - [Changelog](/community/changelog.md): See the most recent changes and learn about how to shape Novu's future - [Novu Community Code of conduct](/community/code-of-conduct.md): The set of rules and guidelines that govern interaction among community members - [Feature Flags](/community/feature-flags.md): Learn how to enable/disable specific features in Novu - [Get involved with the Novu Community](/community/get-involved.md): Your guide for engaging with the Novu Community - [Product Roadmap](/community/roadmap.md): Learn about our roadmap - [Run Novu in local machine](/community/run-in-local-machine.md): Prerequisites and steps to run Novu in local machine. Learn how to set up Novu on your local environment for testing and development. - [Self-Hosted and Novu Cloud](/community/self-hosted-and-novu-cloud.md): Understand the difference between Self-Hosted and Novu Cloud - [Data Migrations](/community/self-hosting-novu/data-migrations.md): Learn how to update your database data through migrations. - [Deploy with Docker](/community/self-hosting-novu/deploy-with-docker.md): Learn how to deploy Novu with Docker - [Self-Hosting Novu Overview](/community/self-hosting-novu/overview.md): Self-host Novu for full control over your notification infrastructure. Covers system requirements, VMs, Redis, MongoDB, and storage. - [Self-Hosting Telemetry](/community/self-hosting-novu/telemetry.md): Learn about Novu's telemetry data collection and how to configure it - [Migrate from v0 Web UI to v2 Dashboard](/community/self-hosting-novu/v0-to-v2-migration.md): A guide to help you migrate from Novu self-hosted v0 to v2 ## Framework - [Novu Framework Overview](/framework.md): Learn how to extend Novu's capabilities by building custom notification workflows with code using the Novu Framework. - [Novu Framework Chat Channel](/framework/chat-channel.md): Learn the process of configuring and using chat providers with Novu - [React Email Integration](/framework/content/react-email.md): Learn how to use React Email to build beautiful email templates - [Remix & React Email](/framework/content/remix-react-email.md): Learn how to integrate React Email with Novu Framework in a Remix application - [Svelte Email Integration](/framework/content/svelte-email.md): Learn how to use Svelte Email to build beautiful email templates - [Vue Email Integration](/framework/content/vue-email.md): Learn how to use Vue Email to build beautiful email templates - [Novu Framework Controls](/framework/controls.md): Learn how to use Controls in your notification workflows - [Custom Action Step](/framework/custom.md): Used to execute any custom code as a step in the workflow. - [Framework Delay Implementation](/framework/delay.md): Learn how to use Delay steps in your notification workflows - [GitHub Actions](/framework/deployment/actions.md): Learn how to deploy your Novu workflows using the built-in GitHub Action for CI/CD automation. - [Novu CLI Deployment](/framework/deployment/cli.md): Learn how to use the Novu CLI to synchronize your workflows to Novu Cloud for production deployment. - [Production Deployment](/framework/deployment/production.md): Learn how to deploy your Novu Framework application to production including networking, security, and HMAC verification setup. - [Syncing Changes to Cloud](/framework/deployment/syncing.md): Learn how to sync your local workflow changes to the Novu Cloud Dashboard across development and production environments. - [Digest Action Step](/framework/digest.md): Learn how to use the Digest Engine to collect multiple events into a single message - [Novu Framework Email Channel](/framework/email-channel.md): Learn how to configure the Email channel - [Bridge Endpoint](/framework/endpoint.md): Learn how to configure the Novu Bridge Endpoint, the single HTTP endpoint your application exposes to communicate with the Novu Worker Engine. - [Novu Framework In-App Channel](/framework/in-app-channel.md): Learn how to configure the In-App channel - [Framework Introduction](/framework/introduction.md): Discover how the Novu Framework empowers you to build, customize, and manage advanced notification workflows with a mix of code and no-code capabilities. - [Workflow Payload](/framework/payload.md): Learn how to define and validate workflow payload schemas for data passed during the novu.trigger method. - [Novu Framework Push Channel](/framework/push-channel.md): Learn how to configure the Push channel - [Express.js Framework Quickstart Guide](/framework/quickstart/express.md): Get started with Novu Framework in an Express application - [H3 Framework Quickstart Guide](/framework/quickstart/h3.md): Get started with Novu Framework in an H3 application - [AWS Lambda Framework Quickstart Guide](/framework/quickstart/lambda.md): Get started with Novu Framework in an AWS Lambda function - [NestJS Framework Quickstart Guide](/framework/quickstart/nestjs.md): Get started with Novu Framework in a NestJS application - [Next.js Framework Quickstart Guide](/framework/quickstart/nextjs.md): Get started with Novu Framework in a Next.js application - [Nuxt Framework Quickstart Guide](/framework/quickstart/nuxt.md): Get started with Novu Framework in a Nuxt application - [Remix Framework Quickstart Guide](/framework/quickstart/remix.md): Get started with Novu Framework in a Remix application - [SvelteKit Framework Quickstart Guide](/framework/quickstart/svelte.md): Get started with Novu Framework in a SvelteKit application - [Class Validator Schema](/framework/schema/class-validator.md): Integrate Class Validator with your notification workflows - [JSON Schema Validation](/framework/schema/json-schema.md): Learn how to use JSON Schema to define the workflow payload and step inputs - [Zod Schema Validation](/framework/schema/zod.md): Learn how to integrate Zod with Novu Framework - [Novu Framework Skip Function](/framework/skip.md): Skip any step of the workflow based on a condition - [Framework SMS Channel](/framework/sms-channel.md): Learn how to configure the SMS channel - [Local Studio](/framework/studio.md): Learn how to use the Local Studio companion app for Novu Framework SDK - [Workflow Tags](/framework/tags.md): Learn how to implement and manage notification tags programmatically using the Novu Framework SDK. - [Framework Client](/framework/typescript/client.md): Learn how to configure and use the Novu Framework Client for managing global settings - [Novu Framework TypeScript Overview](/framework/typescript/overview.md): Learn how to use Novu's TypeScript SDK to build type-safe notification workflows with advanced features like payload validation and step controls. - [Step Interface](/framework/typescript/steps.md): Learn about the Novu Framework step interface and its configuration options - [Novu Framework TypeScript Chat Step](/framework/typescript/steps/chat.md): Learn how to use the chat step to send messages to chat platforms like Slack, Discord, and Microsoft Teams - [Novu Framework TypeScript Custom Action Step](/framework/typescript/steps/custom.md): Learn how to use the custom step to execute arbitrary code in your workflow - [Delay Step Reference](/framework/typescript/steps/delay.md): Learn how to use the delay step to pause workflow execution for a specified duration - [Digest Step Reference](/framework/typescript/steps/digest.md): Learn how to use the digest step to aggregate multiple events into a single notification - [Novu Framework TypeScript Email Step](/framework/typescript/steps/email.md): Learn how to use the email step to send email notifications - [Novu Framework TypeScript In-App Step](/framework/typescript/steps/inApp.md): Learn how to use the In-App step to send notifications to your web or mobile app's inbox - [Novu Framework TypeScript Push Step](/framework/typescript/steps/push.md): Learn how to use the push step to send notifications to mobile and web apps - [Novu Framework TypeScript SMS Step](/framework/typescript/steps/sms.md): Learn how to use the SMS step to send text messages to users - [Novu Framework Workflow Interface](/framework/typescript/workflow.md): Learn about the Novu Framework workflow interface and its configuration options ## Platform - [Novu Platform Overview](/platform.md): Explore the Novu notification infrastructure platform. Learn about workflows, subscribers, integrations, and the Inbox component. - [Authentication Setup](/platform/account/authentication.md): Configure authentication for Novu with OAuth, SSO, MFA, and more. Available for Enterprise customers on Novu Cloud. - [Billing and Payments](/platform/account/billing.md): Manage your billing and payment information, view invoices, and upgrade your subscription plan. - [Team members](/platform/account/manage-members.md): How to invite, manage, update permissions for, and remove members from your Novu organization - [Roles and permissions](/platform/account/roles-and-permissions.md): Learn how roles and permissions are managed within Novu organizations - [Single Sign-On (SSO) for your account](/platform/account/sso.md): Enable SAML SSO and SCIM directory sync for your organization - [Common Errors](/platform/additional-resources/errors.md): Understand common errors in your notification workflows and how to resolve them - [Novu Glossary](/platform/additional-resources/glossary.md): Definitions - [Legacy documentation](/platform/additional-resources/legacy-documentation.md): Access the legacy v0.x Novu documentation for older versions of the platform. - [Security and Compliance](/platform/additional-resources/security.md): Learn about Novu security certifications, compliance standards, data residency, and privacy policies - [Agent Toolkit](/platform/build-with-ai/agent-toolkit.md): Expose Novu notification workflows as tools for LLM agents with the @novu/agent-toolkit package. Works with OpenAI, LangChain, and Vercel AI SDK. - [MCP Server](/platform/build-with-ai/mcp.md): Connect your AI tools to Novu using MCP and manage notifications using natural language. - [Agent Skills](/platform/build-with-ai/skills.md): Learn how to use Novu Agent Skills to help AI agents build multi-channel notification systems. - [Integrations](/platform/concepts/integrations.md): Learn how Novu integrations connect you to third-party providers - [Notification event](/platform/concepts/notification-event.md): Learn about the Novu notifications lifecycle and the key entities that make up a notification. - [Notification Preferences Concepts](/platform/concepts/preferences.md): Learn how to manage subscriber preferences in Novu. - [Subscribers](/platform/concepts/subscribers.md): Learn what a subscriber is in Novu, how they’re identified, and how they fit into the notification system. - [Multi-tenancy Concepts in Novu](/platform/concepts/tenants.md): Learn about how to implement multi-tenant notifications in Novu - [Topics in Novu](/platform/concepts/topics.md): Learn how topics work in Novu and how they help you organize and target groups of subscribers efficiently. - [Triggering Workflows](/platform/concepts/trigger.md): Managing Trigger Events from Request to Processing - [Workflows](/platform/concepts/workflows.md): Learn what workflows are and how they work in Novu. - [API Keys Management](/platform/developer/api-keys.md): Manage authentication credentials and connection endpoints for your Novu integration. - [Environment Variables in Novu](/platform/developer/environment-variables.md): Create reusable, environment-scoped variables in the dashboard and reference them in workflows. - [Environments](/platform/developer/environments.md): Understanding and managing environments in Novu - [System Limits and Quotas](/platform/developer/limits.md): System limits, quotas, and constraints for the Novu platform. - [Novu Webhooks Overview](/platform/developer/webhooks.md): Configure webhook endpoints to receive real-time event notifications from Novu for workflow updates and message delivery. - [Webhooks event types](/platform/developer/webhooks/event-types.md): Learn more about the types of events that Novu sends webhook events for. - [Novu Webhooks Guide](/platform/developer/webhooks/webhooks.md): Learn how Novu webhooks work, including event types, payload schemas, signature verification, and endpoint configuration. - [How Novu Works](/platform/how-novu-works.md): A high-level overview of Novu’s architecture: workflows, triggers, subscribers, and environments, and how they connect to support in-app and external channels. - [Introduction to Inbox](/platform/inbox.md): Learn how to integrate Novu Inbox component, a pre-built notification center component for real-time in-app notifications in your application. - [Conditionally display notifications](/platform/inbox/advanced-customization/conditional-display.md): Learn how to apply conditional display logic to notifications. - [Customize Bell Icon](/platform/inbox/advanced-customization/customize-bell.md): Learn how to fully customize the inbox component bell icon using your own components or third-party libraries. - [Customize Notification Items](/platform/inbox/advanced-customization/customize-notification-items.md): Learn how to use render props in the Inbox component to customize the subject, body, avatar, default and custom actions, or the entire notification item. - [Customize Popover](/platform/inbox/advanced-customization/customize-popover.md): Learn how to display the Inbox content outside the default popover and integrate it into your own custom popover or page layout. - [Use HTML in Notification Content](/platform/inbox/advanced-customization/html-in-notifications.md): Learn how to enable and display raw HTML in the notification subject and body for rich formatting. - [Notification Click Behavior](/platform/inbox/advanced-customization/notification-click-behavior.md): Learn how to configure routing and interaction behavior for notifications using routerPush and click handlers. - [Localizing the Inbox component](/platform/inbox/advanced-features/localization.md): Learn how to customize the Inbox UI for different languages using the localization prop. - [Inbox Multi-tenancy Configuration](/platform/inbox/advanced-features/multi-tenancy.md): Learn how to use context to implement multi-tenant notifications to support different organizations or workspaces within your application. - [Inbox Data Object](/platform/inbox/configuration/data-object.md): Learn how to use the data object to extend in-app notifications with custom metadata. - [Customize Icons in the Inbox](/platform/inbox/configuration/icons.md): Learn how to override the default icons in the Inbox UI using the appearance prop. - [Use Contexts for Inbox Personalization](/platform/inbox/configuration/inbox-with-context.md): Learn how to use contexts in the Inbox component to filter and personalize notifications for your subscribers. - [Inbox Preferences Configuration](/platform/inbox/configuration/preferences.md): Learn how to configure and customize subscriber preferences in your application using the Novu Inbox component. - [Styling the Inbox component](/platform/inbox/configuration/styling.md): Learn how to style the pre built Inbox component - [Inbox Tabs Configuration](/platform/inbox/configuration/tabs.md): Learn what tabs are and how to filter multiple tabs in the Novu Inbox component. - [Schedule Notifications](/platform/inbox/features/schedule.md): Learn how subscribers can use the Schedule feature in the Inbox component to control when they receive notifications from email, SMS and push channels. - [Snooze Notifications](/platform/inbox/features/snooze.md): Allow users to temporarily hide notifications and resurface them later using built-in snooze functionality in the Inbox component. - [Headless mode](/platform/inbox/headless-mode.md): Learn how to build custom Inbox UI for your application using Novu custom hooks - [Migrate to the New Inbox](/platform/inbox/migration-guide.md): This guide outlines the key differences between the @novu/notification-center package and the new @novu/react package and how to migrate to the latest Inbox version. - [Prepare Inbox component for Production](/platform/inbox/prepare-for-production.md): Learn how to prepare your Inbox for production by enabling HMAC encryption for security and managing Novu's branding. - [Set up the Inbox](/platform/inbox/setup-inbox.md): Learn how to integrate the Novu Inbox component into your application to display real-time notifications for your subscribers. - [Integrations Overview](/platform/integrations.md): Learn about the providers that Novu supports for Email, Push, SMS and Chant channels, and how to integrate them to send notifications and receive events. - [Chat Integrations](/platform/integrations/chat.md): Configure and manage chat providers like Slack, Microsoft Teams, WhatsApp, and Discord with Novu's notification infrastructure. - [Adding Chat Channel](/platform/integrations/chat/adding-chat.md): Learn how to add the Chat channel to your application - [Discord Chat Integration](/platform/integrations/chat/discord.md): Learn about how to use Discord provider for chat notifications - [Mattermost](/platform/integrations/chat/mattermost.md): Learn about how to use Mattermost provider for chat notifications - [Microsoft Teams Integration](/platform/integrations/chat/ms-teams.md): Learn about how to use MS Teams provider for chat notifications - [Slack Chat Integration](/platform/integrations/chat/slack.md): Learn about how to use Slack provider for chat notifications - [WhatsApp Integration](/platform/integrations/chat/whats-app.md): Learn about how to use WhatsApp for chat notifications - [Zulip Chat Integration](/platform/integrations/chat/zulip.md): Learn about how to use Zulip provider for chat notifications - [Demo Integrations](/platform/integrations/demo-integration.md): Learn about the default Novu Email and SMS provider. - [E-mail Providers Integration](/platform/integrations/email.md): Learn how to configure the Email channel - [Email Activity Tracking](/platform/integrations/email/activity-tracking.md): Learn how to enable activity tracking to get real-time delivery and engagement events like delivered, opened, and clicked from your email providers. - [Mailgun Email Activity Tracking Setup](/platform/integrations/email/activity-tracking/manual-configuration/mailgun.md): A step-by-step guide to manually add specific event webhooks in Mailgun for Novu activity tracking. - [Resend Email Activity Tracking Setup](/platform/integrations/email/activity-tracking/manual-configuration/resend.md): A step-by-step guide to manually configure Resend event webhooks for Novu activity tracking. - [SendGrid Email Activity Tracking Setup](/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.md): A step-by-step guide to manually configure SendGrid event webhooks for Novu activity tracking. - [SES Activity Tracking Setup](/platform/integrations/email/activity-tracking/manual-configuration/ses.md): A step-by-step guide to manually configure Amazon SES with Novu for email activity tracking. - [Adding Email Channel](/platform/integrations/email/adding-email.md): Learn how to add the Email channel to your application - [Amazon SES Integration](/platform/integrations/email/amazon-ses.md): Learn how to use the Amazon SES provider to send email notifications using Novu - [Braze Email Integration](/platform/integrations/email/braze.md): Learn how to use the Braze provider to send email notifications using Novu - [Brevo (Sendinblue) integration guide](/platform/integrations/email/brevo.md): Learn how to use the Sendinblue provider to send email notifications using Novu - [Custom SMTP](/platform/integrations/email/custom-smtp.md): Learn how to use the Custom SMTP provider to send email notifications using Novu - [Infobip email integration guide](/platform/integrations/email/infobip.md): Learn how to use the Infobip provider to send email notifications using Novu - [MailerSend](/platform/integrations/email/mailersend.md): Learn how to use the MailerSend provider to send email notifications using Novu - [Mailgun email integration guide](/platform/integrations/email/mailgun.md): Learn how to use the Mailgun provider to send email notifications using Novu - [Mailjet email integration guide](/platform/integrations/email/mailjet.md): Learn how to use the Mailjet provider to send email notifications using Novu - [Mailtrap Email Provider](/platform/integrations/email/mailtrap.md): Learn how to use the Mailtrap provider to send email notifications using Novu - [Mandrill Email Provider](/platform/integrations/email/mandrill.md): Learn how to use the Mandrill provider to send email notifications using Novu - [Maqsam SMS Provider](/platform/integrations/email/maqsam.md): Learn how to use the Maqsam provider to send sms notifications using Novu - [Netcore Email Provider](/platform/integrations/email/netcore.md): Learn how to use the Netcore provider to send email notifications using Novu - [Outlook 365](/platform/integrations/email/outlook365.md): Learn how to use the Outlook 365 provider to send email notifications using Novu - [Plunk email integration guide](/platform/integrations/email/plunk.md): Learn how to use the Plunk provider to send email notifications using Novu - [Postmark Email Provider](/platform/integrations/email/postmark.md): Learn how to use the Postmark provider to send email notifications using Novu - [Resend email integration guide](/platform/integrations/email/resend.md): Learn how to use the Resend provider to send email notifications using Novu - [SendGrid Email Integration](/platform/integrations/email/sendgrid.md): Learn how to use the SendGrid provider to send email notifications using Novu - [Sparkpost](/platform/integrations/email/sparkpost.md): Learn how to use the Sparkpost provider to send email notifications using Novu - [Email Webhook](/platform/integrations/email/webhook.md): Learn how to use the Email Webhook provider to send email notifications using Novu - [Writing Email Template](/platform/integrations/email/writing-email-template.md): Learn how to build email templates in Novu using the block editor, the code editor (custom HTML), or the API - [Push Notification Channel Integrations](/platform/integrations/push.md): Connect push providers like FCM, APNS, and OneSignal to Novu. Manage device tokens and deliver mobile and web push notifications. - [Apple Push Notification Service (APNS)](/platform/integrations/push/apns.md): Learn how to use the Apple Push Notification Service (APNS) provider to send push notifications using Novu - [Expo Push](/platform/integrations/push/expo-push.md): Learn how to use the Expo Push provider to send push notifications using Novu - [Firebase Cloud Messaging (FCM)](/platform/integrations/push/fcm.md): Learn how to use the Firebase Cloud Messaging (FCM) provider to send push notifications using Novu - [OneSignal](/platform/integrations/push/onesignal.md): Learn how to use the OneSignal provider to send push notifications using Novu - [Push Notification Activity Tracking](/platform/integrations/push/push-activity-tracking.md): Learn how to manually forward push notification events from your application to Novu for unified activity tracking. - [Push Webhook](/platform/integrations/push/push-webhook.md): Learn how to use the Push Webhook provider to send notifications using Novu - [Pusher Beams](/platform/integrations/push/pusher-beams.md): Learn how to use the Pusher Beams provider to send push notifications using Novu - [Pushpad Push Provider](/platform/integrations/push/pushpad.md): Learn how to use the Pushpad provider to send web push notifications using Novu - [SMS Integrations](/platform/integrations/sms.md): Integrate SMS providers with Novu to deliver text message notifications. Configure providers, set up workflows, and manage delivery. - [46elks SMS Provider](/platform/integrations/sms/46elks.md): Learn how to use the 46elks provider to send sms notifications using Novu - [Adding SMS Channel](/platform/integrations/sms/adding-sms.md): Learn how to add the SMS channel to your application - [Africa's Talking](/platform/integrations/sms/africas-talking.md): Learn how to use the Africa's Talking provider to send sms notifications using Novu - [AWS SNS SMS Provider](/platform/integrations/sms/aws-sns.md): Learn how to use the AWS SNS provider to send sms notifications using Novu - [Azure SMS](/platform/integrations/sms/azure.md): Learn how to use the Azure SMS provider to send sms notifications using Novu - [BulkSMS SMS Provider](/platform/integrations/sms/bulk-sms.md): Learn how to use the BulkSMS provider to send sms notifications using Novu - [Clickatell](/platform/integrations/sms/clickatell.md): Learn how to use the Clickatell provider to send sms notifications using Novu - [Clicksend](/platform/integrations/sms/clicksend.md): Learn how to use the Clicsend provider to send sms notifications using Novu - [Firetext SMS Provider](/platform/integrations/sms/firetext.md): Learn how to use the firetext provider to send sms notifications using Novu - [Gupshup SMS Provider](/platform/integrations/sms/gupshup.md): Learn how to use the Gupshup SMS provider to send SMS notifications using Novu - [Infobip - SMS](/platform/integrations/sms/infobip.md): Learn how to use the Infobip provider to send sms notifications using Novu - [Kannel SMS Provider](/platform/integrations/sms/kannel.md): Learn how to use the Kannel sms provider to send sms notifications using Novu - [Kudosity SMS Provider](/platform/integrations/sms/kudosity.md): Learn how to use the Kudosity (formerly BurstSMS) provider to send sms notifications using Novu - [MessageBird](/platform/integrations/sms/messagebird.md): Learn how to use the messagebird provider to send sms notifications using Novu - [Nexmo SMS Provider](/platform/integrations/sms/nexmo.md): Learn how to use the Nexmo provider to send sms notifications using Novu - [Plivo SMS Provider](/platform/integrations/sms/plivo.md): Learn how to use the Plivo provider to send sms notifications using Novu - [Sendchamp](/platform/integrations/sms/sendchamp.md): Learn how to use the Sendchamp provider to send sms notifications using Novu - [SimpleTexting](/platform/integrations/sms/simpletexting.md): Learn how to use the SimpleTexting provider to send sms notifications using Novu - [SMS Central](/platform/integrations/sms/sms-central.md): Learn how to use the SMS Central provider to send sms notifications using Novu - [SMS77 SMS Provider](/platform/integrations/sms/sms77.md): Learn how to use the SMS77 provider to send sms notifications using Novu - [AWS SNS SMS Provider](/platform/integrations/sms/sns.md): Learn how to use the SNS provider to send sms notifications using Novu - [Telnyx SMS Provider](/platform/integrations/sms/telnyx.md): Learn how to use the Telnyx provider to send sms notifications using Novu - [Termii SMS Provider](/platform/integrations/sms/termii.md): Learn how to use the Termii provider to send sms notifications using Novu - [Twilio SMS Provider](/platform/integrations/sms/twilio.md): Learn how to use the Twilio provider to send sms notifications using Novu - [Trigger Overrides](/platform/integrations/trigger-overrides.md): Learn how to customize the behavior of your workflows at trigger time - [Novu for Developers](/platform/novu-for/developers.md): Novu is a powerful notifications platform designed for developers and engineers to build, manage, and deliver scalable, extensible, and captivating multi-channel notification experiences while empowering product teams with intuitive tools and prebuilt components. - [No-Code tools to manage your notifications](/platform/novu-for/product.md): Change notification messaging, verbiage, and cadence without requiring engineering's help by using the Novu Dashboard UI. - [Novu Angular Quickstart Guide](/platform/quickstart/angular.md): Create an account and learn how to start using Novu Inbox Notification in your angular application. - [Novu Next.js Quickstart Guide](/platform/quickstart/nextjs.md): Set up Novu in-app notifications in your Next.js app. Install the SDK, add the Inbox component, and trigger your first notification. - [Novu React Quickstart Guide](/platform/quickstart/react.md): Learn how to integrate the Novu Inbox component into a React application and add routing with React Router. - [Novu Remix Quickstart Guide](/platform/quickstart/remix.md): Integrate Novu in-app notifications into your Remix application. Follow step-by-step setup from install to first notification. - [Novu Vanilla JS Quickstart Guide](/platform/quickstart/vanilla-js.md): Learn how to integrate the Novu Inbox component into a Vanilla JS and HTML project. - [Novu Vue Quickstart Guide](/platform/quickstart/vue.md): Create an account and learn how to start using Novu Inbox in your vue application. - [Novu SDKs Overview](/platform/sdks.md): Explore Novu's server-side and client-side SDKs for integrating notifications across multiple languages and frameworks. - [API reference for the @novu/js package](/platform/sdks/javascript.md): Complete API reference for the Novu JavaScript package - [API reference for the @novu/react package](/platform/sdks/react.md): API reference for @novu/react components including Inbox, Bell, Notifications, and Subscription. - [Novu React Native SDK](/platform/sdks/react-native.md): Learn how to add Novu powered Inbox to your React Native app - [Novu React Native NovuProvider Hook](/platform/sdks/react-native/hooks/novu-provider.md): Learn how to use the NovuProvider component to set up the Novu context in your React Native application - [Novu React Native useCounts Hook](/platform/sdks/react-native/hooks/use-counts.md): Learn how to use the useCounts hook to fetch notification counts in your React Native application - [useNotifications - React Native](/platform/sdks/react-native/hooks/use-notifications.md): Learn how to use the useNotifications hook to fetch and manage notifications in your React Native application - [Novu React Native useNovu Hook](/platform/sdks/react-native/hooks/use-novu.md): Learn how to use the useNovu hook to access the Novu client instance in your React Native application - [Novu React Native usePreferences Hook](/platform/sdks/react-native/hooks/use-preferences.md): Learn how to use the usePreferences hook to manage notification preferences in your React Native application - [Novu React Native useSchedule Hook](/platform/sdks/react-native/hooks/use-schedule.md): Learn how to use the useSchedule hook to manage notification delivery schedules in your React Native application - [Novu React SDK Changelog](/platform/sdks/react/changelog.md): Changelog for the @novu/react package - [NovuProvider](/platform/sdks/react/hooks/novu-provider.md): Learn how to use the NovuProvider component to set up the Novu context in your React application - [React hooks for subscription management](/platform/sdks/react/hooks/subscription.md): Learn how to use the useSubscriptions, useCreateSubscription, and other hooks to manage subscriptions in Novu. - [useCounts Hook](/platform/sdks/react/hooks/use-counts.md): Learn how to use the useCounts hook to fetch notification counts in your React application - [useNotifications Model - React](/platform/sdks/react/hooks/use-notifications.md): API reference for the useNotifications hook return types and data models in the React SDK - [Novu React useNovu Hook](/platform/sdks/react/hooks/use-novu.md): Learn how to use the useNovu hook to access the Novu client instance in your React application - [Novu React usePreferences Hook](/platform/sdks/react/hooks/use-preferences.md): Learn how to use the usePreferences hook to manage notification preferences in your React application - [Novu React useSchedule Hook](/platform/sdks/react/hooks/use-schedule.md): Learn how to use the useSchedule hook to manage subscriber notification schedules in your React application - [Novu Server Side SDKs documentation](/platform/sdks/server.md): Explore Novu's comprehensive collection of server-side SDKs for seamless notification integration across multiple programming languages - [Novu .NET SDK](/platform/sdks/server/dotnet.md): Connect a .NET application to Novu - [Go SDK for Novu](/platform/sdks/server/go.md): Connect a Go application to Novu - [Novu Java SDK](/platform/sdks/server/java.md): Connect a Java application to Novu - [Novu Kotlin SDK](/platform/sdks/server/kotlin.md): Connect a Kotlin application to Novu - [Novu Laravel SDK](/platform/sdks/server/laravel.md): Connect a Laravel application to Novu - [PHP SDK for Novu](/platform/sdks/server/php.md): Connect a PHP application to Novu - [Novu Python SDK](/platform/sdks/server/python.md): Connect a Python application to Novu - [Novu Ruby SDK](/platform/sdks/server/ruby.md): Connect a Ruby application to Novu - [Novu Typescript SDK](/platform/sdks/server/typescript.md): Connect a TS/JS application to Novu - [Subscription preferences](/platform/subscription.md): Learn what a Subscription is in Novu, how they fit into the notification system. - [Customize and configure](/platform/subscription/customize-and-configure.md): Learn how to filter visible preferences, customize styling, and use custom render functions. - [Headless hooks](/platform/subscription/headless-hooks.md): Build a fully custom Subscription interface using hooks. - [ Quickstart Guide](/platform/subscription/quickstart.md): Learn how to integrate and render the Subscription component in your React app to manage user preferences. - [What is Novu?](/platform/what-is-novu.md): The open-source notification infrastructure that simplifies in-app, email, chat, and push notifications. - [Novu Workflows Overview](/platform/workflow.md): Learn how to create, configure, and work with notification workflows in Novu. - [How to add and configure Workflow Steps](/platform/workflow/add-and-configure-steps.md): Learn how workflow steps work in Novu, the different step types available, and how to add and execute steps in a notification workflow. - [How to configure code steps in a workflow](/platform/workflow/add-and-configure-steps/code-steps.md): Learn how to add code steps to a workflow, publish them with the Novu CLI, and use code-managed steps with UI-managed steps in a workflow. - [How to configure Delay Step](/platform/workflow/add-and-configure-steps/configure-action-steps/delay.md): Learn how to use delay step to pause workflow execution. - [How to configure Digest Step](/platform/workflow/add-and-configure-steps/configure-action-steps/digest.md): Batch multiple workflow trigger events into a single execution using configurable digest windows and grouping rules. - [How to configure HTTP Step](/platform/workflow/add-and-configure-steps/configure-action-steps/http-step.md): Learn how to use HTTP step to make external HTTP requests. - [How to configure Throttle Step](/platform/workflow/add-and-configure-steps/configure-action-steps/throttle.md): Learn how to use the Throttle step in Novu workflows to control notification frequency. - [Step Conditions](/platform/workflow/add-and-configure-steps/step-conditions.md): Create dynamic notification workflows using rule-based conditions. Control message delivery based on subscriber, payload, and workflow data. - [Template Editors](/platform/workflow/add-notification-content/channels-template-editors.md): Learn how to design and configure notification content for email, in-app, push, and SMS. - [Personalize Content](/platform/workflow/add-notification-content/personalize-content.md): Learn how to personalize notification content in Novu using template variables, context data, and LiquidJS filters across all channel template editors. - [Workflow Context](/platform/workflow/advanced-features/contexts.md): Learn what Contexts are in Novu, how they differ from payloads, and how they help you organize and personalize notifications across workflows. - [Personalize workflows and templates in Novu using context](/platform/workflow/advanced-features/contexts/contexts-in-workflows.md): Use contexts in Novu to personalize notification templates, control workflow logic, and customize the Inbox component. - [How to manage contexts in Novu](/platform/workflow/advanced-features/contexts/manage-contexts.md): Learn how to create, update, and delete contexts in Novu using the dashboard, or API. - [Translations](/platform/workflow/advanced-features/translations.md): Learn how to translate your workflow step content into multiple languages - [How to configure Workflow in Novu](/platform/workflow/configure-workflow.md): Configure workflow metadata, delivery preferences, and payload schema in the workflow editor. - [How to create a Workflow in Novu](/platform/workflow/create-a-workflow.md): Create a workflow and define its identifier, metadata, and initial configuration. - [Monitor and Debug Workflows](/platform/workflow/monitor-and-debug-workflow.md): Learn how to monitor workflow executions and debug issues from the Novu Activity Feed. - [How to trigger Workflow in Novu](/platform/workflow/trigger-workflow.md): Learn how workflows are triggered in Novu using the Event API, including triggering workflows for individual subscribers, attaching context data, and broadcasting notifications to topics.