[{"data":1,"prerenderedAt":379},["ShallowReactive",2],{"navigation_docs":3,"-docs-integrations-getting-started-who-is-it-for":214,"-docs-integrations-getting-started-who-is-it-for-surround":374},[4,74,96,130],{"title":5,"path":6,"stem":7,"children":8},"Assets API","\u002Fdocs\u002Fassets","docs\u002Fassets\u002Findex",[9,10,32,57],{"title":5,"path":6,"stem":7},{"title":11,"path":12,"stem":13,"children":14,"page":31},"Getting Started","\u002Fdocs\u002Fassets\u002Fgetting-started","docs\u002Fassets\u002F1.getting-started",[15,19,23,27],{"title":16,"path":17,"stem":18},"Base URL","\u002Fdocs\u002Fassets\u002Fgetting-started\u002Fbase-url","docs\u002Fassets\u002F1.getting-started\u002F1.base-url",{"title":20,"path":21,"stem":22},"Important Notes","\u002Fdocs\u002Fassets\u002Fgetting-started\u002Fimportant-notes","docs\u002Fassets\u002F1.getting-started\u002F2.important-notes",{"title":24,"path":25,"stem":26},"URL Format","\u002Fdocs\u002Fassets\u002Fgetting-started\u002Furl-format","docs\u002Fassets\u002F1.getting-started\u002F3.url-format",{"title":28,"path":29,"stem":30},"Custom Domains","\u002Fdocs\u002Fassets\u002Fgetting-started\u002Fcustom-domains","docs\u002Fassets\u002F1.getting-started\u002F4.custom-domains",false,{"title":33,"path":34,"stem":35,"children":36,"page":31},"Usage","\u002Fdocs\u002Fassets\u002Fusage","docs\u002Fassets\u002F2.usage",[37,41,45,49,53],{"title":38,"path":39,"stem":40},"Transforms","\u002Fdocs\u002Fassets\u002Fusage\u002Ftransforms","docs\u002Fassets\u002F2.usage\u002F1.transforms",{"title":42,"path":43,"stem":44},"Caching","\u002Fdocs\u002Fassets\u002Fusage\u002Fcaching","docs\u002Fassets\u002F2.usage\u002F2.caching",{"title":46,"path":47,"stem":48},"Recipes","\u002Fdocs\u002Fassets\u002Fusage\u002Frecipes","docs\u002Fassets\u002F2.usage\u002F3.recipes",{"title":50,"path":51,"stem":52},"Best Practices","\u002Fdocs\u002Fassets\u002Fusage\u002Fbest-practices","docs\u002Fassets\u002F2.usage\u002F4.best-practices",{"title":54,"path":55,"stem":56},"Reference","\u002Fdocs\u002Fassets\u002Fusage\u002Freference","docs\u002Fassets\u002F2.usage\u002F5.reference",{"title":58,"path":59,"stem":60,"children":61,"page":31},"Integration","\u002Fdocs\u002Fassets\u002Fintegration","docs\u002Fassets\u002F3.integration",[62,66,70],{"title":63,"path":64,"stem":65},"Nuxt","\u002Fdocs\u002Fassets\u002Fintegration\u002Fnuxt","docs\u002Fassets\u002F3.integration\u002F1.nuxt",{"title":67,"path":68,"stem":69},"Next.js","\u002Fdocs\u002Fassets\u002Fintegration\u002Fnextjs","docs\u002Fassets\u002F3.integration\u002F2.nextjs",{"title":71,"path":72,"stem":73},"Plain HTML","\u002Fdocs\u002Fassets\u002Fintegration\u002Fhtml","docs\u002Fassets\u002F3.integration\u002F3.html",{"title":75,"path":76,"stem":77,"children":78},"Events API","\u002Fdocs\u002Fevents","docs\u002Fevents\u002Findex",[79,80],{"title":75,"path":76,"stem":77},{"title":11,"path":81,"stem":82,"children":83,"page":31},"\u002Fdocs\u002Fevents\u002Fgetting-started","docs\u002Fevents\u002F1.getting-started",[84,88,92],{"title":85,"path":86,"stem":87},"Subscribing","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fsubscribing","docs\u002Fevents\u002F1.getting-started\u002F1.subscribing",{"title":89,"path":90,"stem":91},"Event Delivery","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fevent-delivery","docs\u002Fevents\u002F1.getting-started\u002F2.event-delivery",{"title":93,"path":94,"stem":95},"Event Reference","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fevent-reference","docs\u002Fevents\u002F1.getting-started\u002F3.event-reference",{"title":97,"path":98,"stem":99,"children":100},"Integrations API","\u002Fdocs\u002Fintegrations","docs\u002Fintegrations\u002Findex",[101,102],{"title":97,"path":98,"stem":99},{"title":11,"path":103,"stem":104,"children":105,"page":31},"\u002Fdocs\u002Fintegrations\u002Fgetting-started","docs\u002Fintegrations\u002F1.getting-started",[106,110,114,118,122,126],{"title":107,"path":108,"stem":109},"Why Use It?","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fwhy-integrations-api","docs\u002Fintegrations\u002F1.getting-started\u002F1.why-integrations-api",{"title":111,"path":112,"stem":113},"Use Cases","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fwho-is-it-for","docs\u002Fintegrations\u002F1.getting-started\u002F2.who-is-it-for",{"title":115,"path":116,"stem":117},"Pre-built Connectors","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fpre-built-integrations","docs\u002Fintegrations\u002F1.getting-started\u002F3.pre-built-integrations",{"title":119,"path":120,"stem":121},"Custom Inbound","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fcustom-inbound-api","docs\u002Fintegrations\u002F1.getting-started\u002F4.custom-inbound-api",{"title":123,"path":124,"stem":125},"Event Lifecycle","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fevent-lifecycle","docs\u002Fintegrations\u002F1.getting-started\u002F5.event-lifecycle",{"title":127,"path":128,"stem":129},"API Endpoints","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fmanagement-api-endpoints","docs\u002Fintegrations\u002F1.getting-started\u002F6.management-api-endpoints",{"title":131,"path":132,"stem":133,"children":134,"redirect":136},"MCP Server","\u002Fdocs\u002Fmcp","docs\u002Fmcp\u002Findex",[135,137,156,189],{"title":131,"path":132,"stem":133,"redirect":136},"\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fvscode",{"title":11,"path":138,"stem":139,"children":140,"page":31},"\u002Fdocs\u002Fmcp\u002Fgetting-started","docs\u002Fmcp\u002F1.getting-started",[141,144,148,152],{"title":142,"path":136,"stem":143},"VS Code","docs\u002Fmcp\u002F1.getting-started\u002F1.vscode",{"title":145,"path":146,"stem":147},"Claude Desktop","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fclaude-desktop","docs\u002Fmcp\u002F1.getting-started\u002F2.claude-desktop",{"title":149,"path":150,"stem":151},"Cursor","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fcursor","docs\u002Fmcp\u002F1.getting-started\u002F3.cursor",{"title":153,"path":154,"stem":155},"Verify Connection","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fverify","docs\u002Fmcp\u002F1.getting-started\u002F4.verify",{"title":157,"path":158,"stem":159,"children":160,"page":31},"Tools","\u002Fdocs\u002Fmcp\u002Ftools","docs\u002Fmcp\u002F2.tools",[161,165,169,173,177,181,185],{"title":162,"path":163,"stem":164},"list_endpoints","\u002Fdocs\u002Fmcp\u002Ftools\u002Flist-endpoints","docs\u002Fmcp\u002F2.tools\u002F1.list-endpoints",{"title":166,"path":167,"stem":168},"get_endpoint","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-endpoint","docs\u002Fmcp\u002F2.tools\u002F2.get-endpoint",{"title":170,"path":171,"stem":172},"get_schema","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-schema","docs\u002Fmcp\u002F2.tools\u002F3.get-schema",{"title":174,"path":175,"stem":176},"list_schemas","\u002Fdocs\u002Fmcp\u002Ftools\u002Flist-schemas","docs\u002Fmcp\u002F2.tools\u002F4.list-schemas",{"title":178,"path":179,"stem":180},"search_docs","\u002Fdocs\u002Fmcp\u002Ftools\u002Fsearch-docs","docs\u002Fmcp\u002F2.tools\u002F5.search-docs",{"title":182,"path":183,"stem":184},"get_api_overview","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-api-overview","docs\u002Fmcp\u002F2.tools\u002F6.get-api-overview",{"title":186,"path":187,"stem":188},"get_description","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-description","docs\u002Fmcp\u002F2.tools\u002F7.get-description",{"title":190,"path":191,"stem":192,"children":193,"page":31},"Examples","\u002Fdocs\u002Fmcp\u002Fexamples","docs\u002Fmcp\u002F3.examples",[194,198,202,206,210],{"title":195,"path":196,"stem":197},"Exploring an API","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fexploring-an-api","docs\u002Fmcp\u002F3.examples\u002F1.exploring-an-api",{"title":199,"path":200,"stem":201},"Building a Feature","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fbuilding-a-feature","docs\u002Fmcp\u002F3.examples\u002F2.building-a-feature",{"title":203,"path":204,"stem":205},"Understanding Models","\u002Fdocs\u002Fmcp\u002Fexamples\u002Funderstanding-models","docs\u002Fmcp\u002F3.examples\u002F3.understanding-models",{"title":207,"path":208,"stem":209},"Code Review","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fcode-review","docs\u002Fmcp\u002F3.examples\u002F4.code-review",{"title":211,"path":212,"stem":213},"Tips","\u002Fdocs\u002Fmcp\u002Fexamples\u002Ftips","docs\u002Fmcp\u002F3.examples\u002F5.tips",{"id":215,"title":111,"body":216,"description":367,"extension":368,"links":369,"meta":370,"navigation":371,"path":112,"seo":372,"stem":113,"__hash__":373},"docs\u002Fdocs\u002Fintegrations\u002F1.getting-started\u002F2.who-is-it-for.md",{"type":217,"value":218,"toc":356},"minimark",[219,224,228,233,239,242,247,257,261,266,269,273,278,281,285,290,293,297,302,305,309,314,317,321,328,341,348],[220,221,223],"h1",{"id":222},"who-is-it-for","Who Is It For?",[225,226,227],"p",{},"The Integrations API is designed for anyone who needs to move data between Avvyr and external systems — reliably and with full visibility. Here are the most common scenarios.",[229,230,232],"h2",{"id":231},"erp-back-office-integrations","ERP & back-office integrations",[225,234,235],{},[236,237,238],"strong",{},"You run an ERP (Business Central, Fortnox, custom) and need to keep it in sync with Avvyr.",[225,240,241],{},"Products, inventory levels, prices, and orders flow between your ERP and the commerce platform. The Integrations API ensures every transaction is tracked, retried on failure, and visible in a dashboard your operations team can monitor.",[225,243,244],{},[236,245,246],{},"Typical data flows:",[248,249,250,254],"ul",{},[251,252,253],"li",{},"ERP → Avvyr: product catalogue, prices, inventory levels",[251,255,256],{},"Avvyr → ERP: completed orders, customer data, invoices",[229,258,260],{"id":259},"e-commerce-platform-migration","E-commerce platform migration",[225,262,263],{},[236,264,265],{},"You're migrating from Shopify, WooCommerce, Magento, or another platform.",[225,267,268],{},"Use the Custom Inbound API to push historical data (products, customers, orders) into Avvyr in bulk. Every import batch is tracked, so you know exactly what succeeded and what needs re-running.",[229,270,272],{"id":271},"warehouse-logistics-systems","Warehouse & logistics systems",[225,274,275],{},[236,276,277],{},"Your WMS or 3PL sends inventory updates and shipment confirmations.",[225,279,280],{},"Route these through the Integrations API so inventory adjustments and order status updates are tracked. If a shipment confirmation fails to process, it's retried automatically — not silently dropped.",[229,282,284],{"id":283},"marketing-crm-automation","Marketing & CRM automation",[225,286,287],{},[236,288,289],{},"You want order events, cart abandonment, and customer data in Klaviyo, HubSpot, or another marketing tool.",[225,291,292],{},"Pre-built outbound connectors push events to marketing platforms as they happen. The transaction log shows exactly which events were delivered and which need attention.",[229,294,296],{"id":295},"custom-or-in-house-systems","Custom or in-house systems",[225,298,299],{},[236,300,301],{},"You've built your own tools and need to push data into Avvyr.",[225,303,304],{},"The Custom Inbound API gives you a standard REST endpoint with API key auth. You don't need to learn the full Management API surface — just send the right action and payload. The platform handles validation, queuing, processing, and error recovery.",[229,306,308],{"id":307},"operational-teams-without-developer-access","Operational teams without developer access",[225,310,311],{},[236,312,313],{},"Your ops team needs to see what's flowing between systems.",[225,315,316],{},"The integration dashboard provides a visual view of all transactions across all integrations. Filter by status, time range, or integration. Drill into any event to see communication logs, payloads, and error details. Resubmit failed events with one click — no developer intervention needed.",[229,318,320],{"id":319},"when-is-it-not-the-right-fit","When is it not the right fit?",[225,322,323,324,327],{},"The Integrations API is a ",[236,325,326],{},"separately licensed add-on",", so it's not included in every Avvyr plan. If your needs are simple — a few API calls from a cron job, for example — the Management API might be all you need.",[225,329,330,331,334,335,340],{},"More importantly, if you ",[236,332,333],{},"already have your own integration platform"," (MuleSoft, Azure Integration Services, Boomi, or a custom-built pipeline) that handles retries, dead-letter queues, monitoring, and logging — adding the Integrations API on top is redundant. You'd have two platforms trying to manage the same error recovery, which makes debugging harder rather than easier. In that case, call the ",[336,337,339],"a",{"href":338},"\u002Fmanagement\u002Freference","Management API"," directly and let your existing platform handle the orchestration.",[225,342,343,344,347],{},"See ",[336,345,346],{"href":108},"Why the Integrations API?"," for a detailed comparison.",[349,350,352,355],"callout",{"icon":351},"i-lucide-mail",[236,353,354],{},"Interested?"," Contact your Avvyr account manager to discuss licensing and get started with the Integrations API.",{"title":357,"searchDepth":358,"depth":358,"links":359},"",2,[360,361,362,363,364,365,366],{"id":231,"depth":358,"text":232},{"id":259,"depth":358,"text":260},{"id":271,"depth":358,"text":272},{"id":283,"depth":358,"text":284},{"id":295,"depth":358,"text":296},{"id":307,"depth":358,"text":308},{"id":319,"depth":358,"text":320},"Use cases, target audiences, and scenarios where the Integrations API adds the most value","md",null,{},true,{"title":111,"description":367},"1HksquFmwAyfYsaq21ltUpykn6AVZC8c92g7flY0qeM",[375,377],{"title":107,"path":108,"stem":109,"description":376,"children":-1},"How the Integrations API compares to calling the Management API directly — and when each approach makes sense",{"title":115,"path":116,"stem":117,"description":378,"children":-1},"Ready-to-use connectors for ERP, accounting, marketing, shipping, and more",1775725944132]