[{"data":1,"prerenderedAt":794},["ShallowReactive",2],{"navigation_docs":3,"docs-site-config":269,"-docs-integrations-getting-started-why-integrations-api":397,"-docs-integrations-getting-started-why-integrations-api-surround":789},[4,74,78,100,134,214],{"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},"Early Access","\u002Fdocs\u002Fearly-access","docs\u002Fearly-access",{"title":79,"path":80,"stem":81,"children":82},"Events API","\u002Fdocs\u002Fevents","docs\u002Fevents\u002Findex",[83,84],{"title":79,"path":80,"stem":81},{"title":11,"path":85,"stem":86,"children":87,"page":31},"\u002Fdocs\u002Fevents\u002Fgetting-started","docs\u002Fevents\u002F1.getting-started",[88,92,96],{"title":89,"path":90,"stem":91},"Subscribing","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fsubscribing","docs\u002Fevents\u002F1.getting-started\u002F1.subscribing",{"title":93,"path":94,"stem":95},"Event Delivery","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fevent-delivery","docs\u002Fevents\u002F1.getting-started\u002F2.event-delivery",{"title":97,"path":98,"stem":99},"Event Reference","\u002Fdocs\u002Fevents\u002Fgetting-started\u002Fevent-reference","docs\u002Fevents\u002F1.getting-started\u002F3.event-reference",{"title":101,"path":102,"stem":103,"children":104},"Integrations API","\u002Fdocs\u002Fintegrations","docs\u002Fintegrations\u002Findex",[105,106],{"title":101,"path":102,"stem":103},{"title":11,"path":107,"stem":108,"children":109,"page":31},"\u002Fdocs\u002Fintegrations\u002Fgetting-started","docs\u002Fintegrations\u002F1.getting-started",[110,114,118,122,126,130],{"title":111,"path":112,"stem":113},"Why Use It?","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fwhy-integrations-api","docs\u002Fintegrations\u002F1.getting-started\u002F1.why-integrations-api",{"title":115,"path":116,"stem":117},"Use Cases","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fwho-is-it-for","docs\u002Fintegrations\u002F1.getting-started\u002F2.who-is-it-for",{"title":119,"path":120,"stem":121},"Pre-built Connectors","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fpre-built-integrations","docs\u002Fintegrations\u002F1.getting-started\u002F3.pre-built-integrations",{"title":123,"path":124,"stem":125},"Custom Inbound","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fcustom-inbound-api","docs\u002Fintegrations\u002F1.getting-started\u002F4.custom-inbound-api",{"title":127,"path":128,"stem":129},"Event Lifecycle","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fevent-lifecycle","docs\u002Fintegrations\u002F1.getting-started\u002F5.event-lifecycle",{"title":131,"path":132,"stem":133},"API Endpoints","\u002Fdocs\u002Fintegrations\u002Fgetting-started\u002Fmanagement-api-endpoints","docs\u002Fintegrations\u002F1.getting-started\u002F6.management-api-endpoints",{"title":135,"path":136,"stem":137,"children":138,"redirect":140},"MCP Server","\u002Fdocs\u002Fmcp","docs\u002Fmcp\u002Findex",[139,141,160,173,183],{"title":135,"path":136,"stem":137,"redirect":140},"\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fvscode",{"title":11,"path":142,"stem":143,"children":144,"page":31},"\u002Fdocs\u002Fmcp\u002Fgetting-started","docs\u002Fmcp\u002F1.getting-started",[145,148,152,156],{"title":146,"path":140,"stem":147},"VS Code","docs\u002Fmcp\u002F1.getting-started\u002F1.vscode",{"title":149,"path":150,"stem":151},"Claude Desktop","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fclaude-desktop","docs\u002Fmcp\u002F1.getting-started\u002F2.claude-desktop",{"title":153,"path":154,"stem":155},"Cursor","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fcursor","docs\u002Fmcp\u002F1.getting-started\u002F3.cursor",{"title":157,"path":158,"stem":159},"Verify Connection","\u002Fdocs\u002Fmcp\u002Fgetting-started\u002Fverify","docs\u002Fmcp\u002F1.getting-started\u002F4.verify",{"title":161,"path":162,"stem":163,"children":164,"page":31},"Tools","\u002Fdocs\u002Fmcp\u002Ftools","docs\u002Fmcp\u002F2.tools",[165,169],{"title":166,"path":167,"stem":168},"search","\u002Fdocs\u002Fmcp\u002Ftools\u002Fsearch-docs","docs\u002Fmcp\u002F2.tools\u002F5.search-docs",{"title":170,"path":171,"stem":172},"list_articles","\u002Fdocs\u002Fmcp\u002Ftools\u002Fget-description","docs\u002Fmcp\u002F2.tools\u002F7.get-description",{"title":174,"path":175,"stem":176,"children":177},"API Server","\u002Fdocs\u002Fmcp\u002Fapi-server","docs\u002Fmcp\u002F3.api-server\u002Findex",[178,179],{"title":174,"path":175,"stem":176},{"title":180,"path":181,"stem":182},"Available Tools","\u002Fdocs\u002Fmcp\u002Fapi-server\u002Ftools","docs\u002Fmcp\u002F3.api-server\u002F1.tools",{"title":184,"path":185,"stem":186,"children":187,"page":31},"Examples","\u002Fdocs\u002Fmcp\u002Fexamples","docs\u002Fmcp\u002F4.examples",[188,192,196,200,204,208,212],{"title":189,"path":190,"stem":191},"Exploring an API","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fexploring-an-api","docs\u002Fmcp\u002F4.examples\u002F1.exploring-an-api",{"title":193,"path":194,"stem":195},"Building a Feature","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fbuilding-a-feature","docs\u002Fmcp\u002F4.examples\u002F2.building-a-feature",{"title":197,"path":198,"stem":199},"Understanding Models","\u002Fdocs\u002Fmcp\u002Fexamples\u002Funderstanding-models","docs\u002Fmcp\u002F4.examples\u002F3.understanding-models",{"title":201,"path":202,"stem":203},"Code Review","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fcode-review","docs\u002Fmcp\u002F4.examples\u002F4.code-review",{"title":205,"path":206,"stem":207},"Combining MCP Servers","\u002Fdocs\u002Fmcp\u002Fexamples\u002Fmulti-mcp","docs\u002Fmcp\u002F4.examples\u002F5.multi-mcp",{"title":209,"path":210,"stem":211},"Tips","\u002Fdocs\u002Fmcp\u002Fexamples\u002Ftips","docs\u002Fmcp\u002F4.examples\u002F5.tips",{"title":209,"path":210,"stem":213},"docs\u002Fmcp\u002F4.examples\u002F6.tips",{"title":215,"path":216,"stem":217,"children":218,"page":31},"Storefront Sdk","\u002Fdocs\u002Fstorefront-sdk","docs\u002Fstorefront-sdk",[219,231,256],{"title":11,"path":220,"stem":221,"children":222,"page":31},"\u002Fdocs\u002Fstorefront-sdk\u002Fgetting-started","docs\u002Fstorefront-sdk\u002F1.getting-started",[223,227],{"title":224,"path":225,"stem":226},"Installation","\u002Fdocs\u002Fstorefront-sdk\u002Fgetting-started\u002Finstallation","docs\u002Fstorefront-sdk\u002F1.getting-started\u002F1.installation",{"title":228,"path":229,"stem":230},"Configuration","\u002Fdocs\u002Fstorefront-sdk\u002Fgetting-started\u002Fconfiguration","docs\u002Fstorefront-sdk\u002F1.getting-started\u002F2.configuration",{"title":232,"path":233,"stem":234,"children":235,"page":31},"Resources","\u002Fdocs\u002Fstorefront-sdk\u002Fresources","docs\u002Fstorefront-sdk\u002F2.resources",[236,240,244,248,252],{"title":237,"path":238,"stem":239},"Products","\u002Fdocs\u002Fstorefront-sdk\u002Fresources\u002Fproducts","docs\u002Fstorefront-sdk\u002F2.resources\u002F1.products",{"title":241,"path":242,"stem":243},"Cart","\u002Fdocs\u002Fstorefront-sdk\u002Fresources\u002Fcart","docs\u002Fstorefront-sdk\u002F2.resources\u002F2.cart",{"title":245,"path":246,"stem":247},"Auth","\u002Fdocs\u002Fstorefront-sdk\u002Fresources\u002Fauth","docs\u002Fstorefront-sdk\u002F2.resources\u002F3.auth",{"title":249,"path":250,"stem":251},"Checkout & Shipping","\u002Fdocs\u002Fstorefront-sdk\u002Fresources\u002Fcheckout-shipping","docs\u002Fstorefront-sdk\u002F2.resources\u002F4.checkout-shipping",{"title":253,"path":254,"stem":255},"Orders, Returns & Reviews","\u002Fdocs\u002Fstorefront-sdk\u002Fresources\u002Forders-returns-reviews","docs\u002Fstorefront-sdk\u002F2.resources\u002F5.orders-returns-reviews",{"title":257,"path":258,"stem":259,"children":260,"page":31},"Nuxt Layer","\u002Fdocs\u002Fstorefront-sdk\u002Fnuxt-layer","docs\u002Fstorefront-sdk\u002F3.nuxt-layer",[261,265],{"title":262,"path":263,"stem":264},"Overview","\u002Fdocs\u002Fstorefront-sdk\u002Fnuxt-layer\u002Foverview","docs\u002Fstorefront-sdk\u002F3.nuxt-layer\u002F1.overview",{"title":266,"path":267,"stem":268},"Composables","\u002Fdocs\u002Fstorefront-sdk\u002Fnuxt-layer\u002Fcomposables","docs\u002Fstorefront-sdk\u002F3.nuxt-layer\u002F2.composables",{"_uid":270,"component":271,"mega_menu":272},"ba7c13ba-e184-4f43-b10c-3ec3364eedb7","docsite_config",[273,332,377],{"_uid":274,"items":275,"label":329,"component":330,"panel_layout":331},"dfbeb399-33e6-48a4-995c-03754a63ea51",[276,288,294,301,308,314,319,324],{"to":277,"_uid":281,"icon":282,"label":283,"figure":284,"header":285,"component":286,"description":287},{"url":278,"linktype":279,"fieldtype":280,"cached_url":278},"\u002Fstorefront\u002Freference","url","multilink","7b65f0d2-45ed-4fd9-97cb-36e2adeb6ccb","i-lucide-shopping-cart","Storefront API","","Commerce","mega_item","Headless storefronts: catalog, cart, checkout",{"to":289,"_uid":290,"icon":291,"label":292,"figure":284,"header":285,"component":286,"description":293},{"url":216,"linktype":279,"fieldtype":280,"cached_url":216},"52070748-f27f-4067-a6a6-2456c34c8725","i-lucide-package","Storefront SDK","Typed client and Nuxt layer",{"to":295,"_uid":297,"icon":298,"label":299,"figure":284,"header":285,"component":286,"description":300},{"url":296,"linktype":279,"fieldtype":280,"cached_url":296},"\u002Fmanagement\u002Freference","228d563d-22c9-4f1b-8a5f-ac7b7d985b83","i-lucide-settings","Management API","Back-office integrations",{"to":302,"_uid":304,"icon":305,"label":306,"figure":284,"header":285,"component":286,"description":307},{"url":303,"linktype":279,"fieldtype":280,"cached_url":303},"\u002Fcatalog-sync\u002Freference","d7c58029-f0fd-4460-ab8f-ccb9d6fe6837","i-lucide-refresh-cw","Catalog Sync API","Bulk product and stock sync",{"to":309,"_uid":310,"icon":311,"label":5,"figure":284,"header":312,"component":286,"description":313},{"url":6,"linktype":279,"fieldtype":280,"cached_url":6},"1df97900-c66c-4afa-8e46-233625a74d25","i-lucide-image","Platform","Image CDN and transforms",{"to":315,"_uid":316,"icon":317,"label":79,"figure":284,"header":312,"component":286,"description":318},{"url":80,"linktype":279,"fieldtype":280,"cached_url":80},"d49f1c7d-4d48-4dc0-aa66-e2389d34d9e7","i-lucide-radio","Webhooks and event delivery",{"to":320,"_uid":321,"icon":322,"label":101,"figure":284,"header":312,"component":286,"description":323},{"url":102,"linktype":279,"fieldtype":280,"cached_url":102},"ebd16965-32df-44ed-8a1a-7f86d38652be","i-lucide-plug","Connect ERPs, carriers and PSPs",{"to":325,"_uid":326,"icon":327,"label":135,"figure":284,"header":312,"component":286,"description":328},{"url":136,"linktype":279,"fieldtype":280,"cached_url":136},"b0364d6f-c703-47a5-9c85-4a95790c8daa","i-lucide-bot","Avvyr in Claude, Cursor and VS Code","APIs","mega_group","ProductFeatures",{"_uid":333,"items":334,"label":376,"component":330,"panel_layout":331},"b10ed186-1293-4c37-9c84-d7dc33ea5348",[335,341,346,351,356,361,366,371],{"to":336,"_uid":337,"icon":338,"label":339,"figure":284,"header":340,"component":286},{"url":225,"linktype":279,"fieldtype":280,"cached_url":225},"5897c0b1-4b02-4dda-83a2-e2f1bc10de0e","i-lucide-download","SDK installation","Get started",{"to":342,"_uid":343,"icon":344,"label":345,"figure":284,"header":340,"component":286},{"url":258,"linktype":279,"fieldtype":280,"cached_url":258},"97b502e6-6329-43f1-a7f0-20a87d8ddb61","i-lucide-layers","Nuxt layer",{"to":347,"_uid":348,"icon":349,"label":350,"figure":284,"header":340,"component":286},{"url":90,"linktype":279,"fieldtype":280,"cached_url":90},"cfd226ed-05c2-4d54-83be-84e2ef4f53c0","i-lucide-bell","Subscribing to events",{"to":352,"_uid":353,"icon":354,"label":355,"figure":284,"header":340,"component":286},{"url":140,"linktype":279,"fieldtype":280,"cached_url":140},"a615a2dd-e0a8-47a8-8449-2ef6c21d7dcc","i-lucide-terminal","Connect the MCP server",{"to":357,"_uid":358,"icon":359,"label":360,"figure":284,"header":46,"component":286},{"url":39,"linktype":279,"fieldtype":280,"cached_url":39},"7dd7e47a-0657-43f6-9d5d-5cb25815bec5","i-lucide-crop","Image transforms",{"to":362,"_uid":363,"icon":364,"label":365,"figure":284,"header":46,"component":286},{"url":64,"linktype":279,"fieldtype":280,"cached_url":64},"7c4dd27d-7700-4893-8d76-6f2876b7cbac","i-lucide-code","Assets in Nuxt",{"to":367,"_uid":368,"icon":369,"label":370,"figure":284,"header":46,"component":286},{"url":194,"linktype":279,"fieldtype":280,"cached_url":194},"7834ff9b-a62d-4795-a5a3-265bccaeb697","i-lucide-wand-sparkles","Building a feature with MCP",{"to":372,"_uid":373,"icon":374,"label":375,"figure":284,"header":46,"component":286},{"url":76,"linktype":279,"fieldtype":280,"cached_url":76},"b967bbe2-23ff-4e64-836c-8b6054c27f9f","i-lucide-flask-conical","Early access","Guides",{"_uid":378,"items":379,"label":395,"component":330,"panel_layout":396},"79bc9cd1-4246-4178-a99d-3c0b333b295c",[380,388],{"to":381,"_uid":383,"icon":384,"label":385,"figure":284,"header":386,"component":286,"description":387},{"url":382,"linktype":279,"fieldtype":280,"cached_url":382},"https:\u002F\u002Fhelp.avvyr.com","e429b5df-877d-4eef-9e96-61c4aca3454a","i-lucide-life-buoy","Help Center","Using Avvyr","Guides for merchants and staff",{"to":389,"_uid":391,"icon":392,"label":393,"figure":284,"header":386,"component":286,"description":394},{"url":390,"linktype":279,"fieldtype":280,"cached_url":390},"https:\u002F\u002Favvyr.com\u002Fen","2685f915-3472-4ee5-828c-d1375dbe79ca","i-lucide-globe","avvyr.com","Product, pricing and partners","Help","Links",{"id":398,"title":111,"body":399,"description":782,"extension":783,"links":784,"meta":785,"navigation":786,"path":112,"seo":787,"stem":113,"__hash__":788},"docs\u002Fdocs\u002Fintegrations\u002F1.getting-started\u002F1.why-integrations-api.md",{"type":400,"value":401,"toc":773},"minimark",[402,407,416,421,432,436,613,617,620,658,664,668,671,713,717,723,728,737,740,745,751,758,762],[403,404,406],"h1",{"id":405},"why-the-integrations-api","Why the Integrations API?",[408,409,410,411,415],"p",{},"Everything the Integrations API does ultimately writes to the same Avvyr platform as the Management API. You ",[412,413,414],"strong",{},"can"," call the Management API directly to create orders, update inventory, upsert products, and so on. So why route data through the Integrations API instead?",[417,418,420],"h2",{"id":419},"the-short-answer","The short answer",[408,422,423,424,427,428,431],{},"The Management API is a ",[412,425,426],{},"synchronous CRUD interface",". The Integrations API is a ",[412,429,430],{},"managed integration platform"," built on top of it. When you use the Integrations API, you get everything a scalable integration pipeline should offer — without building it yourself.",[417,433,435],{"id":434},"what-the-integrations-api-adds","What the Integrations API adds",[437,438,439,453],"table",{},[440,441,442],"thead",{},[443,444,445,449,451],"tr",{},[446,447,448],"th",{},"Capability",[446,450,299],{},[446,452,101],{},[454,455,456,475,498,514,530,546,562,578,592],"tbody",{},[443,457,458,462,470],{},[459,460,461],"td",{},"Create \u002F update data in Avvyr",[459,463,464],{},[465,466],"icon",{"className":467,"name":469},[468],"text-green-500","i-lucide-check",[459,471,472],{},[465,473],{"className":474,"name":469},[468],[443,476,477,480,487],{},[459,478,479],{},"Transaction tracking & status",[459,481,482],{},[465,483],{"className":484,"name":486},[485],"text-red-400","i-lucide-x",[459,488,489,492,493,497],{},[465,490],{"className":491,"name":469},[468]," Every request is tracked as an IntegrationEvent with full lifecycle (",[494,495,496],"code",{},"queued → processing → success | failed",")",[443,499,500,503,508],{},[459,501,502],{},"Automatic retries",[459,504,505],{},[465,506],{"className":507,"name":486},[485],[459,509,510,513],{},[465,511],{"className":512,"name":469},[468]," Exponential backoff with configurable retry counts per event type",[443,515,516,519,524],{},[459,517,518],{},"Manual resubmission",[459,520,521],{},[465,522],{"className":523,"name":486},[485],[459,525,526,529],{},[465,527],{"className":528,"name":469},[468]," One-click retry from the dashboard or API",[443,531,532,535,540],{},[459,533,534],{},"Dead-letter handling",[459,536,537],{},[465,538],{"className":539,"name":486},[485],[459,541,542,545],{},[465,543],{"className":544,"name":469},[468]," Failed events are captured and surfaced for investigation",[443,547,548,551,556],{},[459,549,550],{},"Communication logs",[459,552,553],{},[465,554],{"className":555,"name":486},[485],[459,557,558,561],{},[465,559],{"className":560,"name":469},[468]," Full request\u002Fresponse logging with sensitive data masking",[443,563,564,567,572],{},[459,565,566],{},"Visual dashboard",[459,568,569],{},[465,570],{"className":571,"name":486},[485],[459,573,574,577],{},[465,575],{"className":576,"name":469},[468]," See all transactions, filter by status, drill into details",[443,579,580,583,586],{},[459,581,582],{},"Event ordering (FIFO)",[459,584,585],{},"N\u002FA",[459,587,588,591],{},[465,589],{"className":590,"name":469},[468]," Service Bus sessions ensure per-integration ordering",[443,593,594,597,603],{},[459,595,596],{},"Async processing",[459,598,599,602],{},[465,600],{"className":601,"name":486},[485]," Synchronous request\u002Fresponse",[459,604,605,608,609,612],{},[465,606],{"className":607,"name":469},[468]," Fire-and-forget with ",[494,610,611],{},"202 Accepted"," — processing happens asynchronously",[417,614,616],{"id":615},"when-to-use-the-management-api-directly","When to use the Management API directly",[408,618,619],{},"The Management API is the right choice when you:",[621,622,623,631,638,645,652],"ul",{},[624,625,626,627,630],"li",{},"Need ",[412,628,629],{},"synchronous responses"," — you want to know immediately if the operation succeeded",[624,632,633,634,637],{},"Are building ",[412,635,636],{},"admin tools or dashboards"," that read and write data interactively",[624,639,640,641,644],{},"Have a ",[412,642,643],{},"simple, low-volume integration"," where transaction tracking isn't worth the overhead",[624,646,647,648,651],{},"Want ",[412,649,650],{},"full control"," over error handling and retry logic in your own code",[624,653,654,657],{},[412,655,656],{},"Already have your own integration platform"," with retry logic, dead-letter handling, monitoring, and logging — adding the Integrations API on top would duplicate those capabilities and introduce an extra layer of error handling to manage",[659,660,663],"callout",{"color":661,"icon":662},"warning","i-lucide-alert-triangle","If you already operate a mature integration platform (e.g. MuleSoft, Azure Integration Services, Boomi, or a custom-built pipeline) that provides transaction tracking, retries, and monitoring — go straight to the Management API. Routing through the Integrations API would add a redundant processing layer, making debugging harder because failures could occur in either platform.",[417,665,667],{"id":666},"when-to-use-the-integrations-api","When to use the Integrations API",[408,669,670],{},"The Integrations API is the right choice when you:",[621,672,673,680,686,692,699,706],{},[624,674,675,676,679],{},"Are building a ",[412,677,678],{},"production data pipeline"," (ERP sync, inventory feed, order import) where reliability matters",[624,681,626,682,685],{},[412,683,684],{},"visibility"," into what's flowing between systems without building your own monitoring",[624,687,647,688,691],{},[412,689,690],{},"automatic retries"," so transient failures don't cause data loss",[624,693,694,695,698],{},"Have ",[412,696,697],{},"non-technical stakeholders"," who need to see integration status in a dashboard",[624,700,701,702,705],{},"Are syncing data from a system that ",[412,703,704],{},"doesn't need immediate confirmation"," — async is fine",[624,707,708,709,712],{},"Want to ",[412,710,711],{},"avoid building"," retry logic, dead-letter handling, logging, and monitoring yourself",[417,714,716],{"id":715},"a-practical-example","A practical example",[408,718,719,722],{},[412,720,721],{},"Scenario:"," Your ERP pushes inventory updates to Avvyr every 15 minutes.",[408,724,725],{},[412,726,727],{},"With the Management API:",[729,730,735],"pre",{"className":731,"code":733,"language":734},[732],"language-text","ERP → POST \u002Fv1\u002Finventory\u002Fbulk-update → 200 OK (or 500 → you handle retry)\n","text",[494,736,733],{"__ignoreMap":284},[408,738,739],{},"You get the data in, but if the call fails you need your own retry logic. No record of what was sent. No dashboard for ops to check.",[408,741,742],{},[412,743,744],{},"With the Integrations API:",[729,746,749],{"className":747,"code":748,"language":734},[732],"ERP → POST \u002Fintegrations\u002Fcustom\u002Finbound → 202 Accepted\n",[494,750,748],{"__ignoreMap":284},[408,752,753,754,757],{},"The platform handles the rest. Every update is tracked. Failures retry automatically. Your ops team can see exactly what's flowing in the dashboard. If something goes wrong at 2 AM, the event is waiting in ",[494,755,756],{},"failed"," status for someone to investigate and resubmit — not silently lost.",[417,759,761],{"id":760},"summary","Summary",[408,763,764,765,768,769,772],{},"Think of the Management API as the ",[412,766,767],{},"engine"," and the Integrations API as the ",[412,770,771],{},"managed highway"," built on top of it. If you're just moving one thing once, drive direct. If you're running a continuous data pipeline, use the highway — it has guardrails, traffic monitoring, and breakdown recovery built in.",{"title":284,"searchDepth":774,"depth":774,"links":775},2,[776,777,778,779,780,781],{"id":419,"depth":774,"text":420},{"id":434,"depth":774,"text":435},{"id":615,"depth":774,"text":616},{"id":666,"depth":774,"text":667},{"id":715,"depth":774,"text":716},{"id":760,"depth":774,"text":761},"How the Integrations API compares to calling the Management API directly — and when each approach makes sense","md",null,{},true,{"title":111,"description":782},"nx94ghqJsqnge7Z0lrf8oA_lnV_YL9vIe4loQfH4ybc",[790,792],{"title":101,"path":102,"stem":103,"description":791,"children":-1},"Connect Avvyr to external systems — ERP, accounting, marketing, shipping, and more",{"title":115,"path":116,"stem":117,"description":793,"children":-1},"Use cases, target audiences, and scenarios where the Integrations API adds the most value",1790695905021]