Skip to content
This repository was archived by the owner on Jun 26, 2026. It is now read-only.

docs(webhooks): enhance message event documentation and clarify email activity tracking - #1132

Draft
jainpawan21 wants to merge 1 commit into
mainfrom
DOC-362
Draft

docs(webhooks): enhance message event documentation and clarify email activity tracking#1132
jainpawan21 wants to merge 1 commit into
mainfrom
DOC-362

docs(webhooks): enhance message event documentation and clarify email…

958af78
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
GitHub Actions / vale completed Jun 20, 2026 in 2s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (123)

content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|41 col 3| [write-good.TooWordy] 'Multiple' is too wordy.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|63 col 23| [write-good.E-Prime] Try to avoid using 'be'.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|63 col 23| [write-good.Passive] 'be posted' may be passive voice. Use active voice if you can.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|63 col 23| [Google.Passive] In general, use active voice instead of passive voice ('be posted').
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|65 col 70| [Google.Parens] Use parentheses judiciously.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|84 col 47| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|87 col 56| [write-good.Passive] 'been enabled' may be passive voice. Use active voice if you can.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|87 col 56| [Google.Passive] In general, use active voice instead of passive voice ('been enabled').
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|87 col 56| [write-good.E-Prime] Try to avoid using 'been'.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|87 col 98| [Google.Passive] In general, use active voice instead of passive voice ('be displayed').
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|87 col 98| [write-good.E-Prime] Try to avoid using 'be'.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|87 col 98| [write-good.Passive] 'be displayed' may be passive voice. Use active voice if you can.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|95 col 27| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|97 col 1| [Novu.HeadingContext] Add a sentence introducing this section before the next heading.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|99 col 5| [Google.Headings] 'Opens appear in SendGrid but not in Novu' should use sentence-style capitalization.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|101 col 1| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 26.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|101 col 69| [Google.Parens] Use parentheses judiciously.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|101 col 92| [Google.Contractions] Use 'doesn't' instead of 'does not'.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|104 col 26| [write-good.Passive] 'are listed' may be passive voice. Use active voice if you can.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|104 col 26| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|104 col 26| [Google.Passive] In general, use active voice instead of passive voice ('are listed').
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|105 col 21| [Google.Passive] In general, use active voice instead of passive voice ('is enabled').
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|105 col 21| [write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|105 col 21| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|105 col 51| [write-good.Passive] 'be posted' may be passive voice. Use active voice if you can.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|105 col 51| [Google.Passive] In general, use active voice instead of passive voice ('be posted').
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|105 col 51| [write-good.E-Prime] Try to avoid using 'be'.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|105 col 84| [Google.Parens] Use parentheses judiciously.
content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx|108 col 68| [Google.Contractions] Use 'doesn't' instead of 'does not'.
content/docs/platform/integrations/email/activity-tracking/index.mdx|31 col 43| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/platform/integrations/email/activity-tracking/index.mdx|33 col 32| [Google.Parens] Use parentheses judiciously.
content/docs/platform/integrations/email/activity-tracking/index.mdx|33 col 44| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/integrations/email/activity-tracking/index.mdx|34 col 57| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/integrations/email/activity-tracking/index.mdx|36 col 33| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/integrations/email/activity-tracking/index.mdx|36 col 33| [Google.Contractions] Use 'isn't' instead of 'is not'.
content/docs/platform/integrations/email/activity-tracking/index.mdx|145 col 1| [Google.Parens] Use parentheses judiciously.
content/docs/platform/integrations/email/activity-tracking/index.mdx|147 col 57| [Google.Passive] In general, use active voice instead of passive voice ('are enabled').
content/docs/platform/integrations/email/activity-tracking/index.mdx|147 col 57| [write-good.Passive] 'are enabled' may be passive voice. Use active voice if you can.
content/docs/platform/integrations/email/activity-tracking/index.mdx|147 col 57| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/platform/integrations/email/activity-tracking/index.mdx|151 col 18| [Google.Parens] Use parentheses judiciously.
content/docs/platform/integrations/email/activity-tracking/index.mdx|158 col 86| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 27.
content/docs/platform/integrations/email/activity-tracking/index.mdx|160 col 51| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/platform/developer/webhooks/webhooks.mdx|8 col 11| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/webhooks.mdx|10 col 1| [Novu.BulletStyle] Prefer '' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/webhooks.mdx|10 col 52| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/developer/webhooks/webhooks.mdx|11 col 1| [Novu.BulletStyle] Prefer '
' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/webhooks.mdx|11 col 58| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/developer/webhooks/event-types.mdx|20 col 29| [Google.Passive] In general, use active voice instead of passive voice ('is triggered').
content/docs/platform/developer/webhooks/event-types.mdx|20 col 29| [write-good.Passive] 'is triggered' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|20 col 29| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/event-types.mdx|20 col 96| [Google.Semicolons] Use semicolons judiciously.
content/docs/platform/developer/webhooks/event-types.mdx|25 col 34| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/event-types.mdx|25 col 102| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/developer/webhooks/event-types.mdx|26 col 1| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/event-types.mdx|27 col 1| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/event-types.mdx|32 col 1| [Novu.BulletStyle] Prefer '' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/event-types.mdx|33 col 1| [Novu.BulletStyle] Prefer '
' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/event-types.mdx|33 col 203| [write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|33 col 203| [Google.Passive] In general, use active voice instead of passive voice ('is enabled').
content/docs/platform/developer/webhooks/event-types.mdx|33 col 203| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/event-types.mdx|35 col 53| [Google.Contractions] Use 'doesn't' instead of 'does not'.
content/docs/platform/developer/webhooks/event-types.mdx|35 col 93| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/event-types.mdx|35 col 93| [write-good.Passive] 'is configured' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|35 col 93| [Google.Passive] In general, use active voice instead of passive voice ('is configured').
content/docs/platform/developer/webhooks/event-types.mdx|41 col 1| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/event-types.mdx|41 col 1| [Novu.BulletStyle] Prefer '' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/event-types.mdx|41 col 37| [Google.Passive] In general, use active voice instead of passive voice ('is triggered').
content/docs/platform/developer/webhooks/event-types.mdx|41 col 37| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/event-types.mdx|41 col 37| [write-good.Passive] 'is triggered' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|41 col 96| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/platform/developer/webhooks/event-types.mdx|41 col 96| [Google.Passive] In general, use active voice instead of passive voice ('was delivered').
content/docs/platform/developer/webhooks/event-types.mdx|41 col 96| [write-good.Passive] 'was delivered' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|42 col 1| [Novu.BulletStyle] Prefer '
' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/event-types.mdx|42 col 34| [Google.Passive] In general, use active voice instead of passive voice ('is triggered').
content/docs/platform/developer/webhooks/event-types.mdx|42 col 34| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/event-types.mdx|42 col 34| [write-good.Passive] 'is triggered' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|42 col 154| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/event-types.mdx|43 col 1| [Novu.BulletStyle] Prefer '' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/event-types.mdx|43 col 32| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/event-types.mdx|43 col 32| [write-good.Passive] 'is triggered' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|43 col 32| [Google.Passive] In general, use active voice instead of passive voice ('is triggered').
content/docs/platform/developer/webhooks/event-types.mdx|43 col 64| [Google.Passive] In general, use active voice instead of passive voice ('been read').
content/docs/platform/developer/webhooks/event-types.mdx|43 col 64| [write-good.Passive] 'been read' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|43 col 64| [write-good.E-Prime] Try to avoid using 'been'.
content/docs/platform/developer/webhooks/event-types.mdx|43 col 92| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/event-types.mdx|44 col 1| [Novu.BulletStyle] Prefer '
' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/event-types.mdx|44 col 1| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/event-types.mdx|44 col 32| [write-good.Passive] 'is triggered' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|44 col 32| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/event-types.mdx|44 col 32| [Google.Passive] In general, use active voice instead of passive voice ('is triggered').
content/docs/platform/developer/webhooks/event-types.mdx|44 col 60| [write-good.Passive] 'is opened' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|44 col 60| [Google.Passive] In general, use active voice instead of passive voice ('is opened').
content/docs/platform/developer/webhooks/event-types.mdx|44 col 134| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/platform/developer/webhooks/event-types.mdx|44 col 134| [write-good.Passive] 'are forwarded' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/event-types.mdx|44 col 134| [Google.Passive] In general, use active voice instead of passive voice ('are forwarded').
content/docs/platform/developer/webhooks/event-types.mdx|44 col 165| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/developer/webhooks/event-types.mdx|45 col 1| [Novu.BulletStyle] Prefer '' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/event-types.mdx|45 col 32| [Google.Passive] In general, use active voice instead of passive voice ('is triggered').
content/docs/platform/developer/webhooks/event-types.mdx|45 col 32| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/event-types.mdx|45 col 32| [write-good.Passive] 'is triggered' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/index.mdx|194 col 11| [Google.FirstPerson] Avoid first-person pronouns such as ' I '.
content/docs/platform/developer/webhooks/index.mdx|198 col 1| [Novu.BulletStyle] Prefer '
' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/index.mdx|198 col 21| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/developer/webhooks/index.mdx|198 col 73| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/index.mdx|198 col 103| [Google.Contractions] Use 'doesn't' instead of 'does not'.
content/docs/platform/developer/webhooks/index.mdx|199 col 1| [Novu.BulletStyle] Prefer '' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/index.mdx|199 col 26| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/developer/webhooks/index.mdx|200 col 1| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/index.mdx|200 col 1| [Novu.BulletStyle] Prefer '
' over '-' for bullet points (ignore inside code fences).
content/docs/platform/developer/webhooks/index.mdx|200 col 21| [Google.EmDash] Don't put a space before or after a dash.
content/docs/platform/developer/webhooks/index.mdx|200 col 79| [Google.Passive] In general, use active voice instead of passive voice ('are forwarded').
content/docs/platform/developer/webhooks/index.mdx|200 col 79| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/platform/developer/webhooks/index.mdx|200 col 79| [write-good.Passive] 'are forwarded' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/index.mdx|204 col 5| [Google.FirstPerson] Avoid first-person pronouns such as 'I '.
content/docs/platform/developer/webhooks/index.mdx|206 col 40| [write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/index.mdx|206 col 40| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/index.mdx|206 col 40| [Google.Passive] In general, use active voice instead of passive voice ('is enabled').
content/docs/platform/developer/webhooks/index.mdx|207 col 1| [Google.Parens] Use parentheses judiciously.
content/docs/platform/developer/webhooks/index.mdx|207 col 35| [Google.Passive] In general, use active voice instead of passive voice ('is subscribed').
content/docs/platform/developer/webhooks/index.mdx|207 col 35| [write-good.Passive] 'is subscribed' may be passive voice. Use active voice if you can.
content/docs/platform/developer/webhooks/index.mdx|207 col 35| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/platform/developer/webhooks/index.mdx|208 col 176| [write-good.E-Prime] Try to avoid using 'were'.
content/docs/platform/developer/webhooks/index.mdx|209 col 16| [write-good.TooWordy] 'multiple' is too wordy.

Filtered Findings (13728)

content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/create-a-channel-endpoint.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/list-all-channel-endpoints.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/update-a-channel-endpoint.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/retrieve-a-channel-endpoint.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/channel-endpoints/delete-a-channel-endpoint.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/list-all-variables.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/list-all-variables.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/list-all-variables.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/list-all-variables.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/list-all-variables.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/delete-a-variable.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/delete-a-variable.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/delete-a-variable.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/delete-a-variable.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/delete-a-variable.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/environment-variable-schema.model.mdx|7 col 5| [Google.Headings] 'Environment Variable' should use sentence-style capitalization.
content/docs/api-reference/environment-variables/environment-variable-schema.model.mdx|9 col 22| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/environment-variables/environment-variable-schema.model.mdx|9 col 100| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 26.
content/docs/api-reference/environment-variables/environment-variable-schema.model.mdx|9 col 234| [Google.Parens] Use parentheses judiciously.
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/retrieve-a-variable-usage.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/retrieve-a-variable.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/create-a-variable.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/create-a-variable.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/create-a-variable.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/create-a-variable.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/create-a-variable.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/update-a-variable.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environment-variables/update-a-variable.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environment-variables/update-a-variable.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environment-variables/update-a-variable.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environment-variables/update-a-variable.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|7 col 5| [Google.Headings] 'Environment Variable' should use sentence-style capitalization.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|9 col 22| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|9 col 100| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 26.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|9 col 234| [Google.Parens] Use parentheses judiciously.
content/docs/api-reference/environment-variables/environment-variable-schema.mdx|11 col 2| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 36.
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/publish-resources-to-target-environment.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/list-all-environments.mdx|18 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/list-all-environments.mdx|18 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/list-all-environments.mdx|18 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/list-all-environments.mdx|18 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/list-all-environments.mdx|20 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/update-an-environment.mdx|18 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/update-an-environment.mdx|18 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/update-an-environment.mdx|18 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/update-an-environment.mdx|18 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/update-an-environment.mdx|20 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/list-environment-tags.mdx|16 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/list-environment-tags.mdx|16 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/list-environment-tags.mdx|16 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/list-environment-tags.mdx|16 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/list-environment-tags.mdx|18 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/create-an-environment.mdx|19 col 15| [write-good.E-Prime] Try to avoid using 'was'.
content/docs/api-reference/environments/create-an-environment.mdx|19 col 15| [Google.Passive] In general, use active voice instead of passive voice ('was generated').
content/docs/api-reference/environments/create-an-environment.mdx|19 col 15| [write-good.Passive] 'was generated' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/create-an-environment.mdx|19 col 60| [Google.Contractions] Use 'don't' instead of 'Do not'.
content/docs/api-reference/environments/create-an-environment.mdx|21 col 75| [Google.Quotes] Commas and periods go inside quotation marks.
content/docs/api-reference/environments/environment-schema.mdx|9 col 13| [write-good.E-Prime] Try to avoid using 'is'.
content/docs/api-reference/environments/environment-schema.mdx|9 col 47| [write-good.E-Prime] Try to avoid using 'are'.
content/docs/api-reference/environments/environment-schema.mdx|9 col 47| [Google.Passive] In general, use active voice instead of passive voice ('are used').
content/docs/api-reference/environments/environment-schema.mdx|9 col 47| [write-good.Passive] 'are used' may be passive voice. Use active voice if you can.
content/docs/api-reference/environments/environment-schema.mdx|11 col 2| [Novu.SentenceLength] Sentences should not exceed 25 words; this one has 77.
... (Too many findings. Dropped some findings)

Annotations

Check warning on line 41 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L41

[write-good.TooWordy] 'Multiple' is too wordy.
Raw output
{"message": "[write-good.TooWordy] 'Multiple' is too wordy.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 41, "column": 3}}}, "severity": "WARNING"}

Check notice on line 63 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L63

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 63, "column": 23}}}, "severity": "INFO"}

