Skip to content

Update Message Events.md #498

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 4, 2025
Merged

Update Message Events.md #498

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/4. Product Features/03. Flows/4. Others/Message Events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ For sending messages, the message is routed through Gupshup, to WhatsApp Busines

All messages being sent from Glific to Gupshup to WhatsApp are tracked and for each message sent, there are events returned to show the status of the message.

For the tracking to be enabled, please make sure that you have activated tracking of these events in your gupshup app. Refer [this documentation to configure the read receipts
](https://glific.github.io/docs/docs/FAQ/Read%20Receipts/)
For the tracking to be enabled, please make sure that you have activated tracking of these events in your gupshup app. Refer 26th step of [this documentation to configure the read receipts
](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup)
Comment on lines +14 to +15
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 4, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Fix link text and grammar; verify link validity.

The link text and surrounding sentence have multiple issues:

  1. Misleading link text: The text "[this documentation to configure the read receipts" still references "read receipts," but the link now points to Gupshup Setup guide, which may not be about read receipts configuration.
  2. Grammar: "Refer 26th step of [...]" is awkward; should be "Refer to step 26 of [...]" or "Refer to the 26th step of [...]".
  3. Markdown formatting: The link text appears incomplete or improperly formatted based on the linting warning (MD039).

Please update the link text to accurately describe what the Gupshup Setup guide covers (event tracking setup vs. read receipts configuration), improve the grammar, and ensure the referenced "26th step" is the correct location for event tracking configuration.

Suggested fix (pending your verification of content accuracy):

- For the tracking to be enabled, please make sure that you have activated tracking of these events in your gupshup app. Refer 26th step of [this documentation to configure the read receipts
- ](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup)
+ For the tracking to be enabled, please ensure that you have activated event tracking in your Gupshup app. Refer to [step 26 of the Gupshup Setup guide](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup) for configuration details.

Please verify:

  1. That the link URL is correct and resolves to the intended Gupshup Setup documentation
  2. That step 26 is indeed the correct reference for event tracking configuration
  3. That the updated link text accurately describes what users will find at that destination

---

🏁 Script executed:

```shell
#!/bin/bash
# Find and examine the target documentation file
find . -type f -name "Message Events.md" 2>/dev/null | head -20

Length of output: 64

🏁 Script executed:

#!/bin/bash
# Check the actual content around lines 14-15 of the file
if [ -f "docs/4. Product Features/03. Flows/4. Others/Message Events.md" ]; then
  echo "=== File content (lines 10-20) ==="
  sed -n '10,20p' "docs/4. Product Features/03. Flows/4. Others/Message Events.md"
  echo ""
  echo "=== Full file for context ==="
  cat "docs/4. Product Features/03. Flows/4. Others/Message Events.md"
fi

Length of output: 3604

🏁 Script executed:

#!/bin/bash
# Search for references to Gupshup Setup or event tracking in docs
rg -n "Gupshup Setup|event tracking" docs/ --type md -C 2

Length of output: 863

🏁 Script executed:

#!/bin/bash
# Check repo structure and type
if [ -f "README.md" ]; then
  head -50 README.md
fi

Length of output: 769

Fix misleading link text, grammar, and markdown formatting.

The link and surrounding text have three confirmed issues:

  1. Misleading link text: References "configure the read receipts" but links to the general Gupshup Setup guide (read receipts is only one of several tracked message events). Update link text to reflect actual destination.
  2. Grammar: "Refer 26th step of [...]" is awkward; change to "Refer to step 26 of [...]" or "Refer to the 26th step of [...]".
  3. Markdown formatting: Link text spans lines 14-15; keep entire link on a single line.

Update lines 14-15 to:

For the tracking to be enabled, please ensure that you have activated event tracking in your Gupshup app. Refer to [step 26 of the Gupshup Setup guide](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup) for configuration details.

Verify that step 26 in the Gupshup Setup guide indeed covers event tracking configuration before applying.

🧰 Tools
🪛 LanguageTool

[style] ~14-~14: Consider using a different verb to strengthen your wording.
Context: ... For the tracking to be enabled, please make sure that you have activated tracking of the...

(MAKE_SURE_ENSURE)

🪛 markdownlint-cli2 (0.18.1)

14-14: Spaces inside link text

(MD039, no-space-in-links)

🤖 Prompt for AI Agents 
In docs/4. Product Features/03. Flows/4. Others/Message Events.md around lines
14-15, the sentence and link are misleading and poorly formatted; replace the
text to correct grammar, make the link text reflect the actual destination (the
Gupshup Setup guide), and keep the Markdown link on a single line — e.g., change
to a sentence like "For the tracking to be enabled, please ensure that you have
activated event tracking in your Gupshup app. Refer to [step 26 of the Gupshup
Setup
guide](https://glific.github.io/docs/docs/Pre%20Onboarding/Gupshup%20Setup) for
configuration details." — also verify that step 26 actually covers event
tracking before committing.


The status of each message can be found in the `messages` table, under the `bsp_status`in the organization’s BigQuery account.

Expand Down