-
Notifications
You must be signed in to change notification settings - Fork 111
Mrk 1108 chat #1001
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: channels-providers-integration
Are you sure you want to change the base?
Mrk 1108 chat #1001
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
| The Chat channel delivers messages to your subscribers via their preferred chat platforms and application. | ||
|
|
||
| The Chat channel provides: | ||
| ## Messaging Platforms vs. Messaging Applications |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check capitalization.
| - **Cross-Platform Integration**: A single system to handle messaging platforms (e.g., Slack, Teams) and apps (e.g., WhatsApp, Telegram, Discord) | ||
| - **Scalability at Its Core**: Designed to handle high-frequency messaging without breaking a sweat | ||
| - **Effortless Configuration**: Minimal setup, maximum control over your chat notification workflows | ||
| - **Messaging Platforms** (such as Slack, Teams): Ideal for structured, workplace communication. Use these to notify teams or users in collaborative environments |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **Messaging Platforms** (such as Slack, Teams): Ideal for structured, workplace communication. Use these to notify teams or users in collaborative environments | |
| - **Messaging platforms**: Ideal for structured, workplace communication. Use these to notify teams or users in collaborative environments. Examples: Slack, Teams |
| - **Scalability at Its Core**: Designed to handle high-frequency messaging without breaking a sweat | ||
| - **Effortless Configuration**: Minimal setup, maximum control over your chat notification workflows | ||
| - **Messaging Platforms** (such as Slack, Teams): Ideal for structured, workplace communication. Use these to notify teams or users in collaborative environments | ||
| - **Messaging Apps** (such as WhatsApp, Telegram, Discord): Best for consumer-facing messaging. Engage users directly through personal or group chats |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **Messaging Apps** (such as WhatsApp, Telegram, Discord): Best for consumer-facing messaging. Engage users directly through personal or group chats | |
| - **Messaging apps**: Best for consumer-facing messaging. Engage users directly through personal or group chats. Examples: WhatsApp, Telegram, Discord |
| - **Messaging Apps** (such as WhatsApp, Telegram, Discord): Best for consumer-facing messaging. Engage users directly through personal or group chats | ||
|
|
||
| ## Key Features | ||
| ## How Chat delivery works in Novu |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is "Chat" capitalized here?
|
|
||
| ## Common Use Cases | ||
| Start by adding a chat provider in the **Integration Store** on your Novu dashboard. | ||
| You can connect one or more integrations for different or even the same providers (for example, multiple Slack workspaces). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rewrite without parentheses.
|
|
||
| ### Trigger the workflow | ||
|
|
||
| Finally, trigger the workflow from your application code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Finally, trigger the workflow from your application code. | |
| Trigger the workflow using your application code. |
| ### Trigger the workflow | ||
|
|
||
| Finally, trigger the workflow from your application code. | ||
| Novu automatically resolves the subscriber, retrieves the correct credentials (for example, the `webhookUrl`), selects the appropriate provider, renders the message, and delivers it to the chat platform. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sentence is too long, break it up. I suggest rewriting it as a list.
| ### Add a chat provider | ||
|
|
||
| ## Common Use Cases | ||
| Start by adding a chat provider in the **Integration Store** on your Novu dashboard. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You bold Integration Store here, not elsewhere later in the doc. Be consistent.
FWIW, I think it should not be bold unless it is in a step.
|
|
||
| Each provider has different requirements. | ||
|
|
||
| <Callout type="info"> See the supported chat providers list at the end of this page for detailed setup guides for each provider integration.</Callout> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| <Callout type="info"> See the supported chat providers list at the end of this page for detailed setup guides for each provider integration.</Callout> | |
| <Callout type="info"> For detailed setup guides for each provider integration, refer to the supported chat providers list at the end of this page .</Callout> |
|
|
||
| <Callout type="info"> See the supported chat providers list at the end of this page for detailed setup guides for each provider integration.</Callout> | ||
|
|
||
| ## How to manages Chat credentials |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is chat capitalized here?
No description provided.