Document WhatsApp Forms usage in Glific

[mahajantejas]

Added comprehensive documentation for creating and using WhatsApp Forms in Glific, including steps, FAQs, and SQL snippets for data handling.

Summary by CodeRabbit

• Documentation
  • Added a comprehensive WhatsApp Forms guide covering creation workflow, publishing and sending via HSM templates, embedding in flows, form lifecycle states, multilingual considerations, and FAQs.
  • Includes examples for result handling, BigQuery integration with sample SQL, form-variable referencing, publishing constraints, preview embeds, and cost considerations to aid implementation and troubleshooting.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@mahajantejas has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 45 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between dd84443 and 3e7d8ee.

📒 Files selected for processing (1)

• docs/4. Product Features/WhatsApp Forms.md (1 hunks)

Walkthrough

Adds a new documentation page describing WhatsApp Forms in Glific: feature overview, creation and publishing workflow, HSM/template usage, sending and result handling, BigQuery integration with sample SQL, flow integration, lifecycle states, multilingual considerations, and FAQs.

Changes

Cohort / File(s)	Change Summary
Documentation docs/4. Product Features/WhatsApp Forms.md	Added a comprehensive guide for WhatsApp Forms covering creation, publishing, HSM integration, sending, result handling, BigQuery export with sample SQL, flow usage, lifecycle states, multilingual notes, previews, and FAQs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Verify documentation accuracy and clarity
• Check formatting, links, and consistency with existing docs structure

Possibly related issues

• Add documentation for WhatsApp Forms #511 — Same WhatsApp Forms documentation addition; likely the same objective and can be linked.

Suggested reviewers

• Fawas003
• mdshamoon
• SangeetaMishr

Poem

🐰 I hopped through lines of docs so warm,

I stitched a page for WhatsApp Forms,
With steps and SQL and FAQs bright,
Now Glific's users see the light.
🥕✨

Pre-merge checks and finishing touches

✅ 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 'Document WhatsApp Forms usage in Glific' directly and clearly summarizes the main change: adding comprehensive documentation for WhatsApp Forms in Glific.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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-513--glific-docs.netlify.app

[coderabbitai]

Actionable comments posted: 8

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17e8ff9 and 2aa79fa.

📒 Files selected for processing (1)

• docs/4. Product Features/WhatsApp Forms.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/4. Product Features/WhatsApp Forms.md

[uncategorized] ~124-~124: “Google” is a proper noun and needs to be capitalized.
Context: ...elp you extract the form responses to a google sheet, refer the next section <iframe ...

(A_GOOGLE)

---

[style] ~181-~181: Consider a more concise word here.
Context: ...h the form, the form has to published in order to be used in HSMs. 2. Once the form is pu...

(IN_ORDER_TO_PREMIUM)

---

[style] ~186-~186: Consider using “remains”.
Context: ..., even after it is deactivated, the HSM continues to remain valid for the users to fill. 7. Once a ...

(CONTINUE_TO_REMAIN)

---

[grammar] ~191-~191: Use a hyphen to join words.
Context: ...he forms have to be attached to language specific HSM. Follow this documentation ...

(QB_NEW_EN_HYPHEN)

---

[grammar] ~210-~210: Use a hyphen to join words.
Context: ...d it can be used to create WhatsApp form linked HSM message and it can be sent to...

(QB_NEW_EN_HYPHEN)

---

[style] ~214-~214: Consider using “remain”.
Context: ...which have the form linked already will continue to remain operational. 5. Why are there numbers ...

(CONTINUE_TO_REMAIN)

---

[grammar] ~222-~222: Use a hyphen to join words.
Context: ...word or clicking on the whatsapp keyword encoded link and starting the conversati...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)

docs/4. Product Features/WhatsApp Forms.md

121-121: Hard tabs
Column: 30

(MD010, no-hard-tabs)

---

135-135: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

226-226: Bare URL used

(MD034, no-bare-urls)

[coderabbitai]

Actionable comments posted: 4

♻️ Duplicate comments (2)

docs/4. Product Features/WhatsApp Forms.md (2)

176-176: Update instructions to reflect the corrected SQL.

Line 176 should be updated to match the corrected SQL syntax where form_name is now a quoted string literal.

-1. Change the form name in the line `wf.name = form_name`
+1. Replace `'your-form-name'` with the actual name of your form in the WHERE clause

---

152-152: Fix SQL syntax error: quote the form_name value.

Line 152 uses an unquoted identifier form_name in the WHERE clause, which will fail at runtime. The value must be quoted as a string literal or replaced with the actual form name.

-  WHERE
-    wf.name = form_name
+  WHERE
+    wf.name = 'your-form-name'  -- Replace with your actual form name

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2aa79fa and dd84443.

📒 Files selected for processing (1)

• docs/4. Product Features/WhatsApp Forms.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/4. Product Features/WhatsApp Forms.md

[style] ~213-~213: Consider using “remain”.
Context: ...which have the form linked already will continue to remain operational. 5. Why are there numbers ...

(CONTINUE_TO_REMAIN)

---

[grammar] ~221-~221: Use a hyphen to join words.
Context: ...word or clicking on the whatsapp keyword encoded link and starting the conversati...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)

docs/4. Product Features/WhatsApp Forms.md

121-121: Hard tabs
Column: 30

(MD010, no-hard-tabs)

---

135-135: Fenced code blocks should have a language specified

(MD040, fenced-code-language)