Revise Gupshup Setup instructions and details

[SangeetaMishr]

Updated last modified date and added clarifications for account creation and API key retrieval.

Summary by CodeRabbit

• Documentation
  • Updated Gupshup Setup onboarding guide with clearer instructions to use an individual's First/Last Name.
  • Clarified webhook URLs are automatically generated after Glific connection.
  • Enhanced credential setup flow with explicit steps to copy App Name, APP ID, and API key (including how to create the key if hidden).
  • Added mandatory step to enter APP ID in Glific.
  • Added final step to update the Chatbot number via Organization settings.

[coderabbitai]

📝 Walkthrough

Walkthrough

Clarified Gupshup onboarding docs: updated metadata date, required individual first/last name for account owner, removed instruction to manually add webhook URLs (auto-generated), made App Name/APP ID/API key copying explicit (with API key creation guidance), and added final step to update the Chatbot number in Organization settings. (48 words)

Changes

Cohort / File(s)

Summary

Documentation docs/2. Pre Onboarding/02. Gupshup Setup.md

Updated "Last Updated" to April 2026. Specified that account first/last name must be an individual (managing person). Clarified step 26: webhook URLs are auto-generated after Glific connection. Replaced vague "make a note of App Name" with explicit steps to copy App Name, copy APP ID from Settings, copy/create API key. Added final instruction to update Chatbot number via Organization → Organization phone number → Update the Chatbot number.

Sequence Diagram(s)

(omitted — changes are documentation-only and do not introduce new multi-component control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• Update 02. Gupshup Setup.md #454: Overlapping edits to the same Gupshup Setup doc; touches webhook/read-receipt and onboarding steps.
• Update and rename 02. Setup an organisation on GupShup.md to 02. Gups… #433: Modifies the same Gupshup Setup.md file with related setup and metadata changes.
• Add Gupshup connection instructions to Glific #575: Related updates to "Connecting Gupshup to Glific" instructions, APP ID/API key handling, and chatbot-number guidance.

Suggested reviewers

• tanuprasad530

Poem

🐰 Hopping through pages, I tidy the trail,
Names and keys sorted, no more detail frail.
Webhooks now sprout once connections are spun,
Chatbot number set — the setup's done! 🥕✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: revising Gupshup Setup instructions with clarifications and updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch Gupshup-Setup.md

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

🚀 Deployed on https://deploy-preview-589--glific-docs.netlify.app

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

docs/2. Pre Onboarding/02. Gupshup Setup.md (1)

245-250: Consider varying sentence structure (optional).

Three consecutive bullet points begin with "Enter," which is flagged by the linter. While this is acceptable for step-by-step instructions, you could optionally vary the structure for better readability. However, the current format is clear and functional.

✨ Optional style improvement

-- Enter the Gupshup App Name (which was copied above and pasted in a notepad)
+- Paste the Gupshup App Name (which was copied above)
 
-- Enter the Gupshup API Key.
+- Add the Gupshup API Key.
 
 - Enter the APP ID

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md around lines 245 - 250, The
three consecutive bullets that start with "Enter" (for "Gupshup App Name",
"Gupshup API Key", and "APP ID") trigger the linter for repetitive sentence
starts; update the three lines to vary their sentence structure while preserving
meaning—e.g., change one to "Paste the Gupshup App Name (which was copied above
and pasted in a notepad)", another to "Provide the Gupshup API Key", and the
third to "Specify the APP ID"—so the instructions remain clear but avoid
repeating the same verb at the start of each bullet.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md:
- Line 231: The sentence in the doc contains typos: change "Scoll" to "Scroll"
and remove the duplicated "and" so the line reads correctly (e.g., update the
sentence in the section containing that sentence to "Scroll down to the same
setting page and copy the API key..." by editing the markdown text where the
current phrase appears).
- Around line 58-60: Merge the split sentence about name requirements into one
continuous line in the "4. A verification mail..." paragraph so the phrase "When
creating an account on Gupshup, the First Name and Last Name should be of an
individual person, not the organization's. Enter the name of the person who is
managing the account (e.g., the project/admin owner)" appears as a single
sentence; update the markdown in the same paragraph to remove the line break
between "project/admin" and "owner" so the formatting renders correctly.
- Around line 231-234: Remove the redundant sentence "Copy your API Key from the
app settings." that duplicates the previous instruction about copying the API
key (the duplicate line from the diff); simply delete that line and ensure the
remaining paragraph reads smoothly (adjust spacing/punctuation if needed) so
only the first instruction about copying/creating the API key remains.

---

Nitpick comments:
In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md:
- Around line 245-250: The three consecutive bullets that start with "Enter"
(for "Gupshup App Name", "Gupshup API Key", and "APP ID") trigger the linter for
repetitive sentence starts; update the three lines to vary their sentence
structure while preserving meaning—e.g., change one to "Paste the Gupshup App
Name (which was copied above and pasted in a notepad)", another to "Provide the
Gupshup API Key", and the third to "Specify the APP ID"—so the instructions
remain clear but avoid repeating the same verb at the start of each bullet.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2f0265f7-c346-4c08-bf33-b7660d640860

📥 Commits

Reviewing files that changed from the base of the PR and between 68c479a and 855846f.

📒 Files selected for processing (1)

• docs/2. Pre Onboarding/02. Gupshup Setup.md

[coderabbitai]

