Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/docs/api-reference/contexts/context-schema.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Context schema
pageTitle: "Context schema API Reference (Contexts)"
pageTitle: "Context Schema"
description: "Reference the Novu context schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Context
## Context

**Context** is a reusable, user-defined data object that stores metadata (like tenant, region, or app details) to organize and personalize notifications. Unlike payloads that exist only for a single workflow execution, contexts are persistent and can be shared across multiple workflows and API calls.
This makes them particularly useful for multi-tenant applications, dynamic branding, and scenarios where notifications need to reference common, reusable data.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Environment schema
pageTitle: "Environment schema API Reference (Environments)"
pageTitle: "Environment Schema"
description: "Reference the Novu environment schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Environment
## Environment

Environment is a collection of resources that are used to send notifications. For example, an environment can have a set of integrations, workflows, and subscribers. Read more about environments on [environments concept page](/platform/developer/environments).

Expand Down
1 change: 1 addition & 0 deletions content/docs/api-reference/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: 'Overview'
pageTitle: "Novu API Reference Overview"
description: "Complete Novu API reference covering authentication, endpoints, rate limits, and server-side integration for notifications."
---

<Callout>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Auto-configure an integration for inbound webhooks
pageTitle: "Auto-Configure Integration"
description: >-
Auto-configure an integration by its unique key identifier **integrationId**
for inbound webhook support.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Integration schema
pageTitle: "Integration schema API Reference (Integrations)"
pageTitle: "Integration Schema"
description: "Reference the Novu integration schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Integration
## Integration

Integration is third party service used by Novu to send notification for a specific channel. For example, [sengrid](/platform/integrations/email/sendgrid) is a email integration and [twilio](/platform/integrations/sms/twilio) is a sms integration. Read more about integrations on [integrations concept page](/platform/concepts/integrations).

Expand Down Expand Up @@ -71,7 +71,7 @@ Integration is third party service used by Novu to send notification for a speci
}
}} />

### Credentials
## Credentials

Each integration has a set of credentials that are used to authenticate with the third party service. Checkout the provider documentation for more details on what credentials are required for each integration.

Expand Down Expand Up @@ -262,7 +262,7 @@ Each integration has a set of credentials that are used to authenticate with the
}
}} />

### ChannelTypeEnum
## ChannelTypeEnum

ChannelTypeEnum is used to specify the type of channel that the integration is used for. For example, if the integration is used for email, the channel type will be `email`.

Expand Down
14 changes: 7 additions & 7 deletions content/docs/api-reference/messages/message-schema.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Message schema
pageTitle: "Message schema API Reference (Messages)"
pageTitle: "Message Schema"
description: "Reference the Novu message schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Message
## Message

Message is a single notification that is sent to a subscriber. Each channel step in the workflow generates a message.

Expand Down Expand Up @@ -151,7 +151,7 @@ Message is a single notification that is sent to a subscriber. Each channel step
}
}} />

### ChannelTypeEnum
## ChannelTypeEnum
```typescript
ChannelTypeEnum {
IN_APP = "in_app",
Expand All @@ -162,7 +162,7 @@ ChannelTypeEnum {
}
```

### Workflow
## Workflow

Workflow is a collection of steps that are executed in order to send a notification.

Expand Down Expand Up @@ -253,7 +253,7 @@ Workflow is a collection of steps that are executed in order to send a notificat
}
}} />

### Actor
## Actor

Actor is the user who is skipped from sending the notification when workflow is triggered to a [topic](/platform/concepts/topics).

Expand All @@ -268,9 +268,9 @@ Actor is the user who is skipped from sending the notification when workflow is
}
}} />

### MessageCTA
## MessageCTA

MessageCTA is a call to action that is displayed in the [Inbox](/platform/inbox/overview) message. It can be used to redirect the user to a specific URL when the message is clicked.
MessageCTA is a call to action that is displayed in the [Inbox](/platform/inbox) message. It can be used to redirect the user to a specific URL when the message is clicked.

<TypeTable name="MessageCTA" type={{
"type": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Actor is the user who is skipped from sending the notification when workflow is

### MessageCTA

MessageCTA is a call to action that is displayed in the [Inbox](/platform/inbox/overview) message. It can be used to redirect the user to a specific URL when the message is clicked.
MessageCTA is a call to action that is displayed in the [Inbox](/platform/inbox) message. It can be used to redirect the user to a specific URL when the message is clicked.

---type-table---
../api-types.ts#MessageCTA
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Notification event schema
pageTitle: "Notification event schema API Reference (Notifications)"
pageTitle: "Notification Event Schema"
description: "Reference the Novu notification event schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Notification event
## Notification event

Notification event is the event that is generated when a workflow is triggered to subscribers. It contains workflow details, subscriber details payload sent during trigger, execution details of each step in the workflow and the result of the execution of each step.

Expand Down Expand Up @@ -95,7 +95,7 @@ Notification event is the event that is generated when a workflow is triggered t
}
}} />

### Workflow
## Workflow

Workflow contains the details of the workflow that was triggered.

Expand Down Expand Up @@ -186,7 +186,7 @@ Workflow contains the details of the workflow that was triggered.
}
}} />

### ChannelTypeEnum
## ChannelTypeEnum

ChannelTypeEnum is the type of the channel that the notification was sent to.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Subscriber schema
pageTitle: "Subscriber schema API Reference (Subscribers)"
pageTitle: "Subscriber Schema"
description: "Reference the Novu subscriber object schema. Explore all fields, data types, and descriptions for the Subscriber resource used in the Novu API."
---

### Subscriber
## Subscriber
Subscriber is the end user that receives notifications. Subscriber has subscriber attributes like firstName, lastName, email, phone, etc, `data` field to store any custom attributes in key value pairs and channel credentials for push and chat channel provider's integrations. Read more about subscribers on [subscribers concept page](/platform/concepts/subscribers).

<TypeTable name="Subscriber" type={{
Expand Down Expand Up @@ -90,7 +90,7 @@ Subscriber is the end user that receives notifications. Subscriber has subscribe
}
}} />

### ChannelSettingsDto
## ChannelSettingsDto
ChannelSettings are credentials for push and chat channel provider's integrations. One subscriber can have credentials for multiple integrations of same provider of one channel type

<TypeTable name="ChannelSettings" type={{
Expand All @@ -112,7 +112,7 @@ ChannelSettings are credentials for push and chat channel provider's integration
}
}} />

### Credentials
## Credentials
Credentials like deviceTokens, webhookUrl, etc for a specific integration. `providerId` could be chat channel providerId or push channel providerId.

<TypeTable name="Credentials" type={{
Expand Down
8 changes: 4 additions & 4 deletions content/docs/api-reference/topics/topic-schema.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Topic schema
pageTitle: "Topic schema API Reference (Topics)"
pageTitle: "Topic Schema"
description: "Reference the Novu topic object schema. Explore all fields, data types, and descriptions for the Topic resource used in the Novu API."
---

### Topic
## Topic
Topic is a collection of subscribers that share a common interest. Subscriber can subscribe to multiple topics. When a subscriber is subscribed to a topic, they will receive notifications generated by workflows triggered to that topic.

<TypeTable name="Topic" type={{
Expand All @@ -30,7 +30,7 @@ Topic is a collection of subscribers that share a common interest. Subscriber ca
}
}} />

### TopicSubscription
## TopicSubscription

TopicSubscription is a relationship between a subscriber and a topic. It is used to track which subscribers are subscribed to which topics and when they subscribed. `createdAt` is the date and time the subscription was created.

Expand Down Expand Up @@ -61,7 +61,7 @@ TopicSubscription is a relationship between a subscriber and a topic. It is used
}
}} />

### Subscriber
## Subscriber

Subscriber is a user who can receive notifications. Read more about subscribers on [subscribers concept page](/platform/concepts/subscribers).

Expand Down
4 changes: 2 additions & 2 deletions content/docs/api-reference/workflows/workflow-schema.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Workflow schema
pageTitle: "Workflow schema API Reference (Workflows)"
pageTitle: "Workflow Schema"
description: "Reference the Novu workflow schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Workflow
## Workflow

In Novu, a workflow defines the logic for delivering notifications based on specific events. It consists of configurable steps that control timing, conditions, and which channels to use, such as email, SMS, or in-app messages. Workflows can be built visually in the dashboard or programmatically using the Novu Framework. Each workflow has a unique identifier, supports environment syncing, and provides real-time visibility through the Activity Feed for monitoring and debugging.. Read more about workflows on [workflows concept page](/platform/concepts/workflows).

Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: "Novu Community Changelog - community documentation and contribution guide for Novu"
pageTitle: "Changelog"
title: 'Changelog'
description: "See the most recent changes and learn about how to shape Novu's future"
---
Expand Down
20 changes: 10 additions & 10 deletions content/docs/community/code-of-conduct.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ These guidelines do not cover every possible scenario comprehensively but serve

Traits of a Novu community member include:

### Being considerate and using appropriate channels
## Being considerate and using appropriate channels

Contributions of every kind have far-ranging consequences. Just as your work depends on the work of others, decisions you make surrounding your contributions to the Novu community will affect your fellow community members. Use appropriate channels for what you're about to say and refrain from tagging a role that sends out a lot of pings. You are strongly encouraged to take those consequences into account while making decisions.

### Adhering to these standards
## Adhering to these standards

It's crucial to keep in mind that our community members are from all kinds of backgrounds, so the members are expected to:

Expand All @@ -26,11 +26,11 @@ It's crucial to keep in mind that our community members are from all kinds of ba
- Accept responsibility and apologise to those affected by mistakes, and learn from such experiences
- Focus on what is best not just for us as individuals, but for the overall community!

### Patience
## Patience

Our community thrives on the generosity of volunteered time. Questions, contributions, and support requests may embark on a time-travelling journey before finding their destination. Repeated "bumps" or persistent "reminders" don't display patience and are looked down upon. Lastly, it is a bad practice to ask general questions to a specific person (in direct messages for example). Try to ask in public as much as you can, and patiently wait for the response

### Inclusivity, kindness and respectfulness
## Inclusivity, kindness and respectfulness

Please be courteous and respectful to fellow members. Avoid offensive comments related to age, body size, disability, ethnicity, gender identity, experience level, education, socio-economic status, nationality, personal appearance, race, religion, or sexual orientation.

Expand All @@ -42,21 +42,21 @@ Avoid assumptions about others' backgrounds. Maintain a positive and professiona

**We have zero tolerance for discrimination**. Any form of discrimination, including harassment, will lead to immediate consequences, potentially expulsion.

### Inquisitive
## Inquisitive

**_The only stupid question is the one that does not get asked_**.

We encourage our users to ask early and ask often. Rather than asking whether you can ask a question (the answer is always yes!), instead, simply ask your question. You are encouraged to provide as many specifics as possible.

Code snippets in the form of images are bad practice. Instead, use text formatted as code (using backticks) on Discord or simply send a gist. Refrain from pasting multiple lines of code directly into the chat channels - instead use [gist.github.com](http://gist.github.com/) or another paste site to provide code snippets.
Code snippets in the form of images are bad practice. Instead, use text formatted as code (using backticks) on Discord or simply send a gist. Refrain from pasting multiple lines of code directly into the chat channels - instead use [gist.github.com](https://gist.github.com/) or another paste site to provide code snippets.

### Helpful
## Helpful

Novu welcomes users of all skill levels. We were all beginners once, and a supportive environment is essential for the community to thrive. While it can be repetitive to answer the same questions, members are expected to be courteous and helpful to everyone.

Avoid sarcastic responses and prioritize useful information. Everyone should read the provided documentation. We're here to answer questions, offer guidance, and suggest workflows, but not to do your job for you.

### Anti-harassment policy
## Anti-harassment policy

Harassment includes (but is not limited to) all of the following behaviors:

Expand All @@ -74,7 +74,7 @@ Immediate compliance is expected from participants asked to cease harassing beha

Continuing inappropriate behaviour after being asked to stop constitutes harassment, even if not explicitly mentioned in this policy. It is respectful to stop doing something when asked to do so, and all community members are expected to promptly comply with such requests.

### Reporting policy violations
## Reporting policy violations

Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to anyone with administrative power in the community (Admins or Moderators on Discord, members of the 'DevRel' role), or to the local organizers of an event or to [support@novu.co](mailto:support@novu.co). Meetup organizers are encouraged to prominently display points of contact for reporting unacceptable behaviour at local events.

Expand All @@ -84,7 +84,7 @@ Organizers will be happy to help participants contact security or local law enfo

We expect all participants, organizers, speakers, and attendees to follow these policies at all of our event venues and event-related social events.

### Enforcement Guidelines
## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

Expand Down
4 changes: 2 additions & 2 deletions content/docs/community/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: "Community Overview - community documentation and contribution guide for Novu"
pageTitle: "Community"
title: 'Community Overview'
description: 'Get started and get involved with the Novu Project'
---
Expand Down Expand Up @@ -35,7 +35,7 @@ The Novu Project is our fully open source, community backed project. It is a com

Novu Cloud is our commercial service offering. It is a superset of the Novu Project that includes additional features and capabilities businesses require to succeed with notifications at scale.

[See the full list of differences between Novu Cloud and Novu.](/community/project-differences)
[See the full list of differences between Novu Cloud and Novu.](/community/self-hosted-and-novu-cloud)

## Using Novu

Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/roadmap.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: "Novu Product Roadmap — Upcoming Features"
pageTitle: "Product Roadmap"
title: 'Roadmap'
description: 'Learn about our roadmap'
---
Expand Down
Loading
Loading