Skip to content

Comments

Revise WhatsApp Forms documentation and update details#578

Open
mahajantejas wants to merge 2 commits intomainfrom
whatsapp-forms-phase2
Open

Revise WhatsApp Forms documentation and update details#578
mahajantejas wants to merge 2 commits intomainfrom
whatsapp-forms-phase2

Conversation

@mahajantejas
Copy link
Collaborator

@mahajantejas mahajantejas commented Feb 24, 2026

Updated the last updated date and modified the steps for creating WhatsApp forms, including new instructions for data storage and form submission based on the forms phase 2 implementation

Summary by CodeRabbit

  • Documentation
    • Updated WhatsApp Forms guide with simplified creation workflow and "Last updated" timestamp
    • Added comprehensive Form Builder docs, field terminology, previews, and lifecycle states (draft/published/deactivated)
    • Clarified form content types, Option IDs, multilingual handling, and Google Sheets optional data storage
    • Included form creation checklist, updated sending guidance, refreshed imagery, and removed embedded previews/iframes

Updated the last updated date and modified the steps for creating WhatsApp forms, including new instructions for data storage and form submission based on the forms phase 2 implementation
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 24, 2026

📝 Walkthrough

Walkthrough

This pull request updates the WhatsApp Forms documentation: streamlines the creation flow to emphasize the Form Builder, removes iframe-based publishing steps and Meta Playground references, expands Form Builder details (field types, naming, Option Ids, multilingual notes), adds checklist and lifecycle guidance, and updates the timestamp to February 2026.

Changes

Cohort / File(s) Summary
WhatsApp Forms Documentation
docs/4. Product Features/WhatsApp Forms.md
Reworked creation/publishing flow to use the Form Builder; removed iframe embeds and Meta Playground steps; added detailed Form Builder section (Form JSON, Save Draft, Submit to Meta), field types, Option Ids, multilingual guidance, lifecycle states, and a form creation checklist; updated "Last updated" to February 2026.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • SangeetaMishr
  • Fawas003

Poem

🐰 I hopped through docs with tidy charms,
Replaced old iframes with clearer arms,
Builder fields now sing in ordered rows,
Option Ids and locales where the wisdom grows,
A little carrot-coded cheer — forms bloom here! 🥕✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Revise WhatsApp Forms documentation and update details' is somewhat generic and vague—'update details' lacks specificity about what changes were made. Consider a more specific title like 'Update WhatsApp Forms documentation for phase 2 implementation' to clarify the scope and intent of the changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch whatsapp-forms-phase2

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

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

@github-actions
Copy link

github-actions bot commented Feb 24, 2026

