{"templateId":"GuidePage","sharedDataIds":{"sidebar":"sidebar-miniapps/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Metadata & Marketplace Listing","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":"metadata--marketplace-listing","__idx":0},"children":["Metadata & Marketplace Listing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your MiniApp appears in the Karzoun Marketplace. These fields control how it's displayed:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n  title: 'My Service',                                    // Main heading\n  label: 'My Service',                                    // Badge/tag label\n  shortDescription: 'Automate workflows with My Service', // Subtitle\n  description: `\nConnect **My Service** to Karzoun to:\n\n- Automatically create tasks from incoming orders\n- Send notifications when customer actions happen\n- Sync data bi-directionally\n\n## Setup Instructions\n\n1. Create an API key in My Service settings\n2. Install this app from the Marketplace\n3. Paste your API key and click Connect\n\n## Supported Events\n\n| Event              | Description                    |\n| ------------------ | ------------------------------ |\n| order.created      | A new order is placed          |\n| customer.updated   | Customer profile is updated    |\n  `,\n  icon: 'https://cdn.example.com/icon.svg',              // App icon (SVG recommended)\n  logo: 'https://cdn.example.com/logo.svg',              // Full logo\n  docsUrl: 'https://docs.example.com/karzoun-integration',// External docs link\n  youtubeId: 'dQw4w9WgXcQ',                              // Tutorial video (optional)\n  category: 'ecommerce',                                  // Filter category\n  status: 'private',                                       // Karzoun sets 'public' after approval\n  version: '1.0.0',                                       // Semantic version\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"asset-checklist","__idx":1},"children":["Asset checklist"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Asset"},"children":["Asset"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Requirement"},"children":["Requirement"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["icon"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTPS URL, SVG or PNG, square, readable at 32×32"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["logo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTPS URL, horizontal logo for detail page"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docsUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your setup guide for end users (not Karzoun docs)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Markdown with setup steps and event table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["youtubeId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional walkthrough video"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Host icons and logos on infrastructure you control."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-submission","__idx":2},"children":["Before submission"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shortDescription"]}," under ~120 characters"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," includes numbered setup steps"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}," matches Marketplace filters"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}," follows semver"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"input","attributes":{"checked":false,"type":"checkbox","readOnly":true},"children":[]}," Draft uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status: 'private'"]}," until Karzoun approves"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/miniapps/guides/submission"},"children":["Submit for review"]}," with your JSON definition and sandbox credentials."]}]},"headings":[{"value":"Metadata & Marketplace Listing","id":"metadata--marketplace-listing","depth":1},{"value":"Asset checklist","id":"asset-checklist","depth":2},{"value":"Before submission","id":"before-submission","depth":2}],"frontmatter":{"title":"Marketplace listing","titleTranslationKey":"sidebar.miniapps.marketplace","audience":"developer","status":"published","locales":["en"],"template":"GuidePage","seo":{"title":"Metadata & Marketplace Listing"}},"lastModified":"2026-06-23T12:06:12.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/miniapps/guides/marketplace","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}