Skip to content

feat: add errors page #820

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
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
43 changes: 43 additions & 0 deletions content/docs/platform/additional-resources/errors.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: 'Common Errors'
description: 'Common errors and how to resolve them'
icon: 'alert-circle'
---

## Introduction

Activity feed page displays all the events that have occurred This page is useful for debugging and monitoring triggered events and notification delivery. Each event has steps and logs with each step. These logs can have errors which can be useful for debugging.

## Common errors

### Webhook URL for the chat channel is missing
Copy link
Contributor

Choose a reason for hiding this comment

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

Are those names are exactly like printed on the activity feed? Just if someone will copy and search for them

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, these are the same errors. changing this PR to draft as I have few more to add.


This error occurs when subscriber is missing chat channel provider credentials. Chat providers requires a webhook url to which notifications will be sent. Read more about [updating webhook url](/platform/integrations/chat#update-credential-webhookurl).


### All chat channels failed to send the message

Our workflow engine sends chat messages to all active chat providers. This error occurs when all chat providers have failed to send the message to all active chat providers

### Subscriber is missing a phone number

To send a sms message to user (subscriber), `phone` field is required. Above error occurs when subscriber is missing a phone number. Similar error could be `Subscriber missing recipient details` Read on [subscribers page](/platform/concepts/subscribers) on how to create and update subscriber attributes.

### Message content could not be generated

This error occurs when there are some invalid characters in the step editor content. If it is an email step, error could be **Message content could not be generated due to syntax error in email editor**. To resolve this error, please ensure that the content is valid and does not contain any invalid characters.

### Subscriber does not have an active integration

This error occurs when push or chat providers are not configured in integration store and hence subscriber is missing credentials for chat or push channel providers.

### Subscriber does not have a configured channel

This error occurs subscriber is missing credentials for chat or push channel providers. Read more on how to use [chat channel](/platform/integrations/chat) and [push channel](/platform/integrations/push)

### Novu's provider limit has been reached

Novu creates demo providers in email and sms channel for each environment. These providers have a limit of 300 emails and 20 sms per month. These providers should be used only for testing purposes. Above error occurs when these demo provider's limit has been reached.

### Bridge execution failed
If bridge url is invalid or not reachable, this error occurs.
1 change: 1 addition & 0 deletions content/docs/platform/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"sdks/server",
"---Additional Resources---",
"additional-resources/glossary",
"additional-resources/errors",
"additional-resources/limits",
"additional-resources/security",
"additional-resources/v0"
Expand Down
Loading