{"templateId":"GuidePage","sharedDataIds":{"sidebar":"sidebar-miniapps/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["callout"]},"type":"markdown"},"seo":{"title":"API reference","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":"api-reference","__idx":0},"children":["API reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["MiniApps expose a small ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REST surface"]}," for OAuth and inbound webhooks. Tenants interact with installed MiniApps through ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GraphQL"]}," in the Karzoun app (Marketplace install, credentials, action execution)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Base path: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{SAAS_API_URL}/miniapps"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rest-endpoints-runtime","__idx":1},"children":["REST endpoints (runtime)"]},{"$$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":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/{appNs}/oauth2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start or complete OAuth 2.0 authorization"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/{appNs}/webhooks"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Receive webhooks from external providers"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Register these URLs with your provider:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Redirect URI:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{SAAS_API_URL}/miniapps/{ns}/oauth2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhook URL:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{SAAS_API_URL}/miniapps/{ns}/webhooks"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"graphql--marketplace--install","__idx":2},"children":["GraphQL — Marketplace & install"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Available to authenticated Karzoun users in the app. See the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/developers/apis/public-api"},"children":["public GraphQL reference"]}," for full argument types."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"queries","__idx":3},"children":["Queries"]},{"$$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":"Query"},"children":["Query"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["listMiniAppsGeneralInfo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Browse Marketplace apps (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["installStatus"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["miniAppGeneralInfo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Single app listing by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ns"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["miniAppDetail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Installed app detail — actions and forms (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["miniAppNs"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["miniAppsActionSources"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["RPC dropdown data (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["miniAppNs"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sourceKey"]},", …)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["testMiniApiRequest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Test one action request (developer tooling in app)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["miniAppDashboardConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dashboard iframe bridge — actions and auth state"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"mutations","__idx":4},"children":["Mutations"]},{"$$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":"Mutation"},"children":["Mutation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["installMiniApp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Install from Marketplace (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ns"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["saveMiniAppCredentials"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Save auth credentials; runs token exchange + registration"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["executeMiniAppAction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run an action with server-side credentials (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["appNs"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["actionName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["formInput"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"Callout","attributes":{"type":"warning","title":"Rate limits"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Action execution is rate-limited per user per app (30 requests / 60 seconds). Design actions to be idempotent where possible."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tenant-webhooks-vs-miniapp-webhooks","__idx":5},"children":["Tenant webhooks vs MiniApp webhooks"]},{"$$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":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/developers/guides/webhooks"},"children":["Tenant webhooks"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"MiniApp webhooks"},"children":["MiniApp webhooks"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Direction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Karzoun → your server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provider → Karzoun"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Purpose"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notify your backend about workspace events"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ingest provider events into automations/sync"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Registration"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webhooksAdd"]}," GraphQL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defined in MiniApp JSON + provider dashboard"]}]}]}]}]}]},"headings":[{"value":"API reference","id":"api-reference","depth":1},{"value":"REST endpoints (runtime)","id":"rest-endpoints-runtime","depth":2},{"value":"GraphQL — Marketplace & install","id":"graphql--marketplace--install","depth":2},{"value":"Queries","id":"queries","depth":3},{"value":"Mutations","id":"mutations","depth":3},{"value":"Tenant webhooks vs MiniApp webhooks","id":"tenant-webhooks-vs-miniapp-webhooks","depth":2}],"frontmatter":{"title":"API reference","titleTranslationKey":"sidebar.miniapps.apiReference","audience":"developer","status":"published","locales":["en"],"template":"GuidePage","seo":{"title":"API reference"}},"lastModified":"2026-06-23T12:06:12.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/miniapps/reference/api-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}