Check warning on line 63 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L63

[write-good.Passive] 'be posted' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be posted' may be passive voice. Use active voice if you can.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 63, "column": 23}}}, "severity": "WARNING"}

Check notice on line 63 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L63

[Google.Passive] In general, use active voice instead of passive voice ('be posted').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be posted').", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 63, "column": 23}}}, "severity": "INFO"}

Check notice on line 65 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L65

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 65, "column": 70}}}, "severity": "INFO"}

Check failure on line 84 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L84

[Google.EmDash] Don't put a space before or after a dash.
Raw output
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 84, "column": 47}}}, "severity": "ERROR"}

Check warning on line 87 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L87

[write-good.Passive] 'been enabled' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'been enabled' may be passive voice. Use active voice if you can.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 87, "column": 56}}}, "severity": "WARNING"}

Check notice on line 87 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L87

[Google.Passive] In general, use active voice instead of passive voice ('been enabled').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('been enabled').", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 87, "column": 56}}}, "severity": "INFO"}

Check notice on line 87 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L87

[write-good.E-Prime] Try to avoid using 'been'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'been'.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 87, "column": 56}}}, "severity": "INFO"}

Check notice on line 87 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L87

[Google.Passive] In general, use active voice instead of passive voice ('be displayed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('be displayed').", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 87, "column": 98}}}, "severity": "INFO"}

Check notice on line 87 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L87

[write-good.E-Prime] Try to avoid using 'be'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 87, "column": 98}}}, "severity": "INFO"}