@github-actions github-actions bot temporarily deployed to pull request February 24, 2026 11:37 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 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/4`. Product Features/WhatsApp Forms.md:
- Line 46: The document uses the lowercase proper noun "google" in phrases like
"google sheet" and "google service account" (e.g., the text "add a `google
sheet` with write access to the google service account"); update these
occurrences to use the correct capitalization "Google" (e.g., "Google Sheet",
"Google service account") consistently throughout the file, including the
instances referenced at lines 46, 96, and 128.
- Around line 55-58: The doc uses two different lifecycle terms—“Submit to Meta”
(button/step label) and “published” (descriptive state); pick one term and make
it consistent across the guide and FAQs (replace occurrences of “published” with
“Submit to Meta” or vice versa), update the Form Features section lines
referencing the final step (e.g., the “Submit to Meta” button text) and the
FAQ/other sections (previously lines ~223-226 and ~239-245) so they use the
chosen term consistently, and keep the immutability note (“once the form is
submitted to meta, it cannot be changed further”) aligned to the chosen
terminology.
- Around line 42-48: The ordered step lists in WhatsApp Forms.md have skipped
numbers (e.g., 1,2,3,4,6) which breaks continuity; update each "Steps:" ordered
list so numbering is sequential and continuous (e.g., change the block that
currently reads 1,2,3,4,6 to 1,2,3,4,5) and repeat the same fix for the other
occurrences referenced (the lists around lines 61-65 and 154-156); ensure every
"Steps:" section and its items are renumbered to a consecutive sequence without
gaps so users can follow instructions linearly.
- Line 121: The emphasis contains trailing spaces ("**Implications of the id
**"); remove the extra space inside the bold markers so the text reads
"**Implications of the id**" to satisfy markdownlint MD037 and render correctly;
update the heading in the WhatsApp Forms document where the string "Implications
of the id **" appears.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5d1dec and 8d4eea4.

📒 Files selected for processing (1)
  • docs/4. Product Features/WhatsApp Forms.md

Comment on lines 42 to +48
Steps:
1. Go to `Quick Tools` → `WhatsApp Forms` in Glific.
2. Click `Create Form`
3. Go to WhatsApp Flows Playground to get a friendly interface to create your form
4. Choose field types and design your form (text input, radio, multi-select, etc.)
5. Click on `copy flow JSON` after completing the form design
6. Paste the Flow JSON into the `form JSON` input field
7. Give your form an appropriate `title`, `description` and `category`
8. Click on `Save`
9. This creates a draft of the form
10. On the `WhatsApp Forms` Listing page, click on the publish icon to publish the form.
2. Click `Create` Form
3. Provide a form `title` and `category`
4. For data storage, add a `google sheet` with write access to the google service account to automatically capture the responses to the form. This step is optional. A google sheet can be added before the form is `submitted to Meta`
6. Click on Save and go to the form builder interface
<img width="568" height="386" alt="Screenshot 2026-02-24 at 3 51 24 PM" src="https://github.com/user-attachments/assets/15e81cc8-0da5-43a0-95fd-298177bb567a" />
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix broken step numbering.

There are skipped numbers in multiple step lists (e.g., 4→6, 2→4, 1→3), which makes the instructions hard to follow. Please renumber for continuity.

Also applies to: 61-65, 154-156

🧰 Tools
🪛 LanguageTool

[uncategorized] ~46-~46: “Google” is a proper noun and needs to be capitalized.
Context: ...google sheet with write access to the google service account to automatically captur...

(A_GOOGLE)


[uncategorized] ~46-~46: “Google” is a proper noun and needs to be capitalized.
Context: ...s to the form. This step is optional. A google sheet can be added before the form is `...

(A_GOOGLE)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md around lines 42 - 48, The ordered
step lists in WhatsApp Forms.md have skipped numbers (e.g., 1,2,3,4,6) which
breaks continuity; update each "Steps:" ordered list so numbering is sequential
and continuous (e.g., change the block that currently reads 1,2,3,4,6 to
1,2,3,4,5) and repeat the same fix for the other occurrences referenced (the
lists around lines 61-65 and 154-156); ensure every "Steps:" section and its
items are renumbered to a consecutive sequence without gaps so users can follow
instructions linearly.

10. On the `WhatsApp Forms` Listing page, click on the publish icon to publish the form.
2. Click `Create` Form
3. Provide a form `title` and `category`
4. For data storage, add a `google sheet` with write access to the google service account to automatically capture the responses to the form. This step is optional. A google sheet can be added before the form is `submitted to Meta`
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Capitalize “Google” consistently.

Multiple instances use “google” in running text. Please capitalize the proper noun.

Also applies to: 96-96, 128-128

🧰 Tools
🪛 LanguageTool

[uncategorized] ~46-~46: “Google” is a proper noun and needs to be capitalized.
Context: ...google sheet with write access to the google service account to automatically captur...

(A_GOOGLE)


[uncategorized] ~46-~46: “Google” is a proper noun and needs to be capitalized.
Context: ...s to the form. This step is optional. A google sheet can be added before the form is `...

(A_GOOGLE)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md at line 46, The document uses the
lowercase proper noun "google" in phrases like "google sheet" and "google
service account" (e.g., the text "add a `google sheet` with write access to the
google service account"); update these occurrences to use the correct
capitalization "Google" (e.g., "Google Sheet", "Google service account")
consistently throughout the file, including the instances referenced at lines
46, 96, and 128.

Comment on lines +55 to +58
1. Form Json - this allows you to toggle to the from json view, and edit things in the form json as it gets developed by adding screens and components from
2. Save Draft - while the changes being made are auto-saved, this button is provided as a back-up.
3. Submit to Meta - this is the final step of form creation. Click on `Submit to meta` once the form is ready to be used by over WhatsApp. Please note: once the form is submitted to meta, it cannot be changed further. To make changes, a new form will need to be created and modified.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Align lifecycle terminology (“Submit to Meta” vs “published”).

The doc states forms must be “submitted to Meta” and then later says they must be “published.” These appear to describe the same lifecycle step; inconsistent terminology will confuse users. Please standardize on one term across the guide and FAQs.

Also applies to: 223-226, 239-245

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md around lines 55 - 58, The doc
uses two different lifecycle terms—“Submit to Meta” (button/step label) and
“published” (descriptive state); pick one term and make it consistent across the
guide and FAQs (replace occurrences of “published” with “Submit to Meta” or vice
versa), update the Form Features section lines referencing the final step (e.g.,
the “Submit to Meta” button text) and the FAQ/other sections (previously lines
~223-226 and ~239-245) so they use the chosen term consistently, and keep the
immutability note (“once the form is submitted to meta, it cannot be changed
further”) aligned to the chosen terminology.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@github-actions github-actions bot temporarily deployed to pull request February 25, 2026 08:24 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

♻️ Duplicate comments (3)
docs/4. Product Features/WhatsApp Forms.md (3)

46-46: ⚠️ Potential issue | 🟡 Minor

Capitalize “Google” consistently.

Line 46, Line 96, and Line 128 use “google” in running text. Please standardize to “Google” (e.g., “Google Sheet”, “Google service account”).

Also applies to: 96-96, 128-128

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md at line 46, The document uses
lowercase “google” in several places; update each occurrence to use the proper
capitalization: change "google sheet" to "Google Sheet", "google service
account" to "Google service account", and any other instances of "google" in
running text (e.g., the phrase "submitted to Meta" context) so all mentions are
consistently capitalized (check the occurrences matching the diff strings
"google sheet", "google service account", and surrounding text on the flagged
lines).

57-57: ⚠️ Potential issue | 🟠 Major

Standardize lifecycle terminology across the guide.

Line 57/131/138 use “submitted to Meta,” while Line 224–226 and Line 241/245 use “published.” Please pick one canonical lifecycle term and apply it consistently across steps, checklist, notes, and FAQs.

Also applies to: 131-131, 138-138, 223-226, 241-245

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md at line 57, Choose a single
canonical lifecycle term (e.g., "published" or "submitted to Meta") and replace
all inconsistent occurrences—specifically the phrases "Submit to Meta", "`Submit
to meta`", "submitted to Meta", and "published"—so the guide uses that one term
consistently in steps, checklists, notes, FAQs and any button text; ensure
casing is consistent (Meta vs meta) and update the sentence in the step that
currently reads "Submit to Meta - this is the final step..." plus the checklist
and FAQ entries that reference "published" to use the chosen canonical phrase.

42-47: ⚠️ Potential issue | 🟡 Minor

Fix skipped numbering in ordered lists.

Line 47, Line 65, Line 156, and Line 243 continue lists with missing numbers. Please renumber these lists sequentially for readability and consistency.

Suggested renumbering
-6. Click on Save and go to the form builder interface
+5. Click on Save and go to the form builder interface
...
-4.  Please note, the preview mode is not fully representative ...
+3. Please note, the preview mode is not fully representative ...
...
-3. Take a note of all the these form field names 
+2. Take a note of all these form field names
...
-3. What is the published state 
+2. What is the published state

Also applies to: 61-65, 154-156, 239-247

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md around lines 42 - 47, The ordered
lists under the "Steps:" blocks in WhatsApp Forms.md have skipped/misaligned
numbers (e.g., the sequence showing "1. Go to `Quick Tools` → `WhatsApp Forms`,
2. Click `Create` Form, 3. Provide a form `title` and `category`, 4. For data
storage..., 6. Click on Save..." and similar elsewhere); update each ordered
list so numbers are sequential (1,2,3,4,5...) throughout the document, fixing
the lists that start with the "Steps:" heading and other list blocks that
include items referencing `google sheet`, `submitted to Meta`, and the form
builder instructions so all list items follow correct numeric order.
🧹 Nitpick comments (1)
docs/4. Product Features/WhatsApp Forms.md (1)

50-57: Do a quick editorial cleanup pass for clarity.

Several new sections have grammar/wording slips that make instructions harder to scan (e.g., Line 55, Line 57, Line 79, Line 87, Line 109, Line 123, Line 130). A brief proofread pass will materially improve readability.

Also applies to: 79-79, 87-87, 109-123, 127-131, 135-138

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/4`. Product Features/WhatsApp Forms.md around lines 50 - 57, Perform a
brief editorial cleanup of the "Navigating the form builder interface." section
and the other flagged blocks by fixing grammar, punctuation, capitalization, and
clarity; specifically: reword the intro to be a complete sentence, normalize
action names ("Form JSON" not "Form Json", "Submit to Meta" capitalization
consistent), correct typos ("from json view" → "form JSON view", "over WhatsApp"
→ "on WhatsApp"), and simplify the Submit description to state immutability
after submission and the need to create a new form for changes; apply the same
proofreading rules to the other flagged sections (the blocks around lines noted
in the review) to fix sentence fragments, tense/number agreement, and
inconsistent styling so instructions are concise and scannable.
🤖 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/4`. Product Features/WhatsApp Forms.md:
- Line 46: The document uses lowercase “google” in several places; update each
occurrence to use the proper capitalization: change "google sheet" to "Google
Sheet", "google service account" to "Google service account", and any other
instances of "google" in running text (e.g., the phrase "submitted to Meta"
context) so all mentions are consistently capitalized (check the occurrences
matching the diff strings "google sheet", "google service account", and
surrounding text on the flagged lines).
- Line 57: Choose a single canonical lifecycle term (e.g., "published" or
"submitted to Meta") and replace all inconsistent occurrences—specifically the
phrases "Submit to Meta", "`Submit to meta`", "submitted to Meta", and
"published"—so the guide uses that one term consistently in steps, checklists,
notes, FAQs and any button text; ensure casing is consistent (Meta vs meta) and
update the sentence in the step that currently reads "Submit to Meta - this is
the final step..." plus the checklist and FAQ entries that reference "published"
to use the chosen canonical phrase.
- Around line 42-47: The ordered lists under the "Steps:" blocks in WhatsApp
Forms.md have skipped/misaligned numbers (e.g., the sequence showing "1. Go to
`Quick Tools` → `WhatsApp Forms`, 2. Click `Create` Form, 3. Provide a form
`title` and `category`, 4. For data storage..., 6. Click on Save..." and similar
elsewhere); update each ordered list so numbers are sequential (1,2,3,4,5...)
throughout the document, fixing the lists that start with the "Steps:" heading
and other list blocks that include items referencing `google sheet`, `submitted
to Meta`, and the form builder instructions so all list items follow correct
numeric order.

---

Nitpick comments:
In `@docs/4`. Product Features/WhatsApp Forms.md:
- Around line 50-57: Perform a brief editorial cleanup of the "Navigating the
form builder interface." section and the other flagged blocks by fixing grammar,
punctuation, capitalization, and clarity; specifically: reword the intro to be a
complete sentence, normalize action names ("Form JSON" not "Form Json", "Submit
to Meta" capitalization consistent), correct typos ("from json view" → "form
JSON view", "over WhatsApp" → "on WhatsApp"), and simplify the Submit
description to state immutability after submission and the need to create a new
form for changes; apply the same proofreading rules to the other flagged
sections (the blocks around lines noted in the review) to fix sentence
fragments, tense/number agreement, and inconsistent styling so instructions are
concise and scannable.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d4eea4 and a0974e5.

📒 Files selected for processing (1)
  • docs/4. Product Features/WhatsApp Forms.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant