Dashboard Pages
Add plugin status metadata to the open-wa dashboard.
Continue with greeting-bot.mjs and wa.config.mjs from Plugin getting started. Its async init() already returns the message hook and health route; add a page declaration to that returned object.
Declare a page from init()
In greeting-bot.mjs, add pages to the object already returned by init(), alongside the message hook and routes:
pages: [{
path: '/',
title: 'Greeting bot',
icon: '👋',
description: 'The plugin is loaded and its health route is available.',
}],Open the local dashboard and select Greeting bot. The link opens the standard status view at /dashboard/plugins/greeting-bot; changing path changes the sidebar URL but does not create a custom plugin screen.
Page properties
path: The path segment used in dashboard navigation. Use/for the standard status view; other values do not enable custom dashboard rendering.title: The label shown in the sidebar.icon: An emoji or supported icon name shown beside the label.order: Optional ordering metadata; the current dashboard does not use it to sort plugin pages.description: Optional page metadata; the current dashboard does not display it. Use the plugin'smeta.descriptionfor the status view summary.
Add plugin-owned data
The declaration adds a sidebar link to the standard status view. To display plugin-owned data, open the starter's health route, or add another endpoint using the HTTP routes guide.
Related
- Plugin getting started - Build and load
greeting-bot.mjs - AI Tools - Register AI tools from plugins
- Hono Routes - Add HTTP routes to plugins
Was this helpful?
Your answer includes the page path and docs version.