Check warning on line 87 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L87

[write-good.Passive] 'be displayed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be displayed' may be passive voice. Use active voice if you can.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 87, "column": 98}}}, "severity": "WARNING"}

Check notice on line 95 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L95

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 95, "column": 27}}}, "severity": "INFO"}

Check warning on line 97 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L97

[Novu.HeadingContext] Add a sentence introducing this section before the next heading.
Raw output
{"message": "[Novu.HeadingContext] Add a sentence introducing this section before the next heading.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 97, "column": 1}}}, "severity": "WARNING"}

Check warning on line 99 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L99

[Google.Headings] 'Opens appear in SendGrid but not in Novu' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Opens appear in SendGrid but not in Novu' should use sentence-style capitalization.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 99, "column": 5}}}, "severity": "WARNING"}

Check warning on line 101 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L101

[Novu.SentenceLength] Sentences should not exceed 25 words; this one has 26.
Raw output
{"message": "[Novu.SentenceLength] Sentences should not exceed 25 words; this one has 26.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 101, "column": 1}}}, "severity": "WARNING"}

Check notice on line 101 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L101

[Google.Parens] Use parentheses judiciously.
Raw output
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 101, "column": 69}}}, "severity": "INFO"}

Check notice on line 101 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L101

[Google.Contractions] Use 'doesn't' instead of 'does not'.
Raw output
{"message": "[Google.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 101, "column": 92}}}, "severity": "INFO"}

Check warning on line 104 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L104

[write-good.Passive] 'are listed' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'are listed' may be passive voice. Use active voice if you can.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 104, "column": 26}}}, "severity": "WARNING"}

Check notice on line 104 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L104

[write-good.E-Prime] Try to avoid using 'are'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'are'.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 104, "column": 26}}}, "severity": "INFO"}

Check notice on line 104 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L104

[Google.Passive] In general, use active voice instead of passive voice ('are listed').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are listed').", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 104, "column": 26}}}, "severity": "INFO"}

Check notice on line 105 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L105

[Google.Passive] In general, use active voice instead of passive voice ('is enabled').
Raw output
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is enabled').", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 105, "column": 21}}}, "severity": "INFO"}

Check warning on line 105 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L105

[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'is enabled' may be passive voice. Use active voice if you can.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 105, "column": 21}}}, "severity": "WARNING"}

Check notice on line 105 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L105

[write-good.E-Prime] Try to avoid using 'is'.
Raw output
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 105, "column": 21}}}, "severity": "INFO"}

Check warning on line 105 in content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx#L105

[write-good.Passive] 'be posted' may be passive voice. Use active voice if you can.
Raw output
{"message": "[write-good.Passive] 'be posted' may be passive voice. Use active voice if you can.", "location": {"path": "content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx", "range": {"start": {"line": 105, "column": 51}}}, "severity": "WARNING"}