♻️ Duplicate comments (1)

docs/2. Pre Onboarding/02. Gupshup Setup.md (1)

58-58: ⚠️ Potential issue | 🟡 Minor

Fix punctuation/spacing in the account-owner instruction.

This sentence has awkward spacing and a missing space after the comma (Gupshup,the), which hurts readability in a critical onboarding step.

✏️ Proposed edit

-4. A verification mail will be sent on the updated email address. Please verify the link by logging into your email account. When creating an account on Gupshup,the      First Name and Last Name should be of an individual person, not the organization's. Enter the name of the person who is managing the account (e.g., the                project/admin owner)
+4. A verification mail will be sent on the updated email address. Please verify the link by logging into your email account. When creating an account on Gupshup, the First Name and Last Name should be of an individual person, not the organization's. Enter the name of the person managing the account (e.g., the project/admin owner).

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md at line 58, Fix the punctuation
and spacing in the account-owner instruction sentence: add a missing space after
the comma ("Gupshup, the"), correct spacing around commas, and rephrase for
clarity by splitting or punctuating properly so it reads like "When creating an
account on Gupshup, the First Name and Last Name should be of an individual
person, not the organization's; enter the name of the person who is managing the
account (e.g., the project/admin owner)." Update the sentence in the docs text
(the line containing "When creating an account on Gupshup,the      First Name
and Last Name...") to use the corrected spacing, punctuation, and wording.

🧹 Nitpick comments (2)

docs/2. Pre Onboarding/02. Gupshup Setup.md (2)

230-230: Split this run-on API key step for clarity.

The instruction combines multiple actions into one long sentence; splitting into short steps will reduce setup mistakes.

🧭 Proposed edit

-- Scroll down to the same setting page and copy the API key and keep it handy in a notepad, if the API key is not visible, click on create API key and the API key will be created instantly.
+- Scroll down on the same Settings page and copy the API key to a notepad.
+- If the API key is not visible, click **Create API Key**; it will be generated instantly.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md at line 230, The single run-on
instruction "Scroll down to the same setting page and copy the API key and keep
it handy in a notepad, if the API key is not visible, click on create API key
and the API key will be created instantly." should be split into discrete,
numbered or bulleted steps: 1) Scroll down to the settings page, 2) If an API
key is visible, copy it and save it to a notepad, 3) If no API key is visible,
click "Create API key", 4) After creation, copy the new API key and save it;
update the sentence in the docs to these separate short steps so each action is
clear and unambiguous.

---

242-246: Tighten repetitive field-entry bullets.

Three consecutive bullets start with “Enter…”. Small wording variation improves flow and scanability.

📝 Proposed edit

-- Enter the Gupshup App Name (which was copied above and pasted in a notepad)
-- Enter the Gupshup API Key.
-- Enter the APP ID
+- Paste the Gupshup App Name (copied above).
+- Add the Gupshup API Key.
+- Add the App ID.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md around lines 242 - 246, Replace
the three repetitive bullets that all begin with "Enter..." with varied phrasing
or a combined line to improve readability: update the bullets for the Gupshup
App Name, Gupshup API Key and APP ID so one reads e.g. "Paste the Gupshup App
Name (copied earlier) into your notepad" and the others use different verbs such
as "Provide the Gupshup API Key" and "Specify the APP ID", or merge them into a
single sentence like "Provide the Gupshup App Name, API Key, and APP ID" to
reduce repetition and improve scanability.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md:
- Line 58: Fix the punctuation and spacing in the account-owner instruction
sentence: add a missing space after the comma ("Gupshup, the"), correct spacing
around commas, and rephrase for clarity by splitting or punctuating properly so
it reads like "When creating an account on Gupshup, the First Name and Last Name
should be of an individual person, not the organization's; enter the name of the
person who is managing the account (e.g., the project/admin owner)." Update the
sentence in the docs text (the line containing "When creating an account on
Gupshup,the      First Name and Last Name...") to use the corrected spacing,
punctuation, and wording.

---

Nitpick comments:
In `@docs/2`. Pre Onboarding/02. Gupshup Setup.md:
- Line 230: The single run-on instruction "Scroll down to the same setting page
and copy the API key and keep it handy in a notepad, if the API key is not
visible, click on create API key and the API key will be created instantly."
should be split into discrete, numbered or bulleted steps: 1) Scroll down to the
settings page, 2) If an API key is visible, copy it and save it to a notepad, 3)
If no API key is visible, click "Create API key", 4) After creation, copy the
new API key and save it; update the sentence in the docs to these separate short
steps so each action is clear and unambiguous.
- Around line 242-246: Replace the three repetitive bullets that all begin with
"Enter..." with varied phrasing or a combined line to improve readability:
update the bullets for the Gupshup App Name, Gupshup API Key and APP ID so one
reads e.g. "Paste the Gupshup App Name (copied earlier) into your notepad" and
the others use different verbs such as "Provide the Gupshup API Key" and
"Specify the APP ID", or merge them into a single sentence like "Provide the
Gupshup App Name, API Key, and APP ID" to reduce repetition and improve
scanability.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4ff980c1-dcef-4ad4-84fe-6415aaaf451a

📥 Commits

Reviewing files that changed from the base of the PR and between 855846f and bd7ac40.

📒 Files selected for processing (1)

• docs/2. Pre Onboarding/02. Gupshup Setup.md