Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
0ab339b
Update content for environments page
Aviatorscode2 Nov 15, 2025
31eee1e
Add new changes
Aviatorscode2 Nov 15, 2025
5a59916
File structure
Aviatorscode2 Nov 19, 2025
d6ad280
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Nov 19, 2025
9a1d72e
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Nov 19, 2025
c52cfa0
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Nov 19, 2025
12d9d16
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Nov 19, 2025
5793cdb
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Nov 19, 2025
d625bd2
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Nov 19, 2025
b71c3ca
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Nov 19, 2025
332f555
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Nov 19, 2025
2d6ed49
Merge branch 'MRK-1137' of https://github.com/novuhq/docs into MRK-1137
Aviatorscode2 Nov 19, 2025
7437fcf
Revert "File structure"
Aviatorscode2 Nov 19, 2025
17dd1e4
Create content for the webhooks page
Aviatorscode2 Nov 20, 2025
20ba5b2
content for event types
Aviatorscode2 Nov 21, 2025
e7b633d
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Nov 24, 2025
5af0d33
Fixed comment from Diana
Aviatorscode2 Nov 24, 2025
98a421d
Merge branch 'webhook-event-types' of https://github.com/novuhq/docs …
Aviatorscode2 Nov 24, 2025
bc10a7d
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
2a8e59c
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Dec 4, 2025
247ff31
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
8026c34
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Dec 4, 2025
fc5d1f0
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Dec 4, 2025
a00ef20
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
79ebfa3
Update content/docs/platform/developer/environments.mdx
Aviatorscode2 Dec 4, 2025
ff5afc9
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
8d61c45
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
da7fa76
Merge branch 'main' into webhook-event-types
Aviatorscode2 Dec 4, 2025
867e295
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
e3c7367
Update content/docs/platform/developer/webhooks/event-types.mdx
Aviatorscode2 Dec 4, 2025
65a1f2c
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
cccba8f
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
3fb1755
Uodate based on feedback
Aviatorscode2 Dec 4, 2025
e735601
Merge branch 'webhook-event-types' of https://github.com/novuhq/docs …
Aviatorscode2 Dec 4, 2025
a1dfdf5
Update content
Aviatorscode2 Dec 4, 2025
8e0704f
Fix issues
Aviatorscode2 Dec 4, 2025
9d2123d
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
81cbbdc
Update content/docs/platform/developer/webhooks/index.mdx
Aviatorscode2 Dec 4, 2025
72f4f3e
Merge branch 'main' into webhook-event-types
Aviatorscode2 Dec 4, 2025
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
10 changes: 4 additions & 6 deletions content/docs/platform/developer/environments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,14 @@ description: 'Understanding and managing environments in Novu'
icon: 'GitFork'
---

Novu uses environments to separate your workflows and it's data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment.
Novu uses environments to separate your workflows and its data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment.

## Types of environments

When you create a Novu account, you are provided with a development and production environment by default. You can also create custom environments (on certain plans) to match your team’s workflow.
When you create a Novu account, you are provided with a development and production environment by default. On certain plans, you can also create custom environments to match your team’s workflow.

- **Development environment**: Use the development environment to build and test new workflows, layouts, translations, and experiment with different configurations before publishing to other environments.

- **Production environment**: The production environment is used to send notifications to your subscribers. To ensure stability and prevent unintended changes, this environment is view-only for workflows, layouts, and translations. Changes are not made here directly, they are made from the development environment and then published to production.

- **Production environment**: The production environment is used to send notifications to your subscribers. To ensure stability and prevent unintended changes, this environment is view-only for workflows, layouts, and translations. Changes are not made here directly, they are made from other environment and then published to this production environment.
- **Custom environment**: Custom environments are only available on <a href="https://novu.co/pricing" target="_blank" rel="noopener noreferrer">Team and Enterprise plans</a>. You can use them to reflect your release process, for example, staging or QA.

## Create a custom environment
Expand Down Expand Up @@ -70,7 +68,7 @@ Each environment has two unique identifiers:

<Callout>Configure these credentials in your application based on the active environment, similar to how you manage other service credentials.</Callout>

## Publishing changes to other environments
## Publish changes to other environments

Novu provides a publish mechanism that allows you to promote changes from your development environment to production or other custom environments. This process ensures that all changes are deliberate, reviewed, and deployed in a controlled manner.

Expand Down
37 changes: 37 additions & 0 deletions content/docs/platform/developer/webhooks/event-types.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: 'Event types'
pageTitle: 'Webhooks event types'
description: 'Learn more about the types of events that Novu sends webhook events for.'
---

Novu supports the following webhook event types:

- **Message events**: Events about message delivery status changes.
- **Preference event**: Event about subscriber preference changes.
- **Workflow events**: Events about workflow creation, updates, and deletions.

Each event includes detailed information about the affected resource and the changes that occurred.

## Message events
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Reorder event type sections to match intro list order.

Per past review feedback, the event type sections should appear in the same order as the introductory list (lines 9–11):

  1. Workflow events
  2. Message events
  3. Preference events

Currently, they are ordered: Message (line 15), Preference (line 57), Workflow (line 63). Reorder the sections to match the introduction for better document flow and user expectations.

Consider also adding a brief introductory sentence before each event category section to provide context, reducing the "stacked heading" effect that the PR author flagged.

Also applies to: 57-57, 63-63

🤖 Prompt for AI Agents
In content/docs/platform/developer/webhooks/event-types.mdx around lines 15, 57
and 63, the three event category sections are out of order (currently Message at
15, Preference at 57, Workflow at 63) and should be reordered to match the intro
list order (Workflow, Message, Preference); move the Workflow section to appear
first, then Message, then Preference, and add a one-sentence intro paragraph
before each category heading to provide context and reduce the stacked-heading
effect.


- `message.archived`: This webhook is triggered when a subscriber archives a message. The payload contains the details of the event.
- `message.delivered`: This webhook is triggered when a message delivery provider acknowledged the message delivery to the end receiving client. The payload contains the details of the event.
- `message.failed`: This webhook is triggered when Novu tries to send the message to the delivery provider and it got failed. The payload contains the details of the event.
- `message.read`: This webhook is triggered when a message has been read by the subscriber. The payload contains the details of the event.
- `message.seen`: This webhook is triggered when a subscriber opens a message. The payload contains the details of the event.
- `message.sent`: This webhook is triggered when Novu sends the message to the delivery provider. The payload contains the details of the event.
- `message.snoozed`: This webhook is triggered when a message is snoozed by the subscriber. The payload contains the details of the event.
- `message.unarchived`: This webhook is triggered when an archived message is unarchived. The payload contains the details of the event.
- `message.unread`: This webhook is triggered when a message is unread or marked as unread by the subscriber. The payload contains the details of the event.
- `message.unsnoozed`: This webhook is triggered when a message is unsnoozed by a subscriber. The payload contains the details of the event.

## Preference event

- `preference.updated`: This webhook is triggered when a subscriber preference is updated. The payload contains the details of the event.

## Workflow events

- `workflow.created`: This webhook is triggered when a workflow is created. The payload contains the details of the event.
- `workflow.deleted`: This webhook is triggered when a workflow is deleted. The payload contains the details of the event.
- `workflow.published`: This webhook is triggered when a `workflow` event occurs, that is when a workflow is synced from dev to prod environment. The payload contains the details of the event.
- `workflow.updated`: This webhook is triggered when a workflow is updated. The payload contains the details of the event.
Loading