Skip to main content
The Card Messages tool lets your agent reply with flexible, interactive cards — buttons, images, progress bars, layouts — instead of plain text. You design each card once in Card Builder so it always renders uniformly, then tell the agent when to send it.

​
Enable the Card Messages tool

  1. Open your agent and go to Tools.
  2. Find Card Messages (a built-in system tool) and toggle it on.
  3. A Design interactive cards with Card Builder prompt appears — click Open Card Builder to start designing.

​
How it works

Card Messages is a built-in system tool. When you enable it, the agent can call the tool to fetch a card reference — working examples plus a field reference (describing the structure documented in the Card JSON Schema) — and then generate a conforming card in its reply. That means the agent can compose cards freely — but free-form generation drifts in layout and styling from one reply to the next. To keep every card consistent, design it once in Card Builder and give the agent the exported JSON to reuse, as shown below.
You supply what card to send — the how is automatic. Enabling the tool also teaches the agent the format CometChat uses to recognize a card in its reply, so cards render with no extra work. This holds even when you paste a predefined card into the Instructions: keep the tool on — that’s what supplies the format. With the tool off, pasted card JSON won’t render as a card.
A reply is delivered as an ordered sequence of elements — plain-text segments and at most one card. So an agent can send a card on its own, or with text before and/or after it, in a single reply. To present multiple sections inside the card, use layout elements (row, column, grid, tabs, accordion) rather than sending a second card.

​
Design a card and add it to your agent

Once the tool is on, the workflow is:
  1. Design your card visually in Card Builder — see Building an Order Status Card for a full walkthrough.
  2. Use Export → Copy Card JSON to copy the finished card.
  3. Add the JSON to the agent’s Instructions and specify when to send it.
A fixed card renders exactly as designed. If it includes {{placeholder}} variables, instruct the agent to fill them in before sending.
With several card types, you can return the card JSON from a Custom API Tool instead of pasting it into the instructions — keeping the agent’s instructions concise and focused.

​
Design cards in Card Builder

Card Builder is the visual editor where you compose and save your cards.

Open Card Builder

Learn the editor — palette, canvas, elements, actions, and variables.

Worked example

Build an interactive Order Status card from scratch, step by step.

Card JSON Schema

The complete schema a card’s JSON must conform to.