-
Notifications
You must be signed in to change notification settings - Fork 111
Webhook event types #1010
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Webhook event types #1010
Changes from all commits
0ab339b
31eee1e
5a59916
d6ad280
9a1d72e
c52cfa0
12d9d16
5793cdb
d625bd2
b71c3ca
332f555
2d6ed49
7437fcf
17dd1e4
20ba5b2
e7b633d
5af0d33
98a421d
bc10a7d
2a8e59c
247ff31
8026c34
fc5d1f0
a00ef20
79ebfa3
ff5afc9
8d61c45
da7fa76
867e295
e3c7367
65a1f2c
cccba8f
3fb1755
e735601
a1dfdf5
8e0704f
9d2123d
81cbbdc
72f4f3e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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):
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 |
||
|
|
||
| - `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 | ||
Aviatorscode2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - `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. | ||
Uh oh!
There was an error while loading. Please reload this page.