Skip to content

docs: document description field for dynamic interactive message list options - #660

Open
SangeetaMishr wants to merge 2 commits into
mainfrom
docs/dynamic-interactive-message-description
Open

docs: document description field for dynamic interactive message list options#660
SangeetaMishr wants to merge 2 commits into
mainfrom
docs/dynamic-interactive-message-description

Conversation

@SangeetaMishr

@SangeetaMishr SangeetaMishr commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes #657

glific/glific#4142 (merged via glific/glific#5399 on July 21) added support for populating a WhatsApp list option's description from a variable - previously only the title/label could be set dynamically, and the description field was always left blank in dynamic interactive messages fed from a Google Sheet.

This updates the existing "Dynamic Interactive Messages via Google Sheet" doc (which already covered the ID/Variable setup) to document the new Description field:

  • Step 1: note that you can add extra sheet columns for descriptions
  • Step 5: added a Description column to the ID/Variable example table, explained it's optional and list-message-only (reply buttons have no description), and noted WhatsApp's 72-character limit (verified against the backend's trim_field(param["description"], 72))

Also added a short cross-reference from the related "List options in Interactive Messages" doc, which documents the same ID/Variable config pattern in a different use case, so it doesn't go stale relative to this change.

Verification

Confirmed end-to-end against the actual code rather than just the issue text:

  • glific/glific PR #5399: backend now reads param["description"] and trims it to 72 chars
  • glific/floweditor's SendInteractiveMsgForm.tsx: the node config form already has an id/variable/description field triplet per row (placeholders id {n}, variable {n}, description {n}), so this is a fully shipped, usable feature end-to-end, not just a backend change

Test plan

  • Docs site renders the updated tables and sections correctly
  • Reviewer confirms the Description field placement/behavior matches the current flow editor UI

Summary by CodeRabbit

  • Documentation
    • Updated Google Sheets interactive message guides with July 2026 revision dates.
    • Added instructions for configuring optional descriptions for list message options.
    • Documented dynamic description mappings and automatic trimming for descriptions over WhatsApp’s 72-character limit.
    • Added cross-reference guidance for configuring per-option descriptions.

… options

glific/glific#4142 (merged in glific#5399) added support for
populating a list option's description from a variable, not just its
title. Document the new Description field in the dynamic interactive
message node config, including the 72-character WhatsApp limit, and
cross-link it from the related List options in Interactive Messages
doc.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1205d4e2-6b5e-4b22-a12d-19a3f1f816a0

📥 Commits

Reviewing files that changed from the base of the PR and between ca776cc and 3e8b2e8.

📒 Files selected for processing (2)
  • docs/4. Product Features/11. Link Google Sheets/04. Dynamic Interactive Messages via Google Sheet.md
  • docs/4. Product Features/11. Link Google Sheets/05. List options in Interactive Messages.md

📝 Walkthrough

Walkthrough

Updated two Google Sheets interactive message documentation pages to July 2026. Added optional per-option description columns for list messages, documented dynamic Description field mappings using *_desc values, and noted automatic trimming to WhatsApp’s 72-character limit. Updated the list-options configuration guidance to reference these description settings.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: documenting the description field for dynamic interactive message list options.
Description check ✅ Passed The description directly explains the doc update and the newly documented description field.
Linked Issues check ✅ Passed The docs now explain Google Sheets-sourced descriptions, optional description columns, and the 72-character limit requested by #657.
Out of Scope Changes check ✅ Passed The changes stay within documentation updates and the added cross-reference, with no substantial unrelated scope.
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

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

@github-actions

Copy link
Copy Markdown

@mahajantejas mahajantejas left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  1. the screenshot of the dynamic interactive message node needs to be updated to show that there is not a description field,
  2. Screenshot of the google sheet which shows the description field needs to be added
  3. also the screenshot of the preview bot which shows how the description will come up

@github-actions
github-actions Bot temporarily deployed to pull request July 30, 2026 10:18 Inactive
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.

Update documentation to show how dynamic interactive messages can contain descriptions from google sheets

3 participants