Runtime API Examples β
This page demonstrates usage of some of the runtime APIs provided by VitePress.
The main useData() API can be used to access site, theme, and page data for the current page. It works in both .md and .vue files:
md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>Results β
Theme Data β
{
"search": {
"provider": "local"
},
"nav": [
{
"text": "Home",
"link": "/"
},
{
"text": "Documentation",
"items": [
{
"text": "Whatsbot - Perfex CRM",
"link": "/products/whatsbot/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Whatsboost - Rise CRM",
"link": "/products/whatsboost/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Bannercraft - perfex CRM",
"link": "/products/bannercraft-perfex-crm/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Whatsbot-rest-api - perfex CRM",
"link": "/products/whatsbotapi/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Logtracker - Perfex CRM",
"link": "/products/logtracker/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Riselogger - Rise CRM",
"link": "/products/riselogger/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Flexible- Backup - Rise CRM",
"link": "/products/flexible-backup-rise-crm/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Smart-Banners - Rise CRM",
"link": "/products/smart-banners/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Whatsmark - Laravel Script",
"link": "products/whatsmark/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Whatsmark-SaaS - Laravel Script",
"link": "products/whatsmark-saas/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "AI Assistant & Knowledge Bot - WhatsMark SaaS",
"link": "/products/ai-assistant-for-whatsmarks-saas/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Facebook Leads Synchronization Module - WhatsMark SaaS",
"link": "/products/fblead-addon-for-whatsmarks-saas/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Landing Page Builder β Build, Customize & Launch Pages Fast",
"link": "/products/landing-page-builder/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Perfex CRM to n8n - Webhooks & Real-Time Automation",
"link": "https://help.corbitaltech.dev/",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "Rise CRM to n8n - Webhooks & Real-Time Automation",
"link": "https://help.corbitaltech.dev/",
"target": "_blank",
"rel": "noopener noreferrer"
},
{
"text": "FeedbackFlow - Self-Hosted Feedback & Roadmap Management",
"link": "/products/feedback-flow/index.md",
"target": "_blank",
"rel": "noopener noreferrer"
}
]
},
{
"text": "Support Area",
"link": "https://support.corbitaltech.dev/"
},
{
"text": "Our Products on Envato",
"link": "https://codecanyon.net/user/corbitaltech/portfolio"
},
{
"text": "Contact",
"link": "https://corbitaltechnologies.com/contact/"
}
],
"sidebar": {
"/products/logtracker/": [
{
"text": "Introduction - LogTracker",
"link": "/products/logtracker/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/logtracker/prologue.md"
},
{
"text": "Release Notes ποΈ",
"link": "/products/logtracker/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/logtracker/installation.md"
},
{
"text": "Purchase Key π",
"link": "/products/logtracker/purchase-code.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Dashboard π₯",
"link": "/products/logtracker/usage.md"
},
{
"text": "Log Settings π ",
"link": "/products/logtracker/log-settings.md"
}
]
}
],
"/products/riselogger/": [
{
"text": "Introduction - Riselogger",
"link": "/products/riselogger/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/riselogger/prologue.md"
},
{
"text": "Release Notes ποΈ",
"link": "/products/riselogger/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/riselogger/installation.md"
},
{
"text": "Purchase Key π",
"link": "/products/riselogger/purchase.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Dashboard π₯",
"link": "/products/riselogger/usage.md"
},
{
"text": "Log Settings π ",
"link": "/products/riselogger/log-settings.md"
}
]
}
],
"/products/bannercraft-perfex-crm/": [
{
"text": "Introduction - Bannercraft ",
"link": "/products/bannercraft-perfex-crm/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/bannercraft-perfex-crm/features.md"
},
{
"text": "Release Notes ποΈ",
"link": "/products/bannercraft-perfex-crm/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/bannercraft-perfex-crm/installation.md"
},
{
"text": "Purchase Key π",
"link": "/products/bannercraft-perfex-crm/purchase-code.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "How to Configure π₯½",
"link": "/products/bannercraft-perfex-crm/configure.md"
},
{
"text": "News Ticker π«",
"link": "/products/bannercraft-perfex-crm/news-ticker.md"
},
{
"text": "Settings π ",
"link": "/products/bannercraft-perfex-crm/settings.md"
},
{
"text": "Update ββ¬",
"link": "/products/bannercraft-perfex-crm/update.md"
}
]
},
{
"text": "Help & FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/bannercraft-perfex-crm/faq.md"
},
{
"text": "Best Practices",
"link": "/products/bannercraft-perfex-crm/best-practises.md"
}
]
}
],
"/products/ccavenue-rise-crm/": [
{
"text": "CC Avenue Rise CRM ",
"items": [
{
"text": "Overview",
"link": "/products/ccavenue-rise-crm/index.md"
},
{
"text": "Prologue",
"link": "/products/ccavenue-rise-crm/prologue.md"
},
{
"text": "Getting Started",
"link": "/products/ccavenue-rise-crm/getting-started.md"
},
{
"text": "Installation",
"link": "/products/ccavenue-rise-crm/installation.md"
},
{
"text": "Usage",
"link": "/products/ccavenue-rise-crm/usage.md"
}
]
}
],
"/products/ccavenue-perfex-crm/": [
{
"text": "CC Avenue Perfex CRM ",
"items": [
{
"text": "Overview",
"link": "/products/ccavenue-perfex-crm/index.md"
},
{
"text": "Prologue",
"link": "/products/ccavenue-perfex-crm/prologue.md"
},
{
"text": "Getting Started",
"link": "/products/ccavenue-perfex-crm/getting-started.md"
},
{
"text": "Installation",
"link": "/products/ccavenue-perfex-crm/installation.md"
},
{
"text": "Usage",
"link": "/products/ccavenue-perfex-crm/usage.md"
}
]
}
],
"/products/flexible-backup-rise-crm/": [
{
"text": "Introduction - Flexible-Backup",
"link": "/products/flexible-backup-rise-crm/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/flexible-backup-rise-crm/prologue.md"
},
{
"text": "Release Notes ποΈ",
"link": "/products/flexible-backup-rise-crm/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/flexible-backup-rise-crm/installation.md"
},
{
"text": "Purchase Key π",
"link": "/products/flexible-backup-rise-crm/purchase-code.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Stored Backups πΎβ",
"link": "/products/flexible-backup-rise-crm/usage.md"
},
{
"text": "Upcoming Backups β³",
"link": "/products/flexible-backup-rise-crm/upcoming-backup.md"
},
{
"text": "Settings π ",
"link": "/products/flexible-backup-rise-crm/settings.md"
},
{
"text": "Backup πβοΈ",
"link": "/products/flexible-backup-rise-crm/backup.md"
}
]
}
],
"/products/whatsbot/": [
{
"text": "Introduction - Whatsbot ",
"link": "/products/whatsbot/index.md"
},
{
"text": "Preface",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/whatsbot/features.md"
},
{
"text": "Who Can Use This Module π₯",
"link": "/products/whatsbot/who-can-use.md"
},
{
"text": "Release Notes ποΈ",
"link": "/products/whatsbot/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/whatsbot/installation.md"
},
{
"text": "Purchase Key π",
"link": "/products/whatsbot/purchase-code.md"
}
]
},
{
"text": "Connect Whatspp with Whatsbot",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Connect Account π",
"link": "/products/whatsbot/connect-account-new.md"
},
{
"text": "Creating Flow Template π",
"link": "/products/whatsbot/meta-flow-template.md"
}
]
},
{
"text": "Usage",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Message Bot π€βοΈ",
"link": "/products/whatsbot/message-bot.md"
},
{
"text": "Template Bot ππ€",
"link": "/products/whatsbot/template-bot.md"
},
{
"text": "Templates π",
"link": "/products/whatsbot/templates.md"
},
{
"text": "Flow Templates π",
"link": "/products/whatsbot/flow-templates.md"
},
{
"text": "Marketing Automation π₯π€",
"link": "/products/whatsbot/marketing-automation.md"
},
{
"text": "Campaigns π’",
"link": "/products/whatsbot/campaigns.md"
},
{
"text": "Chat π¬",
"link": "/products/whatsbot/chat.md"
},
{
"text": "Initiate Chat π¬",
"link": "/products/whatsbot/initiate-chat.md"
},
{
"text": "AI Prompts Integration π€",
"link": "/products/whatsbot/ai-chat.md"
},
{
"text": "Emoji Picker in chat π",
"link": "/products/whatsbot/emoji-picker.md"
},
{
"text": "Activities Log π",
"link": "/products/whatsbot/activities-log.md"
},
{
"text": "Settings π ",
"link": "/products/whatsbot/settings.md"
},
{
"text": "Bulk Campaigns through CSV",
"link": "/products/whatsbot/bulk-camplaing-through-csv.md"
},
{
"text": "Canned Reply π",
"link": "/products/whatsbot/canned-reply.md"
},
{
"text": "Bot Flow Builder π",
"link": "/products/whatsbot/bot-flow-builder.md"
},
{
"text": "Personal AI Asssistant π©βπΌπ€",
"link": "/products/whatsbot/personal-ai-assistant.md"
},
{
"text": "AI Asssistant Settings π€π ",
"link": "/products/whatsbot/ai-assistant-settings.md"
},
{
"text": "Generate QR Code πΏ",
"link": "/products/whatsbot/generate-qr-code.md"
},
{
"text": "Custom AI Prompts π§ ",
"link": "/products/whatsbot/custom-ai-prompts.md"
},
{
"text": "Update ββ¬",
"link": "/products/whatsbot/update.md"
}
]
},
{
"text": "Help & FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/whatsbot/faq.md"
}
]
}
],
"/products/whatsbotapi/": [
{
"text": "Introduction - WhatsBot REST API ",
"link": "/products/whatsbotapi/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/whatsbotapi/features.md"
},
{
"text": "Release Notes ποΈ",
"link": "/products/whatsbotapi/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/whatsbotapi/installation.md"
},
{
"text": "Purchase Key",
"link": "/products/whatsbotapi/purchase-code.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Generate API Token π₯½",
"link": "/products/whatsbotapi/generate-token.md"
},
{
"text": "Usage of the API βοΈ",
"link": "/products/whatsbotapi/usage.md"
}
]
},
{
"text": "Help & FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/whatsbotapi/faq.md"
}
]
}
],
"/products/whatsboost/": [
{
"text": "Introduction - Whatsboost ",
"link": "/products/whatsboost/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/whatsboost/features.md"
},
{
"text": "Who Can Use This Plugin π₯",
"link": "/products/whatsboost/who-can-use.md"
},
{
"text": "Release Notes ποΈ",
"link": "/products/whatsboost/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/whatsboost/installation.md"
},
{
"text": "Purchase Key π",
"link": "/products/whatsboost/purchase-code.md"
}
]
},
{
"text": "Connect Whatspp with Whatsboost",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Connect Account π",
"link": "/products/whatsboost/connect-account.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Message Bot π€βοΈ",
"link": "/products/whatsboost/message-bot.md"
},
{
"text": "Template Bot ππ€",
"link": "/products/whatsboost/template-bot.md"
},
{
"text": "Templates π",
"link": "/products/whatsboost/templates.md"
},
{
"text": "Csv Campaign π",
"link": "/products/whatsboost/csv-campaigns.md"
},
{
"text": "Canned Reply π",
"link": "/products/whatsboost/canned-reply.md"
},
{
"text": "Bot Flow Builder π",
"link": "/products/whatsboost/bot-flow-builder.md"
},
{
"text": "Custom AI Prompts π§ ",
"link": "/products/whatsboost/custom-ai-prompts.md"
},
{
"text": "Campaigns π’",
"link": "/products/whatsboost/campaigns.md"
},
{
"text": "Chat π¬",
"link": "/products/whatsboost/chat.md"
},
{
"text": "Activities Log π",
"link": "/products/whatsboost/activities-log.md"
},
{
"text": "Settings π ",
"link": "/products/whatsboost/settings.md"
}
]
},
{
"text": "Help & FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/whatsboost/faq.md"
}
]
}
],
"/products/smart-banners": [
{
"text": "Introduction - Smart-Banners ",
"link": "/products/smart-banners/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/smart-banners/prologue.md"
},
{
"text": "Release Notes ποΈ",
"link": "/products/smart-banners/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/smart-banners/installation.md"
},
{
"text": "Purchase Key π",
"link": "/products/smart-banners/purchase-code.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "How to Configure π₯½",
"link": "/products/smart-banners/configure.md"
},
{
"text": "News Ticker π«",
"link": "/products/smart-banners/news-ticker.md"
},
{
"text": "Settings π ",
"link": "/products/smart-banners/settings.md"
}
]
},
{
"text": "Help & FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/smart-banners/faq.md"
},
{
"text": "Best Practices",
"link": "/products/smart-banners/best-practises.md"
}
]
}
],
"/products/whatsmark-saas": [
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Introduction",
"link": "/products/whatsmark-saas/index.md"
},
{
"text": "Screenshots",
"link": "/products/whatsmark-saas/screenshots.md"
},
{
"text": "Source Code Structure",
"link": "/products/whatsmark-saas/source-code-structure.md"
},
{
"text": "Release Notes",
"link": "/products/whatsmark-saas/releases.md"
},
{
"text": "Upgrade Guide",
"link": "/products/whatsmark-saas/upgrade-guide.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "System Requirements",
"link": "/products/whatsmark-saas/system-requirements"
},
{
"text": "Installation via Web Interface",
"link": "/products/whatsmark-saas/web-interface"
},
{
"text": "AApanel Installation Guide",
"link": "/products/whatsmark-saas/aapanel-installation"
},
{
"text": "SSL Setup",
"link": "/products/whatsmark-saas/admin/ssl-setup"
},
{
"text": "Cron Job Configuration",
"link": "/products/whatsmark-saas/admin/cron-job-setup"
},
{
"text": "Purchase Code Activation",
"link": "/products/whatsmark-saas/admin/purchase-code"
}
]
},
{
"text": "Admin Area",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Dashboard Overview",
"link": "/products/whatsmark-saas/admin/index.md"
},
{
"text": "Tenant Management",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Manage Tenants",
"link": "/products/whatsmark-saas/admin/tenant-management"
}
]
},
{
"text": "Sales & Revenue",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Sales Management",
"link": "/products/whatsmark-saas/admin/sales-management"
},
{
"text": "Plan Management",
"link": "/products/whatsmark-saas/admin/plan-management"
},
{
"text": "Coupon Management",
"link": "/products/whatsmark-saas/admin/coupon-management"
}
]
},
{
"text": "Support",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Ticket Management",
"link": "/products/whatsmark-saas/admin/Tickets"
}
]
},
{
"text": "Admin Settings",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Payment Gateway",
"link": "/products/whatsmark-saas/admin/payment-gateway"
},
{
"text": "Website Settings",
"link": "/products/whatsmark-saas/admin/website-management"
},
{
"text": "System Settings",
"link": "/products/whatsmark-saas/admin/system-settings"
},
{
"text": "WhatsApp Webhook",
"link": "/products/whatsmark-saas/admin/whatsapp-configuration"
},
{
"text": "General Setup",
"link": "/products/whatsmark-saas/admin/SetUp.md"
}
]
}
]
},
{
"text": "Tenant Area",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Dashboard",
"link": "/products/whatsmark-saas/tenant/index.md"
},
{
"text": "Connect WhatsApp Business",
"link": "/products/whatsmark-saas/tenant/connect-account.md"
},
{
"text": "Subscriptions & Billing",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Subscriptions",
"link": "/products/whatsmark-saas/tenant/subscription"
},
{
"text": "Invoices",
"link": "/products/whatsmark-saas/tenant/invoice"
}
]
},
{
"text": "Contacts Management",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Contact Management",
"link": "/products/whatsmark-saas/tenant/contact-management"
}
]
},
{
"text": "Template Management",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Template Library",
"link": "/products/whatsmark-saas/tenant/templates-library"
},
{
"text": "Create Template",
"link": "/products/whatsmark-saas/tenant/create-template"
}
]
},
{
"text": "Marketing Automation",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Campaign Manager",
"link": "/products/whatsmark-saas/tenant/campaign-manager"
},
{
"text": "Bulk Campaign",
"link": "/products/whatsmark-saas/tenant/bulk-campaign"
},
{
"text": "Message Bot",
"link": "/products/whatsmark-saas/tenant/message-bot"
},
{
"text": "Template Bot",
"link": "/products/whatsmark-saas/tenant/template-bot"
},
{
"text": "Bot Flow Builder",
"link": "/products/whatsmark-saas/tenant/bot-flow"
}
]
},
{
"text": "Customer Support",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Live Chat",
"link": "/products/whatsmark-saas/tenant/live-chat"
},
{
"text": "Support Tickets",
"link": "/products/whatsmark-saas/tenant/support-tickets"
}
]
},
{
"text": "Tenant Settings",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Application Settings",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "WhatsApp Auto Lead",
"link": "/products/whatsmark-saas/tenant/whatsApp-auto-lead"
},
{
"text": "Stop Bot",
"link": "/products/whatsmark-saas/tenant/stop-bot"
},
{
"text": "WhatsApp Webhook",
"link": "/products/whatsmark-saas/tenant/whatsapp-webhook"
},
{
"text": "Support Agent",
"link": "/products/whatsmark-saas/tenant/support-agent"
},
{
"text": "Notification Sound",
"link": "/products/whatsmark-saas/tenant/notification-sound"
},
{
"text": "AI Integration",
"link": "/products/whatsmark-saas/tenant/ai-integration"
},
{
"text": "Auto Clear Chat History",
"link": "/products/whatsmark-saas/tenant/auto-clear-chat-history"
},
{
"text": "WhatsApp Session Management",
"link": "/products/whatsmark-saas/tenant/whatsapp-session-management"
},
{
"text": "Opt-In/Out System",
"link": "/products/whatsmark-saas/tenant/opt-in-opt-out-system"
}
]
},
{
"text": "System Settings",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "General System",
"link": "/products/whatsmark-saas/tenant/system-settings"
},
{
"text": "Cache Management",
"link": "/products/whatsmark-saas/tenant/cache-management"
},
{
"text": "API Management",
"link": "/products/whatsmark-saas/tenant/api-management"
},
{
"text": "Webhook Management",
"link": "/products/whatsmark-saas/tenant/webhook-management"
}
]
},
{
"text": "Setup & Configuration",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Staff & Role Management",
"link": "/products/whatsmark-saas/tenant/staff-role-management"
},
{
"text": "Status & Source Management",
"link": "/products/whatsmark-saas/tenant/status-source-management"
},
{
"text": "Groups",
"link": "/products/whatsmark-saas/tenant/groups"
},
{
"text": "Custom Fields",
"link": "/products/whatsmark-saas/tenant/custom-fields"
},
{
"text": "AI Prompts",
"link": "/products/whatsmark-saas/tenant/ai-prompt"
},
{
"text": "Canned Replies",
"link": "/products/whatsmark-saas/tenant/canned-replies"
},
{
"text": "Activity Log",
"link": "/products/whatsmark-saas/tenant/activity-log"
},
{
"text": "Languages",
"link": "/products/whatsmark-saas/tenant/languages"
},
{
"text": "Email Templates",
"link": "/products/whatsmark-saas/tenant/email-templates"
},
{
"text": "System Logs",
"link": "/products/whatsmark-saas/tenant/system-logs"
}
]
}
]
}
]
},
{
"text": "API",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "API Documentation",
"link": "/products/whatsmark-saas/api/index"
},
{
"text": "Send Auth Templates",
"link": "/products/whatsmark-saas/api/send-auth-templates"
}
]
},
{
"text": "Integrations",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "N8N Webhook Integration",
"link": "/products/whatsmark-saas/integrations/n8n-webhook-integration"
},
{
"text": "Webhook Format Reference",
"link": "/products/whatsmark-saas/integrations/webhook-format-reference"
},
{
"text": "WhatsApp Webhook Forwarding",
"link": "/products/whatsmark-saas/integrations/whatsapp-webhook-forwarding"
},
{
"text": "WhatsApp Webhook Format Reference",
"link": "/products/whatsmark-saas/integrations/whatsapp-webhook-format-reference"
}
]
},
{
"text": "Customization",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Custom Module <span class=\"gradient-text2\">BETA</span>",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Getting Started",
"link": "/products/whatsmark-saas/custom-module/getting-started"
},
{
"text": "CSRF Token Validation",
"link": "/products/whatsmark-saas/custom-module/validate-csrf-token"
}
]
},
{
"text": "Module Development <span class=\"gradient-text2\">NEW</span>",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Getting Started",
"link": "/products/whatsmark-saas/module-development/getting-started"
},
{
"text": "Module Structure",
"link": "/products/whatsmark-saas/module-development/module-structure"
},
{
"text": "Payment Gateway Integration",
"link": "/products/whatsmark-saas/module-development/payment-gateway-guide"
},
{
"text": "Tenant Billing Integration",
"link": "/products/whatsmark-saas/module-development/tenant-billing-integration"
},
{
"text": "Advanced Topics",
"link": "/products/whatsmark-saas/module-development/advanced-topics"
},
{
"text": "Helper Functions",
"link": "/products/whatsmark-saas/module-development/helper-functions"
},
{
"text": "Language Synchronization",
"link": "/products/whatsmark-saas/module-development/language-synchronization"
}
]
}
]
},
{
"text": "Advanced Configuration",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Laravel Horizon with Supervisor",
"link": "/products/whatsmark-saas/advance-configuration/supervisor-setup-guide-for-laravel-horizon"
}
]
},
{
"text": "Support",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "Frequently Asked Questions",
"link": "/products/whatsmark-saas/faq"
}
]
}
],
"/products/whatsmark": [
{
"text": "Introduction - WhatsMark ",
"link": "/products/whatsmark/index.md"
},
{
"text": "Highlights",
"link": "/products/whatsmark/screenshots.md"
},
{
"text": "Preface",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Features ",
"link": "/products/whatsmark/features.md"
},
{
"text": "Who Can Use This Script ",
"link": "/products/whatsmark/who-can-use.md"
},
{
"text": "Release Notes ",
"link": "/products/whatsmark/releases.md"
}
]
},
{
"text": "Getting Started",
"items": [
{
"text": "Installation",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Requirements",
"link": "/products/whatsmark/requirement"
},
{
"text": "Using web interface",
"link": "/products/whatsmark/web-interface"
},
{
"text": "Set Up Cron Job ",
"link": "/products/whatsmark/cron-job.md"
},
{
"text": "Troubleshooting ",
"link": "/products/whatsmark/troubleshoot.md"
}
]
},
{
"text": "SSL",
"link": "/products/whatsmark/ssl"
},
{
"text": "purchase code",
"link": "/products/whatsmark/purchase-code.md"
}
]
},
{
"text": "Connect WhatsMark with Whatsapp",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Connect WABA",
"link": "/products/whatsmark/connect-account.md"
}
]
},
{
"text": "Settings",
"items": [
{
"text": "System Setting",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "General Settings ",
"link": "/products/whatsmark/general"
},
{
"text": "Email Configuration ",
"link": "/products/whatsmark/email"
},
{
"text": "Re Captcha Security ",
"link": "/products/whatsmark/recaptcha"
},
{
"text": "Announcements ",
"link": "/products/whatsmark/announcements"
},
{
"text": "Cron Job Scheduling ",
"link": "/products/whatsmark/cronjob"
},
{
"text": "SEO Optimization ",
"link": "/products/whatsmark/seo"
},
{
"text": "Pusher - Real Time Notification",
"link": "/products/whatsmark/pusher"
},
{
"text": "API Managment ",
"link": "/products/whatsmark/api-management"
},
{
"text": "Webhook Managment ",
"link": "/products/whatsmark/webhook-management"
},
{
"text": "Cache Optimization",
"link": "/products/whatsmark/cache-management"
},
{
"text": "System Update ",
"link": "/products/whatsmark/system-update"
},
{
"text": "System Information",
"link": "/products/whatsmark/system-information"
},
{
"text": "Privacy Policy",
"link": "/products/whatsmark/privacy-policy"
}
]
},
{
"text": "Whatsmark Setting",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Whatsapp Auto Lead",
"link": "/products/whatsmark/whatsapp-auto-lead"
},
{
"text": "Stop Bot - Bot Control",
"link": "/products/whatsmark/stop-bot"
},
{
"text": "Webhook Configuration",
"link": "/products/whatsmark/web-hooks"
},
{
"text": "Support Agent Settings",
"link": "/products/whatsmark/support-agent"
},
{
"text": "Notification Sound",
"link": "/products/whatsmark/notification-sound"
},
{
"text": "AI Integration",
"link": "/products/whatsmark/ai-integration"
},
{
"text": "Auto Clear Chat History Cleanup",
"link": "/products/whatsmark/auto-clear-chat-history"
}
]
},
{
"text": "Setup",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "User Managament",
"link": "/products/whatsmark/user"
},
{
"text": "Role Managament",
"link": "/products/whatsmark/role"
},
{
"text": "Status Management",
"link": "/products/whatsmark/status"
},
{
"text": "Source Management",
"link": "/products/whatsmark/source"
},
{
"text": "AI Prompts",
"link": "/products/whatsmark/ai-prompts"
},
{
"text": "Canned Replies",
"link": "/products/whatsmark/canned-reply"
},
{
"text": "Activity Logs",
"link": "/products/whatsmark/activity-log"
},
{
"text": "Language Settings",
"link": "/products/whatsmark/languages"
},
{
"text": "Email Templates",
"link": "/products/whatsmark/email-templates"
},
{
"text": "System Logs",
"link": "/products/whatsmark/system-logs"
}
]
}
]
},
{
"text": "Usage",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Dashboard",
"link": "/products/whatsmark/dashboard.md"
},
{
"text": "Contact Management",
"link": "/products/whatsmark/contacts.md"
},
{
"text": "Templates Library",
"link": "/products/whatsmark/templates.md"
},
{
"text": "Campaign Manager",
"link": "/products/whatsmark/campaigns.md"
},
{
"text": "Bulk Campaign",
"link": "/products/whatsmark/bulk-campaign.md"
},
{
"text": "Message Bot",
"link": "/products/whatsmark/message-bot.md"
},
{
"text": "Template Bot",
"link": "/products/whatsmark/template-bot.md"
},
{
"text": "Initiate Chat",
"link": "/products/whatsmark/initiate-chat.md"
},
{
"text": "Live Chat",
"link": "/products/whatsmark/chat.md"
}
]
},
{
"text": "Help & FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/whatsmark/faq.md"
}
]
}
],
"/products/ai-assistant-for-whatsmarks-saas/": [
{
"text": "AI Assistant & Knowledge Bot",
"link": "/products/ai-assistant-for-whatsmarks-saas/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features",
"link": "/products/ai-assistant-for-whatsmarks-saas/prologue.md"
},
{
"text": "Release Notes",
"link": "/products/ai-assistant-for-whatsmarks-saas/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation",
"link": "/products/ai-assistant-for-whatsmarks-saas/installation.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Configure OpenAI",
"link": "/products/ai-assistant-for-whatsmarks-saas/configure.md"
},
{
"text": "Create AI Assistant",
"link": "/products/ai-assistant-for-whatsmarks-saas/create-ai-ssistant.md"
},
{
"text": "Online Video",
"link": "/products/ai-assistant-for-whatsmarks-saas/online-video.md"
}
]
},
{
"text": "Help & FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/ai-assistant-for-whatsmarks-saas/faq.md"
},
{
"text": "Best Practices",
"link": "/products/ai-assistant-for-whatsmarks-saas/best-practises.md"
}
]
}
],
"/products/embedded-sign-up-for-whatsmarks-saas/": [
{
"text": "Introduction - WhatsApp Embedded Sign-up",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/index.md"
},
{
"text": "Preface",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Features β¨",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/features.md"
}
]
},
{
"text": "Getting Started",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Installation π",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/installation.md"
}
]
},
{
"text": "Usage",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Admin Plan Setup βοΈ",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/admin-plan-setup.md"
},
{
"text": "Tenant Connection Process",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/tenant-connection-process.md"
},
{
"text": "Coexistence Feature π",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/coexistence-feature.md"
},
{
"text": "Demo Videos π₯",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/demo-videos.md"
}
]
},
{
"text": "Advanced Topics",
"collapsible": false,
"collapsed": false,
"items": [
{
"text": "Meta Tech Provider Approval Guide π",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/meta-bsp-approval.md"
},
{
"text": "How to Become a Meta Tech Provider β¨",
"link": "/products/embedded-sign-up-for-whatsmarks-saas/become-tech-provider.md"
}
]
}
],
"/products/ecommerce-webhook-notifications-for-whatsmarks-saas/": [
{
"text": "Ecommerce Webhook Notifications",
"link": "/products/ecommerce-webhook-notifications-for-whatsmarks-saas/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features",
"link": "/products/ecommerce-webhook-notifications-for-whatsmarks-saas/features.md"
},
{
"text": "Release Notes",
"link": "/products/ecommerce-webhook-notifications-for-whatsmarks-saas/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation",
"link": "/products/ecommerce-webhook-notifications-for-whatsmarks-saas/installation.md"
},
{
"text": "Online Video",
"link": "/products/ecommerce-webhook-notifications-for-whatsmarks-saas/online-video.md"
}
]
},
{
"text": "Usage",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Webhook Listener",
"link": "/products/ecommerce-webhook-notifications-for-whatsmarks-saas/webhook-listener.md"
},
{
"text": "WooCommerce Webhook Setup",
"link": "/products/ecommerce-webhook-notifications-for-whatsmarks-saas/woocommerce-webhook-setup.md"
}
]
},
{
"text": "Help & FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/ecommerce-webhook-notifications-for-whatsmarks-saas/faq.md"
}
]
}
],
"/products/fblead-addon-for-whatsmarks-saas/": [
{
"text": "Facebook Leads Integration & Sync Addon for WhatsMarkSaaS",
"link": "/products/fblead-addon-for-whatsmarks-saas/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features",
"link": "/products/fblead-addon-for-whatsmarks-saas/prologue.md"
},
{
"text": "Release Notes",
"link": "/products/fblead-addon-for-whatsmarks-saas/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Getting Started",
"link": "/products/fblead-addon-for-whatsmarks-saas/getting-started.md"
},
{
"text": "Installation",
"link": "/products/fblead-addon-for-whatsmarks-saas/installation.md"
},
{
"text": "Configuration",
"link": "/products/fblead-addon-for-whatsmarks-saas/configurations.md"
},
{
"text": "Facebook Integration",
"link": "/products/fblead-addon-for-whatsmarks-saas/facebook-integration.md"
}
]
},
{
"text": "Support",
"collapsible": true,
"collapsed": true,
"items": [
{
"text": "FAQ",
"link": "/products/fblead-addon-for-whatsmarks-saas/faq.md"
}
]
}
],
"/products/landing-page-builder/": [
{
"text": "Landing Page Builder Addon for WhatsMark SaaS",
"link": "/products/landing-page-builder/index.md"
},
{
"text": "Preface",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Features",
"link": "/products/landing-page-builder/prologue.md"
},
{
"text": "Release Notes",
"link": "/products/landing-page-builder/releases.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation",
"link": "/products/landing-page-builder/installation.md"
},
{
"text": "Getting Started",
"link": "/products/landing-page-builder/getting-started.md"
},
{
"text": "Default Theme",
"link": "/products/landing-page-builder/default-theme-dragify.md"
},
{
"text": "Customizing Pages",
"link": "/products/landing-page-builder/customizing-pages.md"
}
]
},
{
"text": "FAQ",
"items": [
{
"text": "FAQ",
"link": "/products/landing-page-builder/faq.md"
}
]
}
],
"/products/feedback-flow/": [
{
"text": "Introduction - FeedbackFlow",
"link": "/products/feedback-flow/index.md"
},
{
"text": "Introduction",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Overview",
"link": "/products/feedback-flow/introduction/overview.md"
},
{
"text": "Who Should Use This",
"link": "/products/feedback-flow/introduction/who-should-use.md"
},
{
"text": "System Requirements",
"link": "/products/feedback-flow/introduction/system-requirements.md"
}
]
},
{
"text": "Getting Started",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Installation Guide",
"link": "/products/feedback-flow/getting-started/installation.md"
},
{
"text": "Post-Installation Setup",
"link": "/products/feedback-flow/getting-started/post-installation.md"
},
{
"text": "Accessing Admin Dashboard",
"link": "/products/feedback-flow/getting-started/admin-access.md"
}
]
},
{
"text": "Configuration",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "General Settings",
"link": "/products/feedback-flow/configuration/general-settings.md"
},
{
"text": "Email Configuration",
"link": "/products/feedback-flow/configuration/email-configuration.md"
},
{
"text": "OAuth Providers Setup",
"link": "/products/feedback-flow/configuration/oauth-setup.md"
},
{
"text": "ReCAPTCHA Setup",
"link": "/products/feedback-flow/configuration/recaptcha.md"
},
{
"text": "Advanced Settings",
"link": "/products/feedback-flow/configuration/advanced-settings.md"
}
]
},
{
"text": "Board Management",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Creating Boards",
"link": "/products/feedback-flow/features/boards/creating-boards.md"
},
{
"text": "Board Customization",
"link": "/products/feedback-flow/features/boards/customization.md"
},
{
"text": "Board Settings",
"link": "/products/feedback-flow/features/boards/settings.md"
}
]
},
{
"text": "Feature Requests",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Submitting Requests",
"link": "/products/feedback-flow/features/feature-requests/submitting.md"
},
{
"text": "Managing Requests",
"link": "/products/feedback-flow/features/feature-requests/managing.md"
},
{
"text": "Status & Workflow",
"link": "/products/feedback-flow/features/feature-requests/workflow.md"
},
{
"text": "Merging Duplicates",
"link": "/products/feedback-flow/features/feature-requests/merging.md"
}
]
},
{
"text": "Engagement Features",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Voting System",
"link": "/products/feedback-flow/features/voting.md"
},
{
"text": "Threading & Replies",
"link": "/products/feedback-flow/features/comments/threading.md"
},
{
"text": "User Mentions",
"link": "/products/feedback-flow/features/comments/mentions.md"
},
{
"text": "Comment Moderation",
"link": "/products/feedback-flow/features/comments/moderation.md"
}
]
},
{
"text": "Public Features",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Roadmap Management",
"link": "/products/feedback-flow/features/roadmap.md"
},
{
"text": "Changelog Management",
"link": "/products/feedback-flow/features/changelog.md"
}
]
},
{
"text": "AI Features",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Overview & Setup",
"link": "/products/feedback-flow/ai-features/overview.md"
},
{
"text": "Spam Detection",
"link": "/products/feedback-flow/ai-features/spam-detection.md"
},
{
"text": "Content Generation",
"link": "/products/feedback-flow/ai-features/content-generation.md"
},
{
"text": "Trust Score System",
"link": "/products/feedback-flow/ai-features/trust-system.md"
}
]
},
{
"text": "Email System",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Email Settings",
"link": "/products/feedback-flow/email/settings.md"
},
{
"text": "User Preferences",
"link": "/products/feedback-flow/email/preferences.md"
},
{
"text": "Digest Emails",
"link": "/products/feedback-flow/email/digests.md"
}
]
},
{
"text": "Integrations",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Webhooks",
"link": "/products/feedback-flow/integrations/webhooks.md"
},
{
"text": "Slack Integration",
"link": "/products/feedback-flow/integrations/slack.md"
}
]
},
{
"text": "User Management",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Roles & Permissions",
"link": "/products/feedback-flow/users/roles-permissions.md"
},
{
"text": "Team Members",
"link": "/products/feedback-flow/users/team-members.md"
},
{
"text": "User Profiles",
"link": "/products/feedback-flow/users/profiles.md"
},
{
"text": "OAuth Login",
"link": "/products/feedback-flow/users/oauth-login.md"
}
]
},
{
"text": "Customization",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Theme & Appearance",
"link": "/products/feedback-flow/customization/theme.md"
},
{
"text": "Landing Page",
"link": "/products/feedback-flow/customization/landing-page.md"
},
{
"text": "Custom Code Injection",
"link": "/products/feedback-flow/customization/custom-code.md"
}
]
},
{
"text": "Administration",
"collapsible": true,
"collapsed": false,
"items": [
{
"text": "Admin Dashboard",
"link": "/products/feedback-flow/admin/dashboard.md"
},
{
"text": "User Management",
"link": "/products/feedback-flow/admin/user-management.md"
},
{
"text": "Content Moderation",
"link": "/products/feedback-flow/admin/moderation.md"
},
{
"text": "System Updates",
"link": "/products/feedback-flow/admin/system-updates.md"
}
]
},
{
"text": "FAQ π‘",
"link": "/products/feedback-flow/faq.md"
}
]
},
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/CorbitalTechnologies"
}
],
"footer": {
"message": "Β© 2024 - Corbital Technologies. All rights reserved."
}
}Page Data β
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "products/feedback-flow/api-examples.md",
"filePath": "products/feedback-flow/api-examples.md"
}Page Frontmatter β
{
"outline": "deep"
}More β
Check out the documentation for the full list of runtime APIs.