[{"data":1,"prerenderedAt":692},["ShallowReactive",2],{"navigation_docs":3,"-docs-events-getting-started-subscribing":214,"-docs-events-getting-started-subscribing-surround":687},[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":85,"body":216,"description":681,"extension":682,"links":683,"meta":684,"navigation":302,"path":86,"seo":685,"stem":87,"__hash__":686},"docs\u002Fdocs\u002Fevents\u002F1.getting-started\u002F1.subscribing.md",{"type":217,"value":218,"toc":675},"minimark",[219,224,238,243,441,445,548,552,597,601,653,663,671],[220,221,223],"h1",{"id":222},"subscribing-to-events","Subscribing to Events",[225,226,227,228,232,233,237],"p",{},"Event subscriptions are managed through the ",[229,230,231],"strong",{},"Management API"," under the ",[234,235,236],"code",{},"\u002Fv1\u002F{tenantCode}\u002Faccount\u002Fevent-subscriptions"," endpoints. Each subscription targets a specific event type, a destination URL, and an authentication method.",[239,240,242],"h2",{"id":241},"quick-example","Quick example",[244,245,250],"pre",{"className":246,"code":247,"language":248,"meta":249,"style":249},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","POST \u002Fv1\u002F{tenantCode}\u002Faccount\u002Fevent-subscriptions\nAuthorization: Bearer \u003Ctoken>\nContent-Type: application\u002Fjson\n\n{\n  \"eventType\": \"orderCreated\",\n  \"destination\": \"https:\u002F\u002Fyour-system.com\u002Fwebhooks\u002Favvyr\",\n  \"enabled\": true,\n  \"authType\": \"hmac\",\n  \"hmacSecret\": \"your-secret-key\",\n  \"retryEnabled\": true,\n  \"retryCount\": 3,\n  \"comment\": \"Order sync to ERP\"\n}\n","bash","",[234,251,252,265,288,297,304,310,332,349,362,379,396,408,419,435],{"__ignoreMap":249},[253,254,257,261],"span",{"class":255,"line":256},"line",1,[253,258,260],{"class":259},"sBMFI","POST",[253,262,264],{"class":263},"sfazB"," \u002Fv1\u002F{tenantCode}\u002Faccount\u002Fevent-subscriptions\n",[253,266,268,271,274,278,281,285],{"class":255,"line":267},2,[253,269,270],{"class":259},"Authorization:",[253,272,273],{"class":263}," Bearer",[253,275,277],{"class":276},"sMK4o"," \u003C",[253,279,280],{"class":263},"toke",[253,282,284],{"class":283},"sTEyZ","n",[253,286,287],{"class":276},">\n",[253,289,291,294],{"class":255,"line":290},3,[253,292,293],{"class":259},"Content-Type:",[253,295,296],{"class":263}," application\u002Fjson\n",[253,298,300],{"class":255,"line":299},4,[253,301,303],{"emptyLinePlaceholder":302},true,"\n",[253,305,307],{"class":255,"line":306},5,[253,308,309],{"class":276},"{\n",[253,311,313,316,320,323,326,329],{"class":255,"line":312},6,[253,314,315],{"class":259},"  \"eventType\"",[253,317,319],{"class":318},"s2Zo4",":",[253,321,322],{"class":276}," \"",[253,324,325],{"class":263},"orderCreated",[253,327,328],{"class":276},"\"",[253,330,331],{"class":263},",\n",[253,333,335,338,340,342,345,347],{"class":255,"line":334},7,[253,336,337],{"class":259},"  \"destination\"",[253,339,319],{"class":318},[253,341,322],{"class":276},[253,343,344],{"class":263},"https:\u002F\u002Fyour-system.com\u002Fwebhooks\u002Favvyr",[253,346,328],{"class":276},[253,348,331],{"class":263},[253,350,352,355,357,360],{"class":255,"line":351},8,[253,353,354],{"class":259},"  \"enabled\"",[253,356,319],{"class":318},[253,358,359],{"class":276}," true",[253,361,331],{"class":263},[253,363,365,368,370,372,375,377],{"class":255,"line":364},9,[253,366,367],{"class":259},"  \"authType\"",[253,369,319],{"class":318},[253,371,322],{"class":276},[253,373,374],{"class":263},"hmac",[253,376,328],{"class":276},[253,378,331],{"class":263},[253,380,382,385,387,389,392,394],{"class":255,"line":381},10,[253,383,384],{"class":259},"  \"hmacSecret\"",[253,386,319],{"class":318},[253,388,322],{"class":276},[253,390,391],{"class":263},"your-secret-key",[253,393,328],{"class":276},[253,395,331],{"class":263},[253,397,399,402,404,406],{"class":255,"line":398},11,[253,400,401],{"class":259},"  \"retryEnabled\"",[253,403,319],{"class":318},[253,405,359],{"class":276},[253,407,331],{"class":263},[253,409,411,414,416],{"class":255,"line":410},12,[253,412,413],{"class":259},"  \"retryCount\"",[253,415,319],{"class":318},[253,417,418],{"class":263}," 3,\n",[253,420,422,425,427,429,432],{"class":255,"line":421},13,[253,423,424],{"class":259},"  \"comment\"",[253,426,319],{"class":318},[253,428,322],{"class":276},[253,430,431],{"class":263},"Order sync to ERP",[253,433,434],{"class":276},"\"\n",[253,436,438],{"class":255,"line":437},14,[253,439,440],{"class":276},"}\n",[239,442,444],{"id":443},"what-you-can-configure","What you can configure",[446,447,448,461],"table",{},[449,450,451],"thead",{},[452,453,454,458],"tr",{},[455,456,457],"th",{},"Field",[455,459,460],{},"Description",[462,463,464,482,492,514,528,538],"tbody",{},[452,465,466,472],{},[467,468,469],"td",{},[234,470,471],{},"eventType",[467,473,474,475,477,478,481],{},"Which event to listen for (e.g. ",[234,476,325],{},", ",[234,479,480],{},"productUpdated",")",[452,483,484,489],{},[467,485,486],{},[234,487,488],{},"destination",[467,490,491],{},"Your webhook URL",[452,493,494,499],{},[467,495,496],{},[234,497,498],{},"authType",[467,500,501,502,477,505,477,508,511,512],{},"How Avvyr authenticates with your endpoint: ",[234,503,504],{},"none",[234,506,507],{},"basic",[234,509,510],{},"bearer",", or ",[234,513,374],{},[452,515,516,525],{},[467,517,518,521,522],{},[234,519,520],{},"retryEnabled"," \u002F ",[234,523,524],{},"retryCount",[467,526,527],{},"Automatic retry on delivery failure",[452,529,530,535],{},[467,531,532],{},[234,533,534],{},"errorEmail",[467,536,537],{},"Get notified when deliveries fail",[452,539,540,545],{},[467,541,542],{},[234,543,544],{},"additionalHeaders",[467,546,547],{},"Custom headers sent with every webhook",[239,549,551],{"id":550},"available-operations","Available operations",[553,554,555,562,568,574,580,585,591],"ul",{},[556,557,558,561],"li",{},[229,559,560],{},"Create"," a subscription",[556,563,564,567],{},[229,565,566],{},"List"," all subscriptions",[556,569,570,573],{},[229,571,572],{},"Get"," a specific subscription",[556,575,576,579],{},[229,577,578],{},"Update"," a subscription (e.g. disable it, change auth)",[556,581,582,561],{},[229,583,584],{},"Delete",[556,586,587,590],{},[229,588,589],{},"Search"," by event type, destination, or comment",[556,592,593,596],{},[229,594,595],{},"Test"," — send a synthetic event to verify your endpoint",[239,598,600],{"id":599},"permissions","Permissions",[446,602,603,613],{},[449,604,605],{},[452,606,607,610],{},[455,608,609],{},"Action",[455,611,612],{},"Permission",[462,614,615,624,634,644],{},[452,616,617,619],{},[467,618,560],{},[467,620,621],{},[234,622,623],{},"EVENT_SUBSCRIPTIONS.CREATE",[452,625,626,629],{},[467,627,628],{},"Read \u002F List \u002F Search",[467,630,631],{},[234,632,633],{},"EVENT_SUBSCRIPTIONS.READ",[452,635,636,639],{},[467,637,638],{},"Update \u002F Test",[467,640,641],{},[234,642,643],{},"EVENT_SUBSCRIPTIONS.UPDATE",[452,645,646,648],{},[467,647,584],{},[467,649,650],{},[234,651,652],{},"EVENT_SUBSCRIPTIONS.DELETE",[654,655,658,659,662],"callout",{"icon":656,"to":657},"i-lucide-external-link","\u002Fmanagement\u002Freference","See the ",[229,660,661],{},"Management API Reference"," for full request\u002Fresponse schemas, field definitions, and try requests live.",[654,664,666,667,670],{"icon":665},"i-lucide-lightbulb","Always use the ",[229,668,669],{},"test endpoint"," after creating a subscription to verify that your endpoint is reachable, auth is correct, and your system handles the payload.",[672,673,674],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":249,"searchDepth":267,"depth":267,"links":676},[677,678,679,680],{"id":241,"depth":267,"text":242},{"id":443,"depth":267,"text":444},{"id":550,"depth":267,"text":551},{"id":599,"depth":267,"text":600},"Create and manage event subscriptions via the Management API","md",null,{},{"title":85,"description":681},"cpaI4_jtOeixas3nmEtcY0bAo09xGbCM2UxxC10T2eo",[688,690],{"title":75,"path":76,"stem":77,"description":689,"children":-1},"Subscribe to domain events and receive webhooks when things happen in Avvyr",{"title":89,"path":90,"stem":91,"description":691,"children":-1},"How Avvyr delivers events to your endpoint — payload format, authentication, retries, and signature verification",1775725944634]