{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sdk/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Dashboard SDK","description":"Developer API, partner integration, MCP, SDK, and customer help center.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"dashboard-sdk","__idx":0},"children":["Dashboard SDK"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@karzoun/dashboard-sdk"]}," — lightweight SDK for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dashboard panel apps"]}," inside the Karzoun inbox iframe."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"install","__idx":1},"children":["Install"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"npm install @karzoun/dashboard-sdk\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-start","__idx":2},"children":["Quick start"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"import { createDashboard } from '@karzoun/dashboard-sdk';\n\nconst dashboard = createDashboard({\n  miniappId: 'YOUR_MINIAPP_ID',\n});\n\ndashboard.onContext((ctx) => {\n  console.log('Customer:', ctx.customer);\n});\n\nawait dashboard.executeAction('listOrders', { limit: 10 });\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":3},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Install and configure a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MiniApp"]}," with valid credentials (Settings → MiniApps)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dashboard App"]}," pointing to your hosted iframe URL (Settings → Dashboard Apps)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"features","__idx":4},"children":["Features"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Receive conversation and customer context from the host"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Execute authenticated actions via MiniApp (credentials never exposed to iframe)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Trigger host UI: toasts, notes, tags, navigation"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the package README under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v4UI/dashboard-sdk"]}," in the Karzoun monorepo for API reference, postMessage protocol, and examples."]}]},"headings":[{"value":"Dashboard SDK","id":"dashboard-sdk","depth":1},{"value":"Install","id":"install","depth":2},{"value":"Quick start","id":"quick-start","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Features","id":"features","depth":2}],"frontmatter":{"title":"Dashboard SDK","titleTranslationKey":"sidebar.sdk.dashboard","audience":"developer","status":"published","locales":["en"],"seo":{"title":"Dashboard SDK"}},"lastModified":"2026-06-23T11:22:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/sdk/dashboard-sdk","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}