CINXE.COM

<!DOCTYPE html><html lang="en" class="dark"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/apple-touch-icon.png?v=3"/><link rel="icon" type="image/png" sizes="32x32" href="https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/favicon-32x32.png?v=3"/><link rel="icon" type="image/png" sizes="16x16" href="https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/favicon-16x16.png?v=3"/><link rel="shortcut icon" type="image/x-icon" href="https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/favicon.ico?v=3"/><meta name="msapplication-config" content="https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/browserconfig.xml?v=3"/><meta name="apple-mobile-web-app-title" content="Zapier"/><meta name="application-name" content="Zapier"/><meta name="msapplication-TileColor" content="#FF4F00"/><meta name="theme-color" content="#ffffff"/><link rel="sitemap" type="application/xml" href="/sitemap.xml"/><meta name="charset" content="utf-8"/><meta name="og:type" content="website"/><meta name="og:site_name" content="Zapier"/><meta name="twitter:card" content="summary_large_image"/><meta name="og:title" content="Welcome - Zapier"/><meta name="twitter:title" content="Welcome - Zapier"/><meta name="image" property="og:image" content="https://mintlify.com/docs/api/og?division=Documentation&title=Welcome&logoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fzapier-82f0e938%2Flogo%2Flight.svg&logoDark=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fzapier-82f0e938%2Flogo%2Fdark.svg&primaryColor=%23FF4F00&lightColor=%23FE6C2A&darkColor=%23FF4F00"/><meta property="og:image:width" content="1200"/><meta property="og:image:height" content="630"/><meta name="twitter:image" property="twitter:image" content="https://mintlify.com/docs/api/og?division=Documentation&title=Welcome&logoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fzapier-82f0e938%2Flogo%2Flight.svg&logoDark=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fzapier-82f0e938%2Flogo%2Fdark.svg&primaryColor=%23FF4F00&lightColor=%23FE6C2A&darkColor=%23FF4F00"/><meta name="twitter:card" property="twitter:card" content="summary_large_image"/><meta property="twitter:image:width" content="1200"/><meta property="twitter:image:height" content="630"/><title>Welcome - Zapier</title><meta name="og:url" content="/platform/home"/><link rel="canonical" href="/platform/home"/><meta name="next-head-count" content="28"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css" integrity="sha384-Xi8rHCmBmhbuyyhbI88391ZKP2dmfnOl4rT9ZfRI7mLTdk1wblIUnrIq35nqwEvC" crossorigin="anonymous"/><link rel="preload" href="/_next/static/media/a34f9d1faa5f3315-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/bb3ef058b751a6ad-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><script id="mode-toggle" data-nscript="beforeInteractive"> try { if (localStorage.isDarkMode === 'true') { document.documentElement.classList.add('dark'); } else if (localStorage.isDarkMode === 'false') { document.documentElement.classList.remove('dark'); } else if ((true && !('isDarkMode' in localStorage) && window.matchMedia('(prefers-color-scheme: dark)').matches) || false) { document.documentElement.classList.add('dark'); } else { document.documentElement.classList.remove('dark'); } } catch (_) {}</script><link rel="preload" href="/_next/static/css/6b9eb502c2d33570.css" as="style"/><link rel="stylesheet" href="/_next/static/css/6b9eb502c2d33570.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-42372ed130431b0a.js"></script><script src="/_next/static/chunks/webpack-dedccb098e30a6ab.js" defer=""></script><script src="/_next/static/chunks/framework-9ae01a5f4ade81f5.js" defer=""></script><script src="/_next/static/chunks/main-cf327937a0d9f14c.js" defer=""></script><script src="/_next/static/chunks/pages/_app-aaea6ce327734f00.js" defer=""></script><script src="/_next/static/chunks/2edb282b-a83f7ffd007bccf0.js" defer=""></script><script src="/_next/static/chunks/e893f787-f6a1094a35763a0d.js" defer=""></script><script src="/_next/static/chunks/086d643d-6f7196a364073d16.js" defer=""></script><script src="/_next/static/chunks/9097-53b32b020063004a.js" defer=""></script><script src="/_next/static/chunks/7669-b7b6e74eb838f0fc.js" defer=""></script><script src="/_next/static/chunks/7610-e463a3dc6ba2cbb8.js" defer=""></script><script src="/_next/static/chunks/40-73655ea3c5690e93.js" defer=""></script><script src="/_next/static/chunks/pages/_sites/%5Bsubdomain%5D/%5B%5B...slug%5D%5D-79e8424968849281.js" defer=""></script><script src="/_next/static/hy3puFCEyypkbxdK0kPb_/_buildManifest.js" defer=""></script><script src="/_next/static/hy3puFCEyypkbxdK0kPb_/_ssgManifest.js" defer=""></script><style id="__jsx-4145347147">:root{--font-inter:'__Inter_e5ab12', '__Inter_Fallback_e5ab12';--font-jetbrains-mono:'__JetBrains_Mono_3c557b', '__JetBrains_Mono_Fallback_3c557b'}</style></head><div id="__next"><main class="jsx-4145347147"><style>:root { --primary: 255 79 0; --primary-light: 254 108 42; --primary-dark: 255 79 0; --background-light: 255 255 255; --background-dark: 14 11 12; --gray-50: 250 245 242; --gray-100: 245 240 238; --gray-200: 230 224 222; --gray-300: 213 208 206; --gray-400: 166 160 158; --gray-500: 119 114 111; --gray-600: 87 82 79; --gray-700: 70 64 62; --gray-800: 45 39 37; --gray-900: 30 25 22; --gray-950: 17 12 10; }</style><style>@font-face { font-family: "Degular Display - Semibold"; src: url('https://fonts.zapier.com/Degular/DegularDisplay-Semibold.woff2'); font-display: fallback; font-weight: 400; } h1,h2,h3,h4{ font-family: "Degular Display - Semibold"; letter-spacing: 1px !important ; } </style><style>.hero-container { display: flex; flex-direction: row; /* flex-wrap: wrap; */ align-items: center; justify-content: center; text-align: left; padding: 6rem 2rem; width: 80%; border-bottom: 2px solid #FF4F00; margin: 0 auto; } .hero-text { width: 600px; margin-right: 2rem; } @media screen and (max-width: 1300px) { .hero-container { flex-direction: column; text-align: center; } .hero-text { margin-right: 0rem; /* Added margin to separate text from image for small screens */ margin-bottom: 2rem; } .hero-video { max-width: 600px; } } </style><span class="fixed inset-0 bg-background-light dark:bg-background-dark -z-10"></span><span class="block absolute dark:hidden inset-0 overflow-hidden h-[64rem]" style="background:radial-gradient(49.63% 57.02% at 58.99% -7.2%, rgba(255, 79, 0, 0.1) 39.4%, rgba(0, 0, 0, 0) 100%)"><svg width="790" height="640" viewBox="0 0 790 718" fill="none" xmlns="http://www.w3.org/2000/svg" class="absolute pl-48 -top-16 left-1/2 -translate-x-1/2"><mask id="mask-light" style="mask-type:alpha" maskUnits="userSpaceOnUse" x="0" y="-143" width="936" height="861"><ellipse cx="468.373" cy="287.536" rx="467.627" ry="430.464" fill="url(#radial-light)"></ellipse></mask><g mask="url(#mask-light)" class="fill-primary dark:fill-primary-light"><path d="M506.419 281.855L446.417 297.931V359.885L506.419 343.71V281.855Z" fill-opacity="0.05"></path><path d="M384.768 188.752L324.766 204.828V266.781L384.768 250.606V188.752Z" fill-opacity="0.05"></path><path d="M263.625 347.002L203.623 363.078V425.031L263.625 408.856V347.002Z" fill-opacity="0.05"></path><path d="M385.089 440.096L325.087 456.172V518.125L385.089 501.95V440.096Z" fill-opacity="0.05"></path><path d="M627.756 123.527L567.754 139.603V201.557L627.756 185.382V123.527Z" fill-opacity="0.05"></path><path d="M445.32 46.918L385.318 62.994V124.947L445.32 108.772V46.918Z" fill-opacity="0.05"></path><path d="M749.192 279.59L689.19 295.666V357.619L749.192 341.444V279.59Z" fill-opacity="0.05"></path><path d="M627.905 437.912L567.903 453.988V515.941L627.905 499.766V437.912Z" fill-opacity="0.05"></path><path d="M202.491 175.656L142.489 191.732V253.685L202.491 237.511V175.656Z" fill-opacity="0.05"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M446.54 -79.1784L949.537 -213.956L949.278 -214.922L446.54 -80.2137V-87.9997H445.54V-79.9457L385.832 -63.947V-87.9997H384.832V-63.679L325.124 -47.6803V-87.9997H324.124V-47.4124L264.416 -31.4137V-87.9997H263.416V-31.1457L203.708 -15.147L203.708 -87.9997H202.708L202.708 -14.8791L143 1.11966L143 -87.9997H142L142 1.3876L-80.8521 61.1006L-80.5932 62.0666L142 2.42287V64.2363L-65.1402 119.739L-64.8814 120.705L142 65.2715L142 127.085L-49.4278 178.378L-49.1689 179.344L142 128.12V189.936L-33.7155 237.019L-33.4566 237.985L142 190.971V252.787L-18.0025 295.659L-17.7437 296.625L142 253.822V315.635L-2.29068 354.298L-2.03186 355.264L142 316.671V378.484L13.4218 412.937L13.6806 413.903L142 379.519V441.335L29.1341 471.577L29.3929 472.543L142 442.37V504.184L44.8466 530.216L45.1054 531.182L142 505.219V567.032L60.5591 588.855L60.8179 589.82L142 568.068V629.881L76.2715 647.493L76.5303 648.459L142 630.917V692.732L91.9838 706.134L92.2426 707.1L142 693.767V698.42H143V693.499L202.708 677.501V698.42H203.708V677.233L263.416 661.234V698.42H264.416V660.966L324.124 644.967V698.42H325.124V644.699L384.832 628.701V690.514L107.696 764.773L107.954 765.738L384.832 691.549V698.42H385.832V691.281L445.54 675.283V698.42H446.54V675.015L506.248 659.016V698.42H507.248V658.748L566.956 642.749V698.42H567.956V642.481L627.664 626.483V688.298L123.409 823.413L123.667 824.379L627.664 689.334V698.42H628.664V689.066L688.372 673.067V698.42H689.372V672.799L749.08 656.8V698.42H750.08V656.532L809.788 640.534V698.42H810.788V640.266L870.496 624.267V698.42H871.496V623.999L931.204 608V698.42H932.204V607.732L1153.8 548.357L1153.54 547.391L932.204 606.697V544.881L1138.08 489.716L1137.83 488.75L932.204 543.846V482.033L1122.37 431.077L1122.11 430.111L932.204 480.997V419.182L1106.66 372.437L1106.4 371.471L932.204 418.147V356.333L1090.95 313.798L1090.69 312.832L932.204 355.298V293.484L1075.24 255.159L1074.98 254.193L932.204 292.449V230.636L1059.52 196.521L1059.26 195.555L932.204 229.6V167.785L1043.81 137.88L1043.55 136.914L932.204 166.75V104.936L1028.1 79.2413L1027.84 78.2754L932.204 103.901V42.0874L1012.39 20.6027L1012.13 19.6367L932.204 41.0522V-20.7634L996.674 -38.0379L996.415 -39.0039L932.204 -21.7987L932.204 -83.6142L980.961 -96.6786L980.702 -97.6445L932.204 -84.6495V-87.9997H931.204V-84.3815L871.496 -68.3828V-87.9997H870.496V-68.1149L810.788 -52.1161V-87.9997H809.788V-51.8482L750.08 -35.8495V-87.9997H749.08V-35.5815L689.372 -19.5828L689.372 -81.3963L965.249 -155.317L964.99 -156.283L689.372 -82.4316V-87.9997H688.372V-82.1637L628.664 -66.1649V-87.9997H627.664V-65.897L567.956 -49.8983V-87.9997H566.956V-49.6303L507.248 -33.6316V-87.9997H506.248V-33.3637L446.54 -17.365L446.54 -79.1784ZM445.54 -78.9104L385.832 -62.9117L385.832 -1.09831L445.54 -17.097L445.54 -78.9104ZM384.832 -62.6438L325.124 -46.6451L325.124 15.1684L384.832 -0.830353L384.832 -62.6438ZM324.124 -46.3771L264.416 -30.3784L264.416 31.435L324.124 15.4363L324.124 -46.3771ZM263.416 -30.1104L203.708 -14.1117V47.7017L263.416 31.703L263.416 -30.1104ZM202.708 -13.8438L143 2.15492V63.9683L202.708 47.9696V-13.8438ZM628.664 -65.1297L688.372 -81.1284L688.372 -19.3149L628.664 -3.31616L628.664 -65.1297ZM567.956 -48.863L627.664 -64.8617L627.664 -3.04822L567.956 12.9505L567.956 -48.863ZM507.248 -32.5964L566.956 -48.5951L566.956 13.2184L507.248 29.2172L507.248 -32.5964ZM446.54 -16.3297L506.248 -32.3284L506.248 29.4851L446.54 45.4838V-16.3297ZM385.832 -0.0630493L445.54 -16.0618V45.7517L385.832 61.7505V-0.0630493ZM325.124 16.2036L384.832 0.20491V62.0184L325.124 78.0171V16.2036ZM264.416 32.4703L324.124 16.4716V78.2851L264.416 94.2838V32.4703ZM203.708 48.7369L263.416 32.7382V94.5517L203.708 110.55V48.7369ZM143 65.0036L202.708 49.0049V110.818L143 126.817L143 65.0036ZM931.204 -83.3463L871.496 -67.3475L871.496 -5.53207L931.204 -21.5308L931.204 -83.3463ZM870.496 -67.0796L810.788 -51.0809L810.788 10.7346L870.496 -5.26411L870.496 -67.0796ZM809.788 -50.8129L750.08 -34.8142L750.08 27.0013L809.788 11.0025L809.788 -50.8129ZM749.08 -34.5463L689.372 -18.5476V43.2679L749.08 27.2692L749.08 -34.5463ZM688.372 -18.2796L628.664 -2.2809V59.5346L688.372 43.5359V-18.2796ZM627.664 -2.01295L567.956 13.9858V75.8012L627.664 59.8025V-2.01295ZM566.956 14.2537L507.248 30.2524V92.0679L566.956 76.0692V14.2537ZM506.248 30.5204L446.54 46.5191V108.335L506.248 92.3358V30.5204ZM445.54 46.787L385.832 62.7857V124.601L445.54 108.603V46.787ZM384.832 63.0537L325.124 79.0524V140.868L384.832 124.869V63.0537ZM324.124 79.3203L264.416 95.319V157.135L324.124 141.136V79.3203ZM263.416 95.587L203.708 111.586V173.401L263.416 157.402V95.587ZM202.708 111.854L143 127.852V189.668L202.708 173.669V111.854ZM871.496 -4.49677L931.204 -20.4955V41.3201L871.496 57.3188V-4.49677ZM810.788 11.7699L870.496 -4.22882V57.5868L810.788 73.5855V11.7699ZM750.08 28.0365L809.788 12.0378V73.8534L750.08 89.8521V28.0365ZM689.372 44.3032L749.08 28.3045V90.1201L689.372 106.119V44.3032ZM628.664 60.5699L688.372 44.5711V106.387L628.664 122.385V60.5699ZM567.956 76.8365L627.664 60.8378V122.653L567.956 138.652V76.8365ZM507.248 93.1032L566.956 77.1045V138.92L507.248 154.919V93.1032ZM446.54 109.37L506.248 93.3711V155.187L446.54 171.185V109.37ZM385.832 125.636L445.54 109.638V171.453L385.832 187.452V125.636ZM325.124 141.903L384.832 125.904V187.72L325.124 203.719V141.903ZM264.416 158.17L324.124 142.171V203.987L264.416 219.985V158.17ZM203.708 174.436L263.416 158.438V220.253L203.708 236.252V174.436ZM143 190.703L202.708 174.704V236.52L143 252.519V190.703ZM143 253.554V315.367L202.708 299.369V237.555L143 253.554ZM203.708 237.287V299.101L263.416 283.102V221.289L203.708 237.287ZM264.416 221.021V282.834L324.124 266.835V205.022L264.416 221.021ZM325.124 204.754V266.567L384.832 250.569V188.755L325.124 204.754ZM385.832 188.487V250.301L445.54 234.302V172.489L385.832 188.487ZM446.54 172.221V234.034L506.248 218.035V156.222L446.54 172.221ZM507.248 155.954V217.767L566.956 201.769V139.955L507.248 155.954ZM567.956 139.687V201.501L627.664 185.502V123.689L567.956 139.687ZM628.664 123.421V185.234L688.372 169.235V107.422L628.664 123.421ZM689.372 107.154V168.967L749.08 152.969V91.1554L689.372 107.154ZM750.08 90.8874V152.701L809.788 136.702V74.8887L750.08 90.8874ZM810.788 74.6208V136.434L870.496 120.435V58.622L810.788 74.6208ZM871.496 58.3541V120.167L931.204 104.169V42.3554L871.496 58.3541ZM871.496 121.203L931.204 105.204V167.018L871.496 183.016V121.203ZM810.788 137.469L870.496 121.471V183.284L810.788 199.283V137.469ZM750.08 153.736L809.788 137.737V199.551L750.08 215.55V153.736ZM689.372 170.003L749.08 154.004V215.818L689.372 231.816V170.003ZM628.664 186.269L688.372 170.271V232.084L628.664 248.083V186.269ZM567.956 202.536L627.664 186.537V248.351L567.956 264.35V202.536ZM507.248 218.803L566.956 202.804V264.617L507.248 280.616V218.803ZM446.54 235.069L506.248 219.071V280.884L446.54 296.883V235.069ZM385.832 251.336L445.54 235.337V297.151L385.832 313.15V251.336ZM325.124 267.603L384.832 251.604V313.417L325.124 329.416V267.603ZM264.416 283.869L324.124 267.871V329.684L264.416 345.683V283.869ZM203.708 300.136L263.416 284.137V345.951L203.708 361.95V300.136ZM143 316.403L202.708 300.404V362.217L143 378.216V316.403ZM143 379.251V441.067L202.708 425.068V363.253L143 379.251ZM203.708 362.985V424.8L263.416 408.802V346.986L203.708 362.985ZM264.416 346.718V408.534L324.124 392.535V330.719L264.416 346.718ZM325.124 330.451V392.267L384.832 376.268V314.453L325.124 330.451ZM385.832 314.185V376L445.54 360.002V298.186L385.832 314.185ZM446.54 297.918V359.734L506.248 343.735V281.919L446.54 297.918ZM507.248 281.651V343.467L566.956 327.468V265.653L507.248 281.651ZM567.956 265.385V327.2L627.664 311.202V249.386L567.956 265.385ZM628.664 249.118V310.934L688.372 294.935V233.119L628.664 249.118ZM689.372 232.852V294.667L749.08 278.668V216.853L689.372 232.852ZM750.08 216.585V278.4L809.788 262.402V200.586L750.08 216.585ZM810.788 200.318V262.134L870.496 246.135V184.319L810.788 200.318ZM871.496 184.052V245.867L931.204 229.868V168.053L871.496 184.052ZM871.496 246.902L931.204 230.904V292.717L871.496 308.716V246.902ZM810.788 263.169L870.496 247.17V308.984L810.788 324.982V263.169ZM750.08 279.436L809.788 263.437V325.25L750.08 341.249V279.436ZM689.372 295.702L749.08 279.704V341.517L689.372 357.516V295.702ZM628.664 311.969L688.372 295.97V357.784L628.664 373.782V311.969ZM567.956 328.236L627.664 312.237V374.05L567.956 390.049V328.236ZM507.248 344.502L566.956 328.504V390.317L507.248 406.316V344.502ZM446.54 360.769L506.248 344.77V406.584L446.54 422.582V360.769ZM385.832 377.036L445.54 361.037V422.85L385.832 438.849V377.036ZM325.124 393.302L384.832 377.304V439.117L325.124 455.116V393.302ZM264.416 409.569L324.124 393.57V455.384L264.416 471.382V409.569ZM203.708 425.836L263.416 409.837V471.65L203.708 487.649V425.836ZM143 442.102L202.708 426.104V487.917L143 503.916V442.102ZM143 504.951V566.765L202.708 550.766V488.952L143 504.951ZM203.708 488.684V550.498L263.416 534.499V472.686L203.708 488.684ZM264.416 472.418V534.231L324.124 518.232V456.419L264.416 472.418ZM325.124 456.151V517.965L384.832 501.966V440.152L325.124 456.151ZM385.832 439.884V501.698L445.54 485.699V423.886L385.832 439.884ZM446.54 423.618V485.431L506.248 469.433V407.619L446.54 423.618ZM507.248 407.351V469.165L566.956 453.166V391.352L507.248 407.351ZM567.956 391.084V452.898L627.664 436.899V375.086L567.956 391.084ZM628.664 374.818V436.631L688.372 420.633V358.819L628.664 374.818ZM689.372 358.551V420.365L749.08 404.366V342.552L689.372 358.551ZM750.08 342.284V404.098L809.788 388.099V326.286L750.08 342.284ZM810.788 326.018V387.831L870.496 371.833V310.019L810.788 326.018ZM871.496 309.751V371.565L931.204 355.566V293.752L871.496 309.751ZM871.496 372.6L931.204 356.601V418.415L871.496 434.413V372.6ZM810.788 388.867L870.496 372.868V434.681L810.788 450.68V388.867ZM750.08 405.133L809.788 389.135V450.948L750.08 466.947V405.133ZM689.372 421.4L749.08 405.401V467.215L689.372 483.213V421.4ZM628.664 437.667L688.372 421.668V483.481L628.664 499.48V437.667ZM567.956 453.933L627.664 437.935V499.748L567.956 515.747V453.933ZM507.248 470.2L566.956 454.201V516.015L507.248 532.013V470.2ZM446.54 486.467L506.248 470.468V532.281L446.54 548.28V486.467ZM385.832 502.733L445.54 486.734V548.548L385.832 564.547V502.733ZM325.124 519L384.832 503.001V564.815L325.124 580.813V519ZM264.416 535.267L324.124 519.268V581.081L264.416 597.08V535.267ZM203.708 551.533L263.416 535.534V597.348L203.708 613.347V551.533ZM143 567.8L202.708 551.801V613.615L143 629.613V567.8ZM143 630.649V692.464L202.708 676.465V614.65L143 630.649ZM203.708 614.382V676.197L263.416 660.199V598.383L203.708 614.382ZM264.416 598.115V659.931L324.124 643.932V582.117L264.416 598.115ZM325.124 581.849V643.664L384.832 627.665V565.85L325.124 581.849ZM385.832 565.582V627.397L445.54 611.399V549.583L385.832 565.582ZM446.54 549.315V611.131L506.248 595.132V533.317L446.54 549.315ZM507.248 533.049V594.864L566.956 578.865V517.05L507.248 533.049ZM567.956 516.782V578.597L627.664 562.599V500.783L567.956 516.782ZM628.664 500.515V562.331L688.372 546.332V484.517L628.664 500.515ZM689.372 484.249V546.064L749.08 530.065V468.25L689.372 484.249ZM750.08 467.982V529.797L809.788 513.799V451.983L750.08 467.982ZM810.788 451.715V513.531L870.496 497.532V435.717L810.788 451.715ZM871.496 435.449V497.264L931.204 481.265V419.45L871.496 435.449ZM385.832 690.246V628.433L445.54 612.434V674.247L385.832 690.246ZM446.54 673.979V612.166L506.248 596.167V657.981L446.54 673.979ZM507.248 657.713V595.899L566.956 579.901V641.714L507.248 657.713ZM567.956 641.446V579.633L627.664 563.634V625.447L567.956 641.446ZM628.664 625.18V563.366L688.372 547.367V609.181L628.664 625.18ZM689.372 608.913V547.099L749.08 531.101V592.914L689.372 608.913ZM750.08 592.646V530.833L809.788 514.834V576.647L750.08 592.646ZM810.788 576.38V514.566L870.496 498.567V560.381L810.788 576.38ZM871.496 560.113V498.299L931.204 482.301V544.114L871.496 560.113ZM628.664 626.215V688.03L688.372 672.032V610.216L628.664 626.215ZM689.372 609.948V671.764L749.08 655.765V593.949L689.372 609.948ZM750.08 593.681V655.497L809.788 639.498V577.683L750.08 593.681ZM810.788 577.415V639.23L870.496 623.232V561.416L810.788 577.415ZM871.496 561.148V622.964L931.204 606.965V545.149L871.496 561.148Z" fill-opacity="0.1"></path></g><defs><radialGradient id="radial-light" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="translate(468.373 287.536) rotate(90) scale(430.464 467.627)"><stop stop-color="#D9D9D9"></stop><stop offset="1" stop-opacity="0"></stop></radialGradient></defs></svg></span><span class="hidden absolute dark:block inset-0 overflow-hidden h-[64rem]" style="background:radial-gradient(49.63% 57.02% at 58.99% -7.2%, rgba(254, 108, 42, 0.1) 39.4%, rgba(0, 0, 0, 0) 100%)"><svg width="790" height="640" viewBox="0 0 790 718" fill="none" xmlns="http://www.w3.org/2000/svg" class="absolute pl-48 -top-16 left-1/2 -translate-x-1/2"><mask id="mask-dark" style="mask-type:alpha" maskUnits="userSpaceOnUse" x="0" y="-143" width="936" height="861"><ellipse cx="468.373" cy="287.536" rx="467.627" ry="430.464" fill="url(#radial-dark)"></ellipse></mask><g mask="url(#mask-dark)" class="fill-primary dark:fill-primary-light"><path d="M506.419 281.855L446.417 297.931V359.885L506.419 343.71V281.855Z" fill-opacity="0.05"></path><path d="M384.768 188.752L324.766 204.828V266.781L384.768 250.606V188.752Z" fill-opacity="0.05"></path><path d="M263.625 347.002L203.623 363.078V425.031L263.625 408.856V347.002Z" fill-opacity="0.05"></path><path d="M385.089 440.096L325.087 456.172V518.125L385.089 501.95V440.096Z" fill-opacity="0.05"></path><path d="M627.756 123.527L567.754 139.603V201.557L627.756 185.382V123.527Z" fill-opacity="0.05"></path><path d="M445.32 46.918L385.318 62.994V124.947L445.32 108.772V46.918Z" fill-opacity="0.05"></path><path d="M749.192 279.59L689.19 295.666V357.619L749.192 341.444V279.59Z" fill-opacity="0.05"></path><path d="M627.905 437.912L567.903 453.988V515.941L627.905 499.766V437.912Z" fill-opacity="0.05"></path><path d="M202.491 175.656L142.489 191.732V253.685L202.491 237.511V175.656Z" fill-opacity="0.05"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M446.54 -79.1784L949.537 -213.956L949.278 -214.922L446.54 -80.2137V-87.9997H445.54V-79.9457L385.832 -63.947V-87.9997H384.832V-63.679L325.124 -47.6803V-87.9997H324.124V-47.4124L264.416 -31.4137V-87.9997H263.416V-31.1457L203.708 -15.147L203.708 -87.9997H202.708L202.708 -14.8791L143 1.11966L143 -87.9997H142L142 1.3876L-80.8521 61.1006L-80.5932 62.0666L142 2.42287V64.2363L-65.1402 119.739L-64.8814 120.705L142 65.2715L142 127.085L-49.4278 178.378L-49.1689 179.344L142 128.12V189.936L-33.7155 237.019L-33.4566 237.985L142 190.971V252.787L-18.0025 295.659L-17.7437 296.625L142 253.822V315.635L-2.29068 354.298L-2.03186 355.264L142 316.671V378.484L13.4218 412.937L13.6806 413.903L142 379.519V441.335L29.1341 471.577L29.3929 472.543L142 442.37V504.184L44.8466 530.216L45.1054 531.182L142 505.219V567.032L60.5591 588.855L60.8179 589.82L142 568.068V629.881L76.2715 647.493L76.5303 648.459L142 630.917V692.732L91.9838 706.134L92.2426 707.1L142 693.767V698.42H143V693.499L202.708 677.501V698.42H203.708V677.233L263.416 661.234V698.42H264.416V660.966L324.124 644.967V698.42H325.124V644.699L384.832 628.701V690.514L107.696 764.773L107.954 765.738L384.832 691.549V698.42H385.832V691.281L445.54 675.283V698.42H446.54V675.015L506.248 659.016V698.42H507.248V658.748L566.956 642.749V698.42H567.956V642.481L627.664 626.483V688.298L123.409 823.413L123.667 824.379L627.664 689.334V698.42H628.664V689.066L688.372 673.067V698.42H689.372V672.799L749.08 656.8V698.42H750.08V656.532L809.788 640.534V698.42H810.788V640.266L870.496 624.267V698.42H871.496V623.999L931.204 608V698.42H932.204V607.732L1153.8 548.357L1153.54 547.391L932.204 606.697V544.881L1138.08 489.716L1137.83 488.75L932.204 543.846V482.033L1122.37 431.077L1122.11 430.111L932.204 480.997V419.182L1106.66 372.437L1106.4 371.471L932.204 418.147V356.333L1090.95 313.798L1090.69 312.832L932.204 355.298V293.484L1075.24 255.159L1074.98 254.193L932.204 292.449V230.636L1059.52 196.521L1059.26 195.555L932.204 229.6V167.785L1043.81 137.88L1043.55 136.914L932.204 166.75V104.936L1028.1 79.2413L1027.84 78.2754L932.204 103.901V42.0874L1012.39 20.6027L1012.13 19.6367L932.204 41.0522V-20.7634L996.674 -38.0379L996.415 -39.0039L932.204 -21.7987L932.204 -83.6142L980.961 -96.6786L980.702 -97.6445L932.204 -84.6495V-87.9997H931.204V-84.3815L871.496 -68.3828V-87.9997H870.496V-68.1149L810.788 -52.1161V-87.9997H809.788V-51.8482L750.08 -35.8495V-87.9997H749.08V-35.5815L689.372 -19.5828L689.372 -81.3963L965.249 -155.317L964.99 -156.283L689.372 -82.4316V-87.9997H688.372V-82.1637L628.664 -66.1649V-87.9997H627.664V-65.897L567.956 -49.8983V-87.9997H566.956V-49.6303L507.248 -33.6316V-87.9997H506.248V-33.3637L446.54 -17.365L446.54 -79.1784ZM445.54 -78.9104L385.832 -62.9117L385.832 -1.09831L445.54 -17.097L445.54 -78.9104ZM384.832 -62.6438L325.124 -46.6451L325.124 15.1684L384.832 -0.830353L384.832 -62.6438ZM324.124 -46.3771L264.416 -30.3784L264.416 31.435L324.124 15.4363L324.124 -46.3771ZM263.416 -30.1104L203.708 -14.1117V47.7017L263.416 31.703L263.416 -30.1104ZM202.708 -13.8438L143 2.15492V63.9683L202.708 47.9696V-13.8438ZM628.664 -65.1297L688.372 -81.1284L688.372 -19.3149L628.664 -3.31616L628.664 -65.1297ZM567.956 -48.863L627.664 -64.8617L627.664 -3.04822L567.956 12.9505L567.956 -48.863ZM507.248 -32.5964L566.956 -48.5951L566.956 13.2184L507.248 29.2172L507.248 -32.5964ZM446.54 -16.3297L506.248 -32.3284L506.248 29.4851L446.54 45.4838V-16.3297ZM385.832 -0.0630493L445.54 -16.0618V45.7517L385.832 61.7505V-0.0630493ZM325.124 16.2036L384.832 0.20491V62.0184L325.124 78.0171V16.2036ZM264.416 32.4703L324.124 16.4716V78.2851L264.416 94.2838V32.4703ZM203.708 48.7369L263.416 32.7382V94.5517L203.708 110.55V48.7369ZM143 65.0036L202.708 49.0049V110.818L143 126.817L143 65.0036ZM931.204 -83.3463L871.496 -67.3475L871.496 -5.53207L931.204 -21.5308L931.204 -83.3463ZM870.496 -67.0796L810.788 -51.0809L810.788 10.7346L870.496 -5.26411L870.496 -67.0796ZM809.788 -50.8129L750.08 -34.8142L750.08 27.0013L809.788 11.0025L809.788 -50.8129ZM749.08 -34.5463L689.372 -18.5476V43.2679L749.08 27.2692L749.08 -34.5463ZM688.372 -18.2796L628.664 -2.2809V59.5346L688.372 43.5359V-18.2796ZM627.664 -2.01295L567.956 13.9858V75.8012L627.664 59.8025V-2.01295ZM566.956 14.2537L507.248 30.2524V92.0679L566.956 76.0692V14.2537ZM506.248 30.5204L446.54 46.5191V108.335L506.248 92.3358V30.5204ZM445.54 46.787L385.832 62.7857V124.601L445.54 108.603V46.787ZM384.832 63.0537L325.124 79.0524V140.868L384.832 124.869V63.0537ZM324.124 79.3203L264.416 95.319V157.135L324.124 141.136V79.3203ZM263.416 95.587L203.708 111.586V173.401L263.416 157.402V95.587ZM202.708 111.854L143 127.852V189.668L202.708 173.669V111.854ZM871.496 -4.49677L931.204 -20.4955V41.3201L871.496 57.3188V-4.49677ZM810.788 11.7699L870.496 -4.22882V57.5868L810.788 73.5855V11.7699ZM750.08 28.0365L809.788 12.0378V73.8534L750.08 89.8521V28.0365ZM689.372 44.3032L749.08 28.3045V90.1201L689.372 106.119V44.3032ZM628.664 60.5699L688.372 44.5711V106.387L628.664 122.385V60.5699ZM567.956 76.8365L627.664 60.8378V122.653L567.956 138.652V76.8365ZM507.248 93.1032L566.956 77.1045V138.92L507.248 154.919V93.1032ZM446.54 109.37L506.248 93.3711V155.187L446.54 171.185V109.37ZM385.832 125.636L445.54 109.638V171.453L385.832 187.452V125.636ZM325.124 141.903L384.832 125.904V187.72L325.124 203.719V141.903ZM264.416 158.17L324.124 142.171V203.987L264.416 219.985V158.17ZM203.708 174.436L263.416 158.438V220.253L203.708 236.252V174.436ZM143 190.703L202.708 174.704V236.52L143 252.519V190.703ZM143 253.554V315.367L202.708 299.369V237.555L143 253.554ZM203.708 237.287V299.101L263.416 283.102V221.289L203.708 237.287ZM264.416 221.021V282.834L324.124 266.835V205.022L264.416 221.021ZM325.124 204.754V266.567L384.832 250.569V188.755L325.124 204.754ZM385.832 188.487V250.301L445.54 234.302V172.489L385.832 188.487ZM446.54 172.221V234.034L506.248 218.035V156.222L446.54 172.221ZM507.248 155.954V217.767L566.956 201.769V139.955L507.248 155.954ZM567.956 139.687V201.501L627.664 185.502V123.689L567.956 139.687ZM628.664 123.421V185.234L688.372 169.235V107.422L628.664 123.421ZM689.372 107.154V168.967L749.08 152.969V91.1554L689.372 107.154ZM750.08 90.8874V152.701L809.788 136.702V74.8887L750.08 90.8874ZM810.788 74.6208V136.434L870.496 120.435V58.622L810.788 74.6208ZM871.496 58.3541V120.167L931.204 104.169V42.3554L871.496 58.3541ZM871.496 121.203L931.204 105.204V167.018L871.496 183.016V121.203ZM810.788 137.469L870.496 121.471V183.284L810.788 199.283V137.469ZM750.08 153.736L809.788 137.737V199.551L750.08 215.55V153.736ZM689.372 170.003L749.08 154.004V215.818L689.372 231.816V170.003ZM628.664 186.269L688.372 170.271V232.084L628.664 248.083V186.269ZM567.956 202.536L627.664 186.537V248.351L567.956 264.35V202.536ZM507.248 218.803L566.956 202.804V264.617L507.248 280.616V218.803ZM446.54 235.069L506.248 219.071V280.884L446.54 296.883V235.069ZM385.832 251.336L445.54 235.337V297.151L385.832 313.15V251.336ZM325.124 267.603L384.832 251.604V313.417L325.124 329.416V267.603ZM264.416 283.869L324.124 267.871V329.684L264.416 345.683V283.869ZM203.708 300.136L263.416 284.137V345.951L203.708 361.95V300.136ZM143 316.403L202.708 300.404V362.217L143 378.216V316.403ZM143 379.251V441.067L202.708 425.068V363.253L143 379.251ZM203.708 362.985V424.8L263.416 408.802V346.986L203.708 362.985ZM264.416 346.718V408.534L324.124 392.535V330.719L264.416 346.718ZM325.124 330.451V392.267L384.832 376.268V314.453L325.124 330.451ZM385.832 314.185V376L445.54 360.002V298.186L385.832 314.185ZM446.54 297.918V359.734L506.248 343.735V281.919L446.54 297.918ZM507.248 281.651V343.467L566.956 327.468V265.653L507.248 281.651ZM567.956 265.385V327.2L627.664 311.202V249.386L567.956 265.385ZM628.664 249.118V310.934L688.372 294.935V233.119L628.664 249.118ZM689.372 232.852V294.667L749.08 278.668V216.853L689.372 232.852ZM750.08 216.585V278.4L809.788 262.402V200.586L750.08 216.585ZM810.788 200.318V262.134L870.496 246.135V184.319L810.788 200.318ZM871.496 184.052V245.867L931.204 229.868V168.053L871.496 184.052ZM871.496 246.902L931.204 230.904V292.717L871.496 308.716V246.902ZM810.788 263.169L870.496 247.17V308.984L810.788 324.982V263.169ZM750.08 279.436L809.788 263.437V325.25L750.08 341.249V279.436ZM689.372 295.702L749.08 279.704V341.517L689.372 357.516V295.702ZM628.664 311.969L688.372 295.97V357.784L628.664 373.782V311.969ZM567.956 328.236L627.664 312.237V374.05L567.956 390.049V328.236ZM507.248 344.502L566.956 328.504V390.317L507.248 406.316V344.502ZM446.54 360.769L506.248 344.77V406.584L446.54 422.582V360.769ZM385.832 377.036L445.54 361.037V422.85L385.832 438.849V377.036ZM325.124 393.302L384.832 377.304V439.117L325.124 455.116V393.302ZM264.416 409.569L324.124 393.57V455.384L264.416 471.382V409.569ZM203.708 425.836L263.416 409.837V471.65L203.708 487.649V425.836ZM143 442.102L202.708 426.104V487.917L143 503.916V442.102ZM143 504.951V566.765L202.708 550.766V488.952L143 504.951ZM203.708 488.684V550.498L263.416 534.499V472.686L203.708 488.684ZM264.416 472.418V534.231L324.124 518.232V456.419L264.416 472.418ZM325.124 456.151V517.965L384.832 501.966V440.152L325.124 456.151ZM385.832 439.884V501.698L445.54 485.699V423.886L385.832 439.884ZM446.54 423.618V485.431L506.248 469.433V407.619L446.54 423.618ZM507.248 407.351V469.165L566.956 453.166V391.352L507.248 407.351ZM567.956 391.084V452.898L627.664 436.899V375.086L567.956 391.084ZM628.664 374.818V436.631L688.372 420.633V358.819L628.664 374.818ZM689.372 358.551V420.365L749.08 404.366V342.552L689.372 358.551ZM750.08 342.284V404.098L809.788 388.099V326.286L750.08 342.284ZM810.788 326.018V387.831L870.496 371.833V310.019L810.788 326.018ZM871.496 309.751V371.565L931.204 355.566V293.752L871.496 309.751ZM871.496 372.6L931.204 356.601V418.415L871.496 434.413V372.6ZM810.788 388.867L870.496 372.868V434.681L810.788 450.68V388.867ZM750.08 405.133L809.788 389.135V450.948L750.08 466.947V405.133ZM689.372 421.4L749.08 405.401V467.215L689.372 483.213V421.4ZM628.664 437.667L688.372 421.668V483.481L628.664 499.48V437.667ZM567.956 453.933L627.664 437.935V499.748L567.956 515.747V453.933ZM507.248 470.2L566.956 454.201V516.015L507.248 532.013V470.2ZM446.54 486.467L506.248 470.468V532.281L446.54 548.28V486.467ZM385.832 502.733L445.54 486.734V548.548L385.832 564.547V502.733ZM325.124 519L384.832 503.001V564.815L325.124 580.813V519ZM264.416 535.267L324.124 519.268V581.081L264.416 597.08V535.267ZM203.708 551.533L263.416 535.534V597.348L203.708 613.347V551.533ZM143 567.8L202.708 551.801V613.615L143 629.613V567.8ZM143 630.649V692.464L202.708 676.465V614.65L143 630.649ZM203.708 614.382V676.197L263.416 660.199V598.383L203.708 614.382ZM264.416 598.115V659.931L324.124 643.932V582.117L264.416 598.115ZM325.124 581.849V643.664L384.832 627.665V565.85L325.124 581.849ZM385.832 565.582V627.397L445.54 611.399V549.583L385.832 565.582ZM446.54 549.315V611.131L506.248 595.132V533.317L446.54 549.315ZM507.248 533.049V594.864L566.956 578.865V517.05L507.248 533.049ZM567.956 516.782V578.597L627.664 562.599V500.783L567.956 516.782ZM628.664 500.515V562.331L688.372 546.332V484.517L628.664 500.515ZM689.372 484.249V546.064L749.08 530.065V468.25L689.372 484.249ZM750.08 467.982V529.797L809.788 513.799V451.983L750.08 467.982ZM810.788 451.715V513.531L870.496 497.532V435.717L810.788 451.715ZM871.496 435.449V497.264L931.204 481.265V419.45L871.496 435.449ZM385.832 690.246V628.433L445.54 612.434V674.247L385.832 690.246ZM446.54 673.979V612.166L506.248 596.167V657.981L446.54 673.979ZM507.248 657.713V595.899L566.956 579.901V641.714L507.248 657.713ZM567.956 641.446V579.633L627.664 563.634V625.447L567.956 641.446ZM628.664 625.18V563.366L688.372 547.367V609.181L628.664 625.18ZM689.372 608.913V547.099L749.08 531.101V592.914L689.372 608.913ZM750.08 592.646V530.833L809.788 514.834V576.647L750.08 592.646ZM810.788 576.38V514.566L870.496 498.567V560.381L810.788 576.38ZM871.496 560.113V498.299L931.204 482.301V544.114L871.496 560.113ZM628.664 626.215V688.03L688.372 672.032V610.216L628.664 626.215ZM689.372 609.948V671.764L749.08 655.765V593.949L689.372 609.948ZM750.08 593.681V655.497L809.788 639.498V577.683L750.08 593.681ZM810.788 577.415V639.23L870.496 623.232V561.416L810.788 577.415ZM871.496 561.148V622.964L931.204 606.965V545.149L871.496 561.148Z" fill-opacity="0.1"></path></g><defs><radialGradient id="radial-dark" cx="0" cy="0" r="1" gradientUnits="userSpaceOnUse" gradientTransform="translate(468.373 287.536) rotate(90) scale(430.464 467.627)"><stop stop-color="#D9D9D9"></stop><stop offset="1" stop-opacity="0"></stop></radialGradient></defs></svg></span><div class="relative antialiased text-gray-500 dark:text-gray-400"><div id="navbar" class="z-30 fixed lg:sticky top-0 w-full"><div id="navbar-transition" class="absolute w-full h-full backdrop-blur flex-none transition-colors duration-500 border-b border-gray-500/5 dark:border-gray-300/[0.06] supports-backdrop-blur:bg-background-light/60 dark:bg-transparent"></div><div class="max-w-8xl mx-auto relative"><div class=""><div class="relative"><div class="flex items-center lg:px-12 h-16 min-w-0 mx-4 lg:mx-0"><div class="h-full relative flex-1 flex items-center gap-x-4 min-w-0 border-b border-gray-500/5 dark:border-gray-300/[0.06]"><div class="flex-1 flex items-center gap-x-4"><a href="/"><span class="sr-only">Zapier home page</span><img class="w-auto h-7 relative object-contain block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/light.svg" alt="light logo"/><img class="w-auto h-7 relative object-contain hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/dark.svg" alt="dark logo"/></a><div class="flex items-center gap-x-2"></div></div><button type="button" class="hidden lg:flex relative flex-1 pointer-events-auto rounded-xl w-full items-center text-sm leading-6 py-1.5 pl-3.5 pr-3 text-gray-400 dark:text-white/50 bg-background-light dark:bg-background-dark dark:brightness-[1.1] dark:ring-1 dark:hover:brightness-[1.25] ring-1 ring-gray-400/20 hover:ring-gray-600/25 dark:ring-gray-600/30 dark:hover:ring-gray-500/30 focus:outline-primary justify-between truncate gap-2 min-w-[43px] mx-px" id="search-bar-entry"><div class="flex items-center gap-3 min-w-[42px]"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-search min-w-4 flex-none text-gray-700 hover:text-gray-800 dark:text-gray-300 hover:dark:text-gray-200"><circle cx="11" cy="11" r="8"></circle><path d="m21 21-4.3-4.3"></path></svg><div class="truncate min-w-0">Search or ask...</div></div></button><div class="flex-1 relative hidden lg:flex items-center ml-auto justify-end space-x-4"><nav class="text-sm"><ul class="flex space-x-6 items-center"><li><a href="https://zapier.com/platform/login" class="whitespace-nowrap font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" target="_blank">Developer Platform Login</a></li><li><a class="whitespace-nowrap font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" href="/_sites/[subdomain]/platform/reference/cli-docs">Platform CLI</a></li><li class="block lg:hidden"><a class="whitespace-nowrap font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" href="https://zapier.com/sign-up">Sign Up</a></li><li class="whitespace-nowrap hidden lg:flex" id="topbar-cta-button"><a target="_blank" class="group px-4 py-1.5 relative inline-flex items-center text-sm font-medium" href="https://zapier.com/sign-up"><span class="absolute inset-0 bg-primary-dark rounded-full group-hover:opacity-[0.9]"></span><div class="mr-0.5 space-x-2.5 flex items-center"><span class="z-10 text-white">Sign Up</span><svg width="3" height="24" viewBox="0 -9 3 24" class="h-5 rotate-0 overflow-visible text-white/90"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></a></li></ul></nav><div class="flex items-center"><button class="group p-2 flex items-center justify-center" aria-label="Toggle dark mode"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" stroke="currentColor" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4 block text-gray-400 dark:hidden group-hover:text-gray-600"><g clip-path="url(#clip0_2880_7340)"><path d="M8 1.11133V2.00022" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.8711 3.12891L12.2427 3.75735" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M14.8889 8H14" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.8711 12.8711L12.2427 12.2427" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8 14.8889V14" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3.12891 12.8711L3.75735 12.2427" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M1.11133 8H2.00022" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3.12891 3.12891L3.75735 3.75735" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8.00043 11.7782C10.0868 11.7782 11.7782 10.0868 11.7782 8.00043C11.7782 5.91402 10.0868 4.22266 8.00043 4.22266C5.91402 4.22266 4.22266 5.91402 4.22266 8.00043C4.22266 10.0868 5.91402 11.7782 8.00043 11.7782Z" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></g><defs><clipPath id="clip0_2880_7340"><rect width="16" height="16" fill="white"></rect></clipPath></defs></svg><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-moon h-4 w-4 hidden dark:block text-gray-500 dark:group-hover:text-gray-300"><path d="M12 3a6 6 0 0 0 9 9 9 9 0 1 1-9-9Z"></path></svg></button></div></div><div class="flex lg:hidden items-center gap-2"><button type="button" class="text-gray-500 w-8 h-8 flex items-center justify-center hover:text-gray-600 dark:text-gray-400 dark:hover:text-gray-300" id="search-bar-entry-mobile"><span class="sr-only">Search...</span><svg class="h-4 w-4 bg-gray-500 dark:bg-gray-400 hover:bg-gray-600 dark:hover:bg-gray-300" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/magnifying-glass.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/magnifying-glass.svg);mask-repeat:no-repeat;mask-position:center"></svg></button><button aria-label="More actions" class="h-7 w-5 flex items-center justify-end"><svg class="h-4 w-4 bg-gray-500 dark:bg-gray-400 hover:bg-gray-600 dark:hover:bg-gray-300" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/ellipsis-vertical.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/ellipsis-vertical.svg);mask-repeat:no-repeat;mask-position:center"></svg></button></div></div></div><div class="flex items-center h-14 py-4 px-5 lg:hidden"><button type="button" class="text-gray-500 hover:text-gray-600 dark:text-gray-400 dark:hover:text-gray-300"><span class="sr-only">Navigation</span><svg class="h-4" fill="currentColor" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"></path></svg></button><div class="ml-4 flex text-sm leading-6 whitespace-nowrap min-w-0 space-x-3"><div class="font-semibold text-gray-900 truncate dark:text-gray-200">Welcome</div></div></div></div><div class="hidden lg:flex px-12 h-12"><div class="h-full flex text-sm space-x-6"><a class="group relative h-full flex items-center text-gray-800 dark:text-gray-200 font-semibold" href="/platform/home">Developer Platform<div class="absolute bottom-0 h-[1.5px] w-full bg-primary dark:bg-primary-light"></div></a><a class="group relative h-full flex items-center font-medium text-gray-600 dark:text-gray-400 group-hover:text-gray-800 dark:group-hover:text-gray-300" href="/partner-solutions/getting-started">Partner Solutions<div class="absolute bottom-0 h-[1.5px] w-full group-hover:bg-gray-200 dark:group-hover:bg-gray-700"></div></a><a class="group relative h-full flex items-center font-medium text-gray-600 dark:text-gray-400 group-hover:text-gray-800 dark:group-hover:text-gray-300" href="/ai-actions/intro">AI Actions<div class="absolute bottom-0 h-[1.5px] w-full group-hover:bg-gray-200 dark:group-hover:bg-gray-700"></div></a></div></div></div></div></div><div class="max-w-8xl px-4 mx-auto lg:px-8"><div class="z-20 hidden lg:block fixed bottom-0 right-auto w-[18rem] top-[7.1rem]" id="sidebar"><div class="absolute inset-0 z-10 stable-scrollbar-gutter overflow-auto pr-8 pb-10" id="sidebar-content"><div class="relative lg:text-sm lg:leading-6"><div class="sticky top-0 h-8"></div><div id="navigation-items"><li class="list-none"><a href="https://community.zapier.com/" target="_blank" rel="noreferrer" class="pl-4 group flex items-center lg:text-sm lg:leading-6 mb-5 sm:mb-4 font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300"><div class="mr-4 rounded-md p-1 zinc-box group-hover:brightness-100 group-hover:ring-0 ring-1 ring-gray-950/5 dark:ring-gray-700/40"><svg class="h-4 w-4 secondary-opacity group-hover:fill-primary-dark group-hover:bg-white bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/duotone/users.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/duotone/users.svg);mask-repeat:no-repeat;mask-position:center"></svg></div>Community</a></li><li class="list-none"><a href="https://zapier.com/blog/" target="_blank" rel="noreferrer" class="pl-4 group flex items-center lg:text-sm lg:leading-6 mb-5 sm:mb-4 font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300"><div class="mr-4 rounded-md p-1 zinc-box group-hover:brightness-100 group-hover:ring-0 ring-1 ring-gray-950/5 dark:ring-gray-700/40"><svg class="h-4 w-4 secondary-opacity group-hover:fill-primary-dark group-hover:bg-white bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/duotone/newspaper.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/duotone/newspaper.svg);mask-repeat:no-repeat;mask-position:center"></svg></div>Blog</a></li><li class="list-none"><a href="https://developer.zapier.com/contact" target="_blank" rel="noreferrer" class="pl-4 group flex items-center lg:text-sm lg:leading-6 mb-5 sm:mb-4 font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300"><div class="mr-4 rounded-md p-1 zinc-box group-hover:brightness-100 group-hover:ring-0 ring-1 ring-gray-950/5 dark:ring-gray-700/40"><svg class="h-4 w-4 secondary-opacity group-hover:fill-primary-dark group-hover:bg-white bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/duotone/envelope.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/duotone/envelope.svg);mask-repeat:no-repeat;mask-position:center"></svg></div>Contact Us</a></li><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200"></h5><ul><li id="/platform/home" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl bg-primary/10 text-primary font-semibold dark:text-primary-light dark:bg-primary-light/10" style="padding-left:1rem" href="/platform/home"><div class="flex-1 flex items-center space-x-2.5"><div>Welcome</div></div></a></li><li id="https://zapier.com/platform/login" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" target="_blank" href="https://zapier.com/platform/login"><div class="flex-1 flex items-center space-x-2.5"><div>Developer Platform Login</div><svg class="h-2.5 text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" fill="currentColor"><path d="M328 96c13.3 0 24 10.7 24 24V360c0 13.3-10.7 24-24 24s-24-10.7-24-24V177.9L73 409c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l231-231H88c-13.3 0-24-10.7-24-24s10.7-24 24-24H328z"></path></svg></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200">Quick start</h5><ul><li id="/platform/quickstart/build-integration" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/quickstart/build-integration"><div class="flex-1 flex items-center space-x-2.5"><div>Introduction</div></div></a></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Developer tools</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Glossary</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">How it works</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li id="/platform/quickstart/recommended-triggers-and-actions" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/quickstart/recommended-triggers-and-actions"><div class="flex-1 flex items-center space-x-2.5"><div>Recommended triggers and actions</div></div></a></li><li id="/platform/quickstart/trusted-developers" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/quickstart/trusted-developers"><div class="flex-1 flex items-center space-x-2.5"><div>Zapier trusted app developers</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200">Build with UI</h5><ul><li id="/platform/quickstart/ui-tutorial" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/quickstart/ui-tutorial"><div class="flex-1 flex items-center space-x-2.5"><div>Platform UI tutorial</div></div></a></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Actions</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Advanced features</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Authentication</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Input Fields</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Output Fields</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Testing</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Triggers</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Troubleshooting</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li id="/platform/build/form-mode" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/build/form-mode"><div class="flex-1 flex items-center space-x-2.5"><div>Use form mode to setup your API calls</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200">Build with CLI</h5><ul><li id="/platform/build-cli/overview" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/build-cli/overview"><div class="flex-1 flex items-center space-x-2.5"><div>Overview</div></div></a></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Features</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li id="/platform/quickstart/cli-tutorial" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/quickstart/cli-tutorial"><div class="flex-1 flex items-center space-x-2.5"><div>Platform CLI tutorial</div></div></a></li><li id="/platform/build-cli/faqs" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/build-cli/faqs"><div class="flex-1 flex items-center space-x-2.5"><div>FAQs</div></div></a></li><li id="/platform/build-cli/core" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/build-cli/core"><div class="flex-1 flex items-center space-x-2.5"><div>Core Reference</div></div></a></li><li id="https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" target="_blank" href="https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md"><div class="flex-1 flex items-center space-x-2.5"><div>CLI Reference</div><svg class="h-2.5 text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" fill="currentColor"><path d="M328 96c13.3 0 24 10.7 24 24V360c0 13.3-10.7 24-24 24s-24-10.7-24-24V177.9L73 409c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l231-231H88c-13.3 0-24-10.7-24-24s10.7-24 24-24H328z"></path></svg></div></a></li><li id="https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" target="_blank" href="https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md"><div class="flex-1 flex items-center space-x-2.5"><div>Schema Reference</div><svg class="h-2.5 text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" fill="currentColor"><path d="M328 96c13.3 0 24 10.7 24 24V360c0 13.3-10.7 24-24 24s-24-10.7-24-24V177.9L73 409c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l231-231H88c-13.3 0-24-10.7-24-24s10.7-24 24-24H328z"></path></svg></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200">Manage</h5><ul><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Account and team</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Integration changes</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Integration performance</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Sharing</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Versions</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li id="/platform/manage/branding-cli" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/manage/branding-cli"><div class="flex-1 flex items-center space-x-2.5"><div>Add integration branding in Platform CLI</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200">Publish</h5><ul><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Branding</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Launch process</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Partner program</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Validation</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200">Embed</h5><ul><li id="/platform/embed/partner-solutions" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/embed/partner-solutions"><div class="flex-1 flex items-center space-x-2.5"><div>Partner Solutions Documentation</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200">Reference</h5><ul><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><div class="">Use cases</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li id="/platform/reference/transfer" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/reference/transfer"><div class="flex-1 flex items-center space-x-2.5"><div>Transfer</div></div></a></li><li id="/platform/reference/ai-actions" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/reference/ai-actions"><div class="flex-1 flex items-center space-x-2.5"><div>AI Actions</div></div></a></li><li id="/platform/reference/custom-actions-api-requests" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/reference/custom-actions-api-requests"><div class="flex-1 flex items-center space-x-2.5"><div>Custom Actions and API Requests Actions</div></div></a></li><li id="/platform/reference/legacy-scripting" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/platform/reference/legacy-scripting"><div class="flex-1 flex items-center space-x-2.5"><div>Scripting in converted Legacy Web Builder Integrations</div></div></a></li><li id="https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" target="_blank" href="https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md"><div class="flex-1 flex items-center space-x-2.5"><div>Changelog</div><svg class="h-2.5 text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" fill="currentColor"><path d="M328 96c13.3 0 24 10.7 24 24V360c0 13.3-10.7 24-24 24s-24-10.7-24-24V177.9L73 409c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l231-231H88c-13.3 0-24-10.7-24-24s10.7-24 24-24H328z"></path></svg></div></a></li><li id="https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" target="_blank" href="https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md"><div class="flex-1 flex items-center space-x-2.5"><div>CLI Reference</div><svg class="h-2.5 text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" fill="currentColor"><path d="M328 96c13.3 0 24 10.7 24 24V360c0 13.3-10.7 24-24 24s-24-10.7-24-24V177.9L73 409c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l231-231H88c-13.3 0-24-10.7-24-24s10.7-24 24-24H328z"></path></svg></div></a></li><li id="https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 rounded-xl hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" target="_blank" href="https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md"><div class="flex-1 flex items-center space-x-2.5"><div>Schema Reference</div><svg class="h-2.5 text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" fill="currentColor"><path d="M328 96c13.3 0 24 10.7 24 24V360c0 13.3-10.7 24-24 24s-24-10.7-24-24V177.9L73 409c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l231-231H88c-13.3 0-24-10.7-24-24s10.7-24 24-24H328z"></path></svg></div></a></li></ul></div></div></div></div></div><div class="" id="content-container"><div class="flex flex-row gap-12 box-border w-full pt-40 lg:pt-10"><div class="relative grow box-border flex-col w-full mx-auto px-1 lg:pl-[23.7rem] lg:-ml-12 xl:w-[calc(100%-28rem)]" id="content-area"><header id="header" class="relative"><div class="mt-0.5 space-y-2.5"><div class="flex items-center"><h1 class="inline-block text-2xl sm:text-3xl font-bold text-gray-900 tracking-tight dark:text-gray-200">Welcome</h1></div></div></header><div class="flex flex-col gap-8"></div><div class="relative mt-8 prose prose-gray dark:prose-invert"><h3 class="flex whitespace-pre-wrap group font-semibold" id="explore-our-guides-and-start-building-a-zapier-integration-today"><div class="absolute"><a href="#explore-our-guides-and-start-building-a-zapier-integration-today" class="-ml-10 flex items-center opacity-0 border-0 group-hover:opacity-100" aria-label="Navigate to header"><div class="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20"><svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512"><path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path></svg></div></a></div><span class="cursor-pointer">Explore our guides and start building a Zapier integration today</span></h3> <p>Welcome to the Zapier Developer Platform documentation! Whether you are a new or experienced integration builder, this is your go-to resource for learning how to create and manage powerful apps on the Zapier platform.</p> <h3 class="flex whitespace-pre-wrap group font-semibold" id="what-you-ll-find-here"><div class="absolute"><a href="#what-you-ll-find-here" class="-ml-10 flex items-center opacity-0 border-0 group-hover:opacity-100" aria-label="Navigate to header"><div class="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20"><svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512"><path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path></svg></div></a></div><span class="cursor-pointer">What You’ll Find Here</span></h3> <ul> <li> <p><strong>Getting Started</strong>: Learn the basics of building integrations, from understanding Zapier’s architecture to setting up your first app using the <strong>Visual Builder</strong> or <strong>CLI</strong>.</p> </li> <li> <p><strong>Visual Builder Guide</strong>: If you’re looking for a fast, no-code way to integrate your app with Zapier, the Visual Builder is the place to start. It’s ideal for quick deployment and collaboration across teams, even without developer expertise.</p> </li> <li> <p><strong>CLI Guide</strong>: For more complex needs, dive into the <strong>Zapier CLI</strong>, which gives developers full control over the integration process, using custom code to handle authentication, triggers, actions, and searches.</p> </li> <li> <p><strong>Best Practices</strong>: Guidance on how to optimize your integrations for performance, user experience, and maintainability.</p> </li> <li> <p><strong>Advanced Features</strong>: Explore OAuth authentication, dynamic dropdowns, and other advanced options to provide a more customized experience in your integration.</p> </li> <li> <p><strong>Deployment and Testing</strong>: Once your integration is ready, follow the steps for deploying, testing, and promoting your app version to Zapier’s marketplace of over 1 million users.</p> </li> </ul> <h3 class="flex whitespace-pre-wrap group font-semibold" id="why-build-on-zapier"><div class="absolute"><a href="#why-build-on-zapier" class="-ml-10 flex items-center opacity-0 border-0 group-hover:opacity-100" aria-label="Navigate to header"><div class="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20"><svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512"><path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path></svg></div></a></div><span class="cursor-pointer">Why Build on Zapier?</span></h3> <ul> <li><strong>Reach Millions of Users</strong>: By integrating with Zapier, your app becomes part of a thriving ecosystem that connects with thousands of other services.</li> <li><strong>Save Time with Automation</strong>: Zapier simplifies repetitive tasks, letting your users focus on what matters most by automating workflows across tools.</li> <li><strong>Fast and Flexible</strong>: Use the Visual Builder for quick, no-code setups or the CLI for full control and customization.</li> </ul> <h3 class="flex whitespace-pre-wrap group font-semibold" id="quick-links"><div class="absolute"><a href="#quick-links" class="-ml-10 flex items-center opacity-0 border-0 group-hover:opacity-100" aria-label="Navigate to header"><div class="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20"><svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512"><path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path></svg></div></a></div><span class="cursor-pointer">Quick Links</span></h3> <ul> <li><a href="https://zapier.com/resources/guides/quick-start" target="_blank" rel="noreferrer">Getting Started Tutorial</a></li> <li><a href="https://developer.zapier.com/" target="_blank" rel="noreferrer">Zapier Developer Platform</a></li> <li><a href="https://docs.zapier.com/platform/reference/cli-docs" target="_blank" rel="noreferrer">CLI Documentation</a></li> </ul> <p>Ready to dive in? Choose your path—start building with the Visual Builder or master the CLI for complete customization.</p></div><div class="leading-6 mt-14"><div class="mb-12 px-0.5 flex items-center text-sm font-semibold text-gray-700 dark:text-gray-200"><a class="flex items-center ml-auto space-x-3 group" href="/platform/dev-platform-login"><span class="group-hover:text-gray-900 dark:group-hover:text-white">Developer Platform Login</span><svg viewBox="0 0 3 6" class="rotate-180 h-1.5 stroke-gray-400 overflow-visible group-hover:stroke-gray-600 dark:group-hover:stroke-gray-300"><path d="M3 0L0 3L3 6" fill="none" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></a></div><footer id="footer" class="flex gap-12 justify-between pt-10 border-t border-gray-100 sm:flex dark:border-gray-800/50 pb-28"><div class="flex gap-6 flex-wrap"><a href="http://www.facebook.com/ZapierApp?utm_source=zapier.com&amp;utm_medium=referral&amp;utm_campaign=zapier" target="_blank"><span class="sr-only">facebook</span><svg class="w-5 h-5 bg-gray-400 dark:bg-gray-500 hover:bg-gray-500 dark:hover:bg-gray-400" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/facebook.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/facebook.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://www.linkedin.com/company/zapier/?utm_source=zapier.com&amp;utm_medium=referral&amp;utm_campaign=zapier" target="_blank"><span class="sr-only">linkedin</span><svg class="w-5 h-5 bg-gray-400 dark:bg-gray-500 hover:bg-gray-500 dark:hover:bg-gray-400" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/linkedin.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/linkedin.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://twitter.com/zapier?utm_source=zapier.com&amp;utm_medium=referral&amp;utm_campaign=zapier#!/zapier" target="_blank"><span class="sr-only">x</span><svg class="w-5 h-5 bg-gray-400 dark:bg-gray-500 hover:bg-gray-500 dark:hover:bg-gray-400" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/x-twitter.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/x-twitter.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://www.youtube.com/user/ZapierApp/videos?utm_source=zapier.com&amp;utm_medium=referral&amp;utm_campaign=zapier" target="_blank"><span class="sr-only">youtube</span><svg class="w-5 h-5 bg-gray-400 dark:bg-gray-500 hover:bg-gray-500 dark:hover:bg-gray-400" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/youtube.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/youtube.svg);mask-repeat:no-repeat;mask-position:center"></svg></a></div></footer></div></div><div class="hidden xl:flex self-start sticky h-[calc(100vh-8rem-1.5rem-1.5rem)] top-[calc(8rem+1.5rem)]" id="content-side-layout"><div class="z-10 hidden xl:flex pl-10 box-border w-[19rem]" id="table-of-contents"><div id="table-of-contents-content" class="text-gray-600 text-sm leading-6 w-[16.5rem] overflow-y-auto space-y-2"><div class="text-gray-700 dark:text-gray-300 font-medium flex items-center space-x-2"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="2" xmlns="http://www.w3.org/2000/svg" class="h-3 w-3"><path d="M2.44434 12.6665H13.5554" stroke-linecap="round" stroke-linejoin="round"></path><path d="M2.44434 3.3335H13.5554" stroke-linecap="round" stroke-linejoin="round"></path><path d="M2.44434 8H7.33323" stroke-linecap="round" stroke-linejoin="round"></path></svg><span>On this page</span></div><ul><li><a href="#explore-our-guides-and-start-building-a-zapier-integration-today" class="py-1 block hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300">Explore our guides and start building a Zapier integration today</a></li><li><a href="#what-you-ll-find-here" class="py-1 block hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300">What You’ll Find Here</a></li><li><a href="#why-build-on-zapier" class="py-1 block hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300">Why Build on Zapier?</a></li><li><a href="#quick-links" class="py-1 block hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300">Quick Links</a></li></ul></div></div></div></div></div></div></div></main></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"mdxSource":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {Heading} = _components;\n if (!Heading) _missingMdxReference(\"Heading\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(Heading, {\n level: \"3\",\n id: \"explore-our-guides-and-start-building-a-zapier-integration-today\",\n children: \"Explore our guides and start building a Zapier integration today\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Welcome to the Zapier Developer Platform documentation! Whether you are a new or experienced integration builder, this is your go-to resource for learning how to create and manage powerful apps on the Zapier platform.\"\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"what-you-ll-find-here\",\n children: \"What You’ll Find Here\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Getting Started\"\n }), \": Learn the basics of building integrations, from understanding Zapier’s architecture to setting up your first app using the \", _jsx(_components.strong, {\n children: \"Visual Builder\"\n }), \" or \", _jsx(_components.strong, {\n children: \"CLI\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Visual Builder Guide\"\n }), \": If you’re looking for a fast, no-code way to integrate your app with Zapier, the Visual Builder is the place to start. It’s ideal for quick deployment and collaboration across teams, even without developer expertise.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"CLI Guide\"\n }), \": For more complex needs, dive into the \", _jsx(_components.strong, {\n children: \"Zapier CLI\"\n }), \", which gives developers full control over the integration process, using custom code to handle authentication, triggers, actions, and searches.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Best Practices\"\n }), \": Guidance on how to optimize your integrations for performance, user experience, and maintainability.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Advanced Features\"\n }), \": Explore OAuth authentication, dynamic dropdowns, and other advanced options to provide a more customized experience in your integration.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Deployment and Testing\"\n }), \": Once your integration is ready, follow the steps for deploying, testing, and promoting your app version to Zapier’s marketplace of over 1 million users.\"]\n }), \"\\n\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"why-build-on-zapier\",\n children: \"Why Build on Zapier?\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Reach Millions of Users\"\n }), \": By integrating with Zapier, your app becomes part of a thriving ecosystem that connects with thousands of other services.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Save Time with Automation\"\n }), \": Zapier simplifies repetitive tasks, letting your users focus on what matters most by automating workflows across tools.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Fast and Flexible\"\n }), \": Use the Visual Builder for quick, no-code setups or the CLI for full control and customization.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"quick-links\",\n children: \"Quick Links\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://zapier.com/resources/guides/quick-start\",\n children: \"Getting Started Tutorial\"\n })\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://developer.zapier.com/\",\n children: \"Zapier Developer Platform\"\n })\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://docs.zapier.com/platform/reference/cli-docs\",\n children: \"CLI Documentation\"\n })\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Ready to dive in? Choose your path—start building with the Visual Builder or master the CLI for complete customization.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{"config":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Zapier","colors":{"primary":"#FF4F00","light":"#FE6C2A","dark":"#FF4F00"},"favicon":"/favicon.png","navigation":{"tabs":[{"tab":"Developer Platform","groups":[{"group":"","pages":["platform/home","platform/dev-platform-login"]},{"group":"Quick start","pages":["platform/quickstart/build-integration",{"group":"Developer tools","pages":["platform/quickstart/ui-vs-cli","platform/quickstart/ui-tutorial","platform/quickstart/cli-tutorial","platform/quickstart/get-help"]},{"group":"Glossary","pages":["platform/quickstart/glossary"]},{"group":"How it works","pages":["platform/quickstart/how-zapier-works","platform/quickstart/zapier-integration-structure","platform/quickstart/private-vs-public-integrations"]},"platform/quickstart/recommended-triggers-and-actions","platform/quickstart/trusted-developers"]},{"group":"Build with UI","pages":["platform/quickstart/ui-tutorial",{"group":"Actions","pages":["platform/build/action","platform/build/create","platform/build/search","platform/build/reorder-action","platform/build/search-or-create"]},{"group":"Advanced features","pages":["platform/build/env","platform/build/errors","platform/build/bundle","platform/build/code-mode","platform/build/hydration-cli","platform/build/static-ip"]},{"group":"Authentication","pages":["platform/build/auth","platform/build/apikeyauth","platform/build/basicauth","platform/build/digestauth","platform/build/oauth","platform/build/sessionauth","platform/build/connection-label","platform/build/computed-fields","platform/build/computed-test-field","platform/build/requesttemplate","platform/build/subdomain-validation"]},{"group":"Input Fields","pages":["platform/build/field-definitions","platform/build/add-fields","platform/build/dynamic-field","platform/build/line-items","platform/build/search-powered-fields"]},{"group":"Output Fields","pages":["platform/build/sample-data","platform/build/response-types"]},{"group":"Testing","pages":["platform/build/test-auth","platform/build/test-triggers-actions","platform/build/test-tools","platform/build/test-monitoring"]},{"group":"Triggers","pages":["platform/build/trigger","platform/build/polling-trigger","platform/build/hook-trigger","platform/build/reorder-trigger","platform/build/deduplication","platform/build/pagination-trigger","platform/build/cli-hook-trigger"]},{"group":"Troubleshooting","pages":["platform/build/operating-constraints","platform/build/troubleshoot-trigger-timeouts","platform/build/troubleshoot-trigger-payload","platform/build/troubleshoot-action-timeouts","platform/build/troubleshoot-action-payload","platform/build/troubleshoot-custom-fields","platform/build/reduce-api-requests","platform/build/troubleshoot-throttles","platform/build/hydration-limits","platform/build/error-array-expected","platform/build/error-non-object","platform/build/error-non-object-array"]},"platform/build/form-mode"]},{"group":"Build with CLI","pages":["platform/build-cli/overview",{"group":"Features","pages":[{"group":"Input Fields","pages":["platform/build-cli/input-fields","platform/build/field-definitions","platform/build-cli/dynamic-dropdowns"]}]},"platform/quickstart/cli-tutorial","platform/build-cli/faqs","platform/build-cli/core","platform/reference/cli","platform/reference/schema"]},{"group":"Manage","pages":[{"group":"Account and team","pages":["platform/manage/add-team"]},{"group":"Integration changes","pages":["platform/manage/planning-changes","platform/manage/auth-scheme","platform/manage/auth-required","platform/manage/auth-keys","platform/manage/change-keys","platform/manage/required-input","platform/manage/input-key","platform/manage/output-key","platform/manage/output","platform/manage/change-trigger","platform/manage/change-perform","platform/manage/change-api","platform/manage/export-cli","platform/manage/export-ui","platform/manage/essential-tips-iq"]},{"group":"Integration performance","pages":["platform/manage/api-outage","platform/manage/embed-insights","platform/manage/user-feedback","platform/manage/error-handling","platform/manage/active-users","platform/manage/integration-insights","platform/manage/zap-activation","platform/manage/embed-activation"]},{"group":"Sharing","pages":["platform/manage/sharing"]},{"group":"Versions","pages":["platform/manage/versions","platform/manage/clone","platform/manage/promote","platform/manage/migrate","platform/manage/deprecate","platform/manage/versions-legacy"]},"platform/manage/branding-cli"]},{"group":"Publish","pages":[{"group":"Branding","pages":["platform/publish/branding-guidelines","platform/publish/add-or-modify-branding"]},{"group":"Launch process","pages":["platform/publish/public-integration","platform/publish/integration-build-guidelines","platform/publish/integration-publishing-requirements","platform/publish/zap-templates","platform/publish/user-help","platform/publish/best-practices","platform/publish/zps"]},{"group":"Partner program","pages":["platform/publish/partner-program","platform/publish/partner-faq","platform/publish/benefits-guide"]},{"group":"Validation","pages":["platform/publish/integration-checks-reference"]}]},{"group":"Embed","pages":["platform/embed/partner-solutions"]},{"group":"Reference","pages":[{"group":"Use cases","pages":["platform/reference/forms-app","platform/reference/crm-app","platform/reference/project-app","platform/reference/ai-app"]},"platform/reference/transfer","platform/reference/ai-actions","platform/reference/custom-actions-api-requests","platform/reference/legacy-scripting","platform/reference/changelog","platform/reference/cli","platform/reference/schema"]}]},{"tab":"Partner Solutions","openapi":{"source":"https://api.zapier.com/schema","directory":"partner-solutions/"},"groups":[{"group":"Welcome","pages":["partner-solutions/getting-started"]},{"group":"Workflow API","pages":["partner-solutions/workflow-api/intro",{"group":"Building a Workflow","pages":["partner-solutions/workflow-api/Building-a-Zap","partner-solutions/workflow-api/Fields-and-Fieldsets","partner-solutions/workflow-api/Selecting-an-Action","partner-solutions/workflow-api/Selecting-an-Authentication",{"group":"Custom Flows","pages":["partner-solutions/workflow-api/testing-a-step","partner-solutions/workflow-api/Hardcoding-an-Action","partner-solutions/workflow-api/adding-an-authentication"]},"partner-solutions/workflow-api/limitations"]},"partner-solutions/workflow-api/list-apps","partner-solutions/workflow-api/list-zaps","partner-solutions/workflow-api/list-zap-templates","partner-solutions/workflow-api/embed-zap-editor"]},{"group":"Workflow Element","pages":["partner-solutions/workflow-element/intro","partner-solutions/elements-security","partner-solutions/embed-insights"]},{"group":"Embed Enhancements","pages":["partner-solutions/pre-filled-zaps","partner-solutions/quick-account-creation"]},{"group":"Getting Started With the API","pages":["partner-solutions/api-reference/authentication","partner-solutions/api-reference/rate-limiting"]},{"group":"Apps","pages":["partner-solutions/api-reference/apps/get-apps-[v1]","partner-solutions/api-reference/apps/get-apps-[v2]"]},{"group":"Categories","pages":["partner-solutions/api-reference/categories/get-categories"]},{"group":"Accounts","pages":["partner-solutions/api-reference/accounts/user-profile","partner-solutions/api-reference/accounts/create-account"]},{"group":"Zap Templates","pages":["partner-solutions/api-reference/zap-templates/get-zap-templates"]},{"group":"Zaps","pages":["partner-solutions/api-reference/zaps/get-zaps-[v1]","partner-solutions/api-reference/zaps/guess-a-zap","partner-solutions/api-reference/zaps/get-zaps-[v2]","partner-solutions/api-reference/zaps/create-a-zap"]},{"group":"Actions","pages":["partner-solutions/api-reference/actions/get-actions","partner-solutions/api-reference/actions/get-input-fields","partner-solutions/api-reference/actions/get-choices","partner-solutions/api-reference/actions/get-output-fields","partner-solutions/api-reference/actions/step-test"]},{"group":"Authentications","pages":["partner-solutions/api-reference/authentications/get-authentications","partner-solutions/api-reference/authentications/create-authentication"]},{"group":"Experimental","pages":["partner-solutions/api-reference/experimental/create-a-workflow-step"]},{"group":"Schemas","pages":[{"group":"Common Types","pages":["partner-solutions/api-reference/common-types/action","partner-solutions/api-reference/common-types/app","partner-solutions/api-reference/common-types/authentication","partner-solutions/api-reference/common-types/choice","partner-solutions/api-reference/common-types/fieldset","partner-solutions/api-reference/common-types/infoField","partner-solutions/api-reference/common-types/inputField","partner-solutions/api-reference/common-types/outputField","partner-solutions/api-reference/common-types/zap","partner-solutions/api-reference/common-types/errors","partner-solutions/api-reference/common-types/pagination","partner-solutions/api-reference/common-types/requests","partner-solutions/api-reference/common-types/responses"]}]},{"group":"Apps","pages":["partner-solutions/apps/get-apps-[v1]","partner-solutions/apps/get-apps-[v2]"]},{"group":"Categories","pages":["partner-solutions/categories/get-categories"]},{"group":"Accounts","pages":["partner-solutions/accounts/user-profile","partner-solutions/accounts/create-account"]},{"group":"Zap Templates","pages":["partner-solutions/zap-templates/get-zap-templates"]},{"group":"Zaps","pages":["partner-solutions/zaps/get-zaps-[v1]","partner-solutions/zaps/guess-a-zap-[beta]","partner-solutions/zaps/get-zaps-[v2]","partner-solutions/zaps/create-a-zap"]},{"group":"Actions","pages":["partner-solutions/actions/get-actions","partner-solutions/actions/get-input-fields","partner-solutions/actions/get-choices","partner-solutions/actions/get-output-fields","partner-solutions/actions/step-test"]},{"group":"Authentications","pages":["partner-solutions/authentications/get-authentications","partner-solutions/authentications/create-authentication"]},{"group":"Experimental","pages":["partner-solutions/experimental/create-a-workflow-step","partner-solutions/experimental/get-zap-runs"]}]},{"tab":"AI Actions","groups":[{"group":"Getting Started","pages":["ai-actions/intro","ai-actions/quickstart"]},{"group":"How to","pages":["ai-actions/how-tos/auth","ai-actions/how-tos/account-list","ai-actions/how-tos/stateless-vs-stored",{"group":"Stored actions","pages":["ai-actions/how-tos/stored/intro","ai-actions/how-tos/stored/action-configuration","ai-actions/how-tos/stored/list-actions","ai-actions/how-tos/stored/run-stored-action",{"group":"Manage stored actions","pages":["ai-actions/how-tos/stored/manage/get-action","ai-actions/how-tos/stored/manage/create-action","ai-actions/how-tos/stored/manage/update-action","ai-actions/how-tos/stored/manage/delete-action"]}]},{"group":"Stateless actions","pages":["ai-actions/how-tos/stateless/intro","ai-actions/how-tos/stateless/run-stateless-action"]},{"group":"Gathering action information","pages":["ai-actions/how-tos/action-info/introduction","ai-actions/how-tos/action-info/find-app","ai-actions/how-tos/action-info/find-action","ai-actions/how-tos/action-info/choose-auth","ai-actions/how-tos/action-info/action-details","ai-actions/how-tos/action-info/prefill-choices"]}]},{"group":"API Reference","pages":[{"group":"system","pages":["ai-actions/api-reference/system/app-health-check"]},{"group":"auth","pages":["ai-actions/api-reference/auth/check-user-auth","ai-actions/api-reference/auth/get-account-list","ai-actions/api-reference/auth/get-user-login-link","ai-actions/api-reference/auth/get-oauth-login-link"]},{"group":"apps","pages":["ai-actions/api-reference/apps/search-apps","ai-actions/api-reference/apps/get-app-details","ai-actions/api-reference/apps/list-authentications-for-app"]},{"group":"actions","pages":["ai-actions/api-reference/actions/search-actions","ai-actions/api-reference/actions/get-action-details","ai-actions/api-reference/actions/get-prefill-choices"]},{"group":"execution","pages":["ai-actions/api-reference/execution/execute-stateless-ai-action","ai-actions/api-reference/execution/execute-stored-ai-action","ai-actions/api-reference/execution/preview-stored-ai-action","ai-actions/api-reference/execution/rate-execution-log"]},{"group":"ai-actions","pages":["ai-actions/api-reference/ai-actions/list-ai-actions","ai-actions/api-reference/ai-actions/create-ai-action","ai-actions/api-reference/ai-actions/get-ai-action","ai-actions/api-reference/ai-actions/update-ai-action","ai-actions/api-reference/ai-actions/delete-ai-action"]},{"group":"utilities","pages":["ai-actions/api-reference/utilities/guess-actions","ai-actions/api-reference/utilities/shrink-result"]}]},{"group":"Tools","pages":["ai-actions/tools/stateless-action"]},{"group":"Libraries","pages":[{"group":"TypeScript (Node.js, Deno)","icon":"node-js","pages":["ai-actions/libraries/nodejs/getting-started","ai-actions/libraries/nodejs/authentication","ai-actions/libraries/nodejs/usage","ai-actions/libraries/nodejs/nextjs-reccommendation"]},{"group":"React Components","icon":"react","pages":["ai-actions/libraries/react/getting-started",{"group":"Components","pages":["ai-actions/libraries/react/ai-actions-provider","ai-actions/libraries/react/action-list","ai-actions/libraries/react/edit-action","ai-actions/libraries/react/stateless-creator"]}]}]},{"group":"Development Resources","pages":["ai-actions/developer-resources/openapi","ai-actions/developer-resources/keys","ai-actions/developer-resources/logs"]},{"group":"Help","pages":["ai-actions/help/community","ai-actions/help/bug"]}]}],"global":{"anchors":[{"anchor":"Community","href":"https://community.zapier.com/","icon":"users"},{"anchor":"Blog","href":"https://zapier.com/blog/","icon":"newspaper"},{"anchor":"Contact Us","href":"https://developer.zapier.com/contact","icon":"envelope"}]}},"logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/dark.svg"},"api":{"openapi":["https://actions.zapier.com/api/v2/openapi.json"]},"background":{"decoration":"windows"},"navbar":{"links":[{"label":"Developer Platform Login","href":"https://zapier.com/platform/login"},{"label":"Platform CLI","href":"platform/reference/cli-docs"}],"primary":{"type":"button","label":"Sign Up","href":"https://zapier.com/sign-up"}},"footer":{"socials":{"facebook":"http://www.facebook.com/ZapierApp?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier","linkedin":"https://www.linkedin.com/company/zapier/?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier","x":"https://twitter.com/zapier?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier#!/zapier","youtube":"https://www.youtube.com/user/ZapierApp/videos?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier"}},"redirects":[{"destination":"/platform/build-cli/overview","source":"/platform/reference/cli-docs","_id":"67abccd35460d958c1f7a287"},{"destination":"/platform/build-cli/dynamic-dropdowns","source":"/platform/build/dynamic-dropdowns","_id":"67abccd35460d958c1f7a288"},{"destination":"/platform/build-cli/dynamic-dropdowns","source":"/platform/build/search-powered-fields","_id":"67abccd35460d958c1f7a289"}]},"pageMetadata":{"title":"Welcome","description":null,"path":"/","href":"/platform/home"}}},"mdxExtracts":{"tableOfContents":[{"title":"Explore our guides and start building a Zapier integration today","slug":"explore-our-guides-and-start-building-a-zapier-integration-today","depth":3,"children":[]},{"title":"What You’ll Find Here","slug":"what-you-ll-find-here","depth":3,"children":[]},{"title":"Why Build on Zapier?","slug":"why-build-on-zapier","depth":3,"children":[]},{"title":"Quick Links","slug":"quick-links","depth":3,"children":[]}],"codeExamples":{}},"description":null,"pageData":{"navWithMetadata":[{"group":"","pages":[{"title":"Welcome","description":null,"path":"/","href":"/platform/home"},{"title":"Developer Platform Login","description":null,"url":"https://zapier.com/platform/login","href":"/platform/dev-platform-login"}]},{"group":"Quick start","pages":[{"title":"Build your integration on Zapier","description":"This guide will walk you through what steps you need to take to build an integration from start to finish. There are no fees to build an integration with Zapier.","sidebarTitle":"Introduction","href":"/platform/quickstart/build-integration"},{"group":"Developer tools","pages":[{"title":"Platform UI vs Platform CLI","description":"There are two different developer tools to build either private or public integrations with on the Zapier Developer Platform: Platform UI or Platform CLI.","href":"/platform/quickstart/ui-vs-cli"},{"title":"Platform UI tutorial","description":"This tutorial walks you through the process of building an integration on Zapier with authentication, a trigger and an action using the Platform UI.","href":"/platform/quickstart/ui-tutorial"},{"title":"Platform CLI tutorial","description":"This tutorial walks you through the process of building, testing, and pushing an example app to Zapier using Platform CLI. We'll use a mock API for recipes in this tutorial, but for production Zapier apps, you'd want to connect to a real API.","href":"/platform/quickstart/cli-tutorial"},{"title":"Get help with the Zapier Platform","description":"Get help building your app integration through the following channels:","href":"/platform/quickstart/get-help"}]},{"group":"Glossary","pages":[{"title":"Zapier Glossary","description":null,"mode":"wide","href":"/platform/quickstart/glossary"}]},{"group":"How it works","pages":[{"title":"How Zapier works","description":"[Zapier is a tool](https://zapier.com/how-it-works) that helps you automate repetitive tasks between two or more apps, no code necessary. Our customers use Zapier to move information from one app to another automatically rather than manually. Each Zap you create starts with a trigger (something that happens in one app) and then one or more actions (something else that happens in another app).","href":"/platform/quickstart/how-zapier-works"},{"title":"Zapier integration structure","description":"[Zapier's Developer Platform](https://developer.zapier.com/) includes everything needed to build and manage a new Zapier integration. When you access your integration project by name, you'll see the left sidebar outlines the core project structure.","href":"/platform/quickstart/zapier-integration-structure"},{"title":"Private vs public integrations","description":"When building an integration on the Zapier Platform, you must specify the intended audience.","href":"/platform/quickstart/private-vs-public-integrations"}]},{"title":"Recommended triggers and actions","description":"Whether you’re just starting to scope out a new Zapier integration build or have successfully launched your app in the Zapier App Directory, it’s helpful to know what features users find the most valuable and are the most widely used across Zapier’s various [app categories](https://zapier.com/apps). Ensuring your integration covers the foundational triggers, actions, and searches applicable to your app will provide more utility to your users.","href":"/platform/quickstart/recommended-triggers-and-actions"},{"title":"Zapier trusted app developers","description":"If you don't have the time/resources to dedicate towards building and launching your own integration, there are Zapier trusted developers who may be able to assist you. These are individuals/groups who have demonstrated their capabilities by satisfying our requirements for building apps on our Developer Platform, and we recommend as a substitute for building your integration in-house.","href":"/platform/quickstart/trusted-developers"}]},{"group":"Build with UI","pages":[{"title":"Platform UI tutorial","description":"This tutorial walks you through the process of building an integration on Zapier with authentication, a trigger and an action using the Platform UI.","href":"/platform/quickstart/ui-tutorial"},{"group":"Actions","pages":[{"title":"Action","description":"Every Zap starts with a single trigger that watches for new or updated data, starting the user's workflow. Action steps then make use of that data.","href":"/platform/build/action"},{"title":"Add a create action","description":null,"href":"/platform/build/create"},{"title":"Add a search action","description":null,"href":"/platform/build/search"},{"title":"Reorder or remove action","description":"Whenever a user selects your app's integration in a Zapier action step, they'll see every _create_ and _search_ action in your integration. ","href":"/platform/build/reorder-action"},{"title":"Add a search or create action","description":"When adding a _search_ action type, you'll see the option to _Pair an existing search and a create to enable “Find or Create” functionality_ in the _Settings_ page. This embeds the _create_ inside the _search_ step to find or create items in one step of the Zap.","href":"/platform/build/search-or-create"}]},{"group":"Advanced features","pages":[{"title":"Use environment variables in your API call","description":"Integrations can define environment variables that are available when the app's code executes. They are useful when you have data like an OAuth client ID and secret that you don't want to commit to source control. Environment variables can also be used as a way to toggle between a staging and production environment during app development and this would be recommended instead of the use of an independent integration for staging purposes.","href":"/platform/build/env"},{"title":"Add error response handling","description":"If your API returns responses with a status code above 400 that should not automatically throw an error then Zapier recommends enabling skipThrowForStatus.","href":"/platform/build/errors"},{"title":"Reference user-entered details with data bundles","description":"Zapier stores data from users' authentication and input forms for API calls in the `bundle` object. You can reference that data in your integration using `{{bundle.bundleName.field}}` text in API requests and connection labels, replacing `bundleName` with the bundle name and `field` with the input field key or API response field key you need.","href":"/platform/build/bundle"},{"title":"Use Code Mode to refine your API call","description":null,"href":"/platform/build/code-mode"},{"title":"Use hydration in Platform CLI","description":"The best answer to this lives in our [CLI docs](https://docs.zapier.com/platform/reference/cli-docs#dehydration):","href":"/platform/build/hydration-cli"},{"title":"Enable static IP address connection for customers","description":"To enable customers to access your integration by static IP address, all outbound traffic from Zapier to your integration will need to be routed through a smaller set of consistent IP addresses. Any app owner/developer can request to enable the static IP address feature on a private or public app.","href":"/platform/build/static-ip"}]},{"group":"Authentication","pages":[{"title":"Authentication","description":"Connecting an app to Zapier starts with authentication. Users select an app they wish to use in their Zap, authenticating their account with that app to allow Zapier to access their data.","sidebarTitle":"Overview","href":"/platform/build/auth"},{"title":"Add authentication with API Key","description":"API Key authentication passes along a user-entered API Key with every API call. In your Zapier integration using API Key authentication, the API key—and optionally any other data your API needs—is included every time a Zap step runs.","href":"/platform/build/apikeyauth"},{"title":"Add authentication with Basic Authentication","description":"APIs using Basic Authentication will authenticate users with a username and password. In your Zapier integration using Basic Auth, Zapier includes the username and password credentials in the API request bundle every time Zapier polls an API endpoint for new data or posts new data to an API endpoint.","href":"/platform/build/basicauth"},{"title":"Add authentication with Digest Authentication","description":"Digest Auth prompts users to enter their username and password, optionally along with any additional data your API requires for authentication. Zapier makes an unauthenticated API call to get the nonce from your server, and uses it to encrypt and pass the authentication data to your server with each API call.","href":"/platform/build/digestauth"},{"title":"Add authentication with OAuth v2","description":"OAuth v2 authentication matches in appearance the login process users expect from most modern apps.","href":"/platform/build/oauth"},{"title":"Add authentication with Session Authentication","description":"Session authentication has elements of Basic authentication — where Zapier requests a username and password, and OAuth v2 — where Zapier redirects users to the app's site to allow access. User credentials are exchanged for a token used to authenticate subsequent API calls.","href":"/platform/build/sessionauth"},{"title":"Add a connection label","description":"Zapier users can authenticate multiple accounts for any app. By default, every new app account added to Zapier is identified by the app's name, followed by a number (#2, #3, …) for accounts connected after the first.","href":"/platform/build/connection-label"},{"title":"Use computed fields in OAuth or Session Authentication","description":"When adding a field in your integration's authentication configuration, Zapier offers two field type options; field and computed field. The field option allows users to enter account information needed for authentication.","href":"/platform/build/computed-fields"},{"title":"Compute a field from the data of the Test API call","description":"Zapier doesn't store the responses from the test API call for OAuth v2 and session authentication. Using computed fields, you can use data from a test API call later in your Zapier integration.","href":"/platform/build/computed-test-field"},{"title":"Add authentication fields to Request Template","description":"The Request Template is a request editor that lets users set static values that apply to all requests made by this integration. Users can configure the URL params, HTTP headers and request body. This is the perfect place to set authentication fields.","href":"/platform/build/requesttemplate"},{"title":"Validate domain and subdomain input fields during authentication","description":"When adding a subdomain input field, commonly used in OAuth implementations, additional validation is strongly recommended to prevent a potential security vulnerability. If not taken into account, an attacker could utilize a maliciously constructed subdomain field (like `attacker-domain.com/`) in order to redirect OAuth connection requests to that attacker-controlled domain (because `attacker-domain.com/.your-domain.com` resolves to the attacker's domain instead of the expected one). Taking the following steps prevents the potential for an attacker to access your integration's sensitive authentication information, such as the OAuth client ID or secret.","href":"/platform/build/subdomain-validation"}]},{"group":"Input Fields","pages":[{"title":"Field types","description":null,"href":"/platform/build/field-definitions"},{"title":"Add input fields to triggers and actions","description":"When building in the Platform UI, you'll use the Input Designer to create the form users will input data into, to send to your app's API.","href":"/platform/build/add-fields"},{"title":"Send or receive dynamic user-defined fields through your API","description":"Dynamic fields are a type of field built from an API call. Custom code runs to show fields based on other input field data. These are especially useful with project management apps, CRM apps, databases, and any other app where users can add custom, user-defined fields.","href":"/platform/build/dynamic-field"},{"title":"Add line item group field to actions","description":"Input fields in Zapier add one item each time the Zap runs. But, if you want users to be able to add multiple items in a single Zap run, then this can be achieved by using a line item group. This group takes line items, which are comma-separated values, and adds each instance of the values to the app in a single Zap run.","href":"/platform/build/line-items"}]},{"group":"Output Fields","pages":[{"title":"Output data, defining sample data and output fields","description":"This guide will explain what output data, sample data and output fields are and how to modify them in your triggers or actions.","href":"/platform/build/sample-data"},{"title":"Response types Zapier expects","description":"With every API call, Zapier expects the response data to be returned in a specific response type. This can vary depending on what part of your integration you're working on. Use the table below to identify the correct response type to use","href":"/platform/build/response-types"}]},{"group":"Testing","pages":[{"title":"Test authentication","description":"Testing a user's authentication is crucially important, as it is later used to test subsequent trigger and action steps when built.","href":"/platform/build/test-auth"},{"title":"Test triggers or actions","description":"Once authentication is tested, trigger and action steps are easy to test inside Zapier visual builder. Set up the trigger or action settings and API calls, then as the last step the familiar _Test Your API Response_ box appears. It will show any accounts you added to your integration previously during the authentication testing.","href":"/platform/build/test-triggers-actions"},{"title":"Testing Tools","description":"The Zapier platform provides a set of tools to help inform and validate your integration before pushing changes out to users.","href":"/platform/build/test-tools"},{"title":"Test and monitor your integration in your Zapier account","description":"Testing inside the Platform UI is crucial during the building process. To ensure users can benefit from your integration's features, it is equally crucial to test your integration within the Zap editor. This is the best way to notice details that might have been overlooked while building your integration.","href":"/platform/build/test-monitoring"}]},{"group":"Triggers","pages":[{"title":"Trigger","description":null,"href":"/platform/build/trigger"},{"title":"Add a polling trigger","description":"Set up your polling trigger in the Platform UI with the Settings, Input Designer and API Configuration tabs.","href":"/platform/build/polling-trigger"},{"title":"Add a REST Hook trigger","description":"Set up your REST Hook trigger in the Platform UI with the Settings, Input Designer and API Configuration tabs.","href":"/platform/build/hook-trigger"},{"title":"Reorder or remove triggers","description":"Triggers are listed in alphabetical order in the Zap editor and this order cannot be changed.","href":"/platform/build/reorder-trigger"},{"title":"How deduplication works in Zapier","description":"Zapier automatically deduplicates incoming trigger data for your integration, so that Zaps do not run multiple times on the same data. Consider the following requirements for your “New Item” and “Updated Item” triggers to work as users expect.","href":"/platform/build/deduplication"},{"title":"Use pagination in triggers","description":"By default, Zapier triggers fetch new or recently updated data to start Zaps, and only need to find the most recently added items. Triggers can also be used to populate [dynamic dropdown fields](/platform/build/add-fields#dynamic-dropdown), and there they need to find all possible items to populate the field.","href":"/platform/build/pagination-trigger"},{"title":"Add an instant trigger using REST Hooks in Zapier Platform CLI","description":"REST Hooks are an alternative to polling. The main differences are allowing your customers' Zaps to trigger instantly; and avoiding polling triggers' numerous - and sometimes unnecessary - requests to your API's endpoints to check for new data.","href":"/platform/build/cli-hook-trigger"}]},{"group":"Troubleshooting","pages":[{"title":"Zapier operating constraints","description":"Zapier offers a relatively unique run-time environment for your integration and its requests to your API. The environment is stateless and restricts both execution time and payload size to offer normalized reliability and running time. There are three distinct contexts of this run-time that your integration will need to consider.","href":"/platform/build/operating-constraints"},{"title":"Troubleshoot trigger timeouts","description":null,"href":"/platform/build/troubleshoot-trigger-timeouts"},{"title":"Troubleshoot trigger request or response payload sizes","description":null,"href":"/platform/build/troubleshoot-trigger-payload"},{"title":"Troubleshoot action timeouts","description":null,"href":"/platform/build/troubleshoot-action-timeouts"},{"title":"Troubleshoot action request or response payload size","description":null,"href":"/platform/build/troubleshoot-action-payload"},{"title":"Troubleshoot custom fields","description":null,"href":"/platform/build/troubleshoot-custom-fields"},{"title":"Reduce requests to your API","description":null,"href":"/platform/build/reduce-api-requests"},{"title":"Troubleshoot throttles","description":null,"href":"/platform/build/troubleshoot-throttles"},{"title":"Hydration/dehydration limits","description":"[File dehydration](https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md#dehydration) is an extremely useful tool to remain within time and size constraints for Zapier triggers and actions. However, it does have its own limits.","href":"/platform/build/hydration-limits"},{"title":"Error: An array is expected","description":"When you add a polling trigger or search action to your integration, the Zapier platform [expects a bare array of new or found items returned](/platform/build/response-types), sorted in reverse chronological order. An API may instead return a result _object_ that contains the array of items the trigger/search needs.","href":"/platform/build/error-array-expected"},{"title":"Error: Got a non-object result, expected an object from create","description":null,"href":"/platform/build/error-non-object"},{"title":"Error: Got a non-object result in the array, expected only objects","description":"When using a REST Hook trigger, the data returned by the perform must be an array.","href":"/platform/build/error-non-object-array"}]},{"title":"Use form mode to setup your API calls","description":"In the Platform UI, when building your authentication, triggers and actions, the default setting under _API Configuration_ is to create each component of your integration using Form Mode.","href":"/platform/build/form-mode"}]},{"group":"Build with CLI","pages":[{"title":"Build with CLI","description":"Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.","sidebarTitle":"Overview","href":"/platform/build-cli/overview"},{"group":"Features","pages":[{"group":"Input Fields","pages":[{"title":"Input Field Configuration","description":null,"sidebarTitle":"Configuration","href":"/platform/build-cli/input-fields"},{"title":"Field types","description":null,"href":"/platform/build/field-definitions"},{"title":"Dynamic Dropdowns","description":null,"href":"/platform/build-cli/dynamic-dropdowns"}]}]},{"title":"Platform CLI tutorial","description":"This tutorial walks you through the process of building, testing, and pushing an example app to Zapier using Platform CLI. We'll use a mock API for recipes in this tutorial, but for production Zapier apps, you'd want to connect to a real API.","href":"/platform/quickstart/cli-tutorial"},{"title":"Frequently Asked Questions","description":null,"sidebarTitle":"FAQs","href":"/platform/build-cli/faqs"},{"title":"Core Reference","description":"Reference for `zapier-platform-core`","href":"/platform/build-cli/core"},{"title":"CLI Reference","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md","href":"/platform/reference/cli"},{"title":"Schema Reference","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md","href":"/platform/reference/schema"}]},{"group":"Manage","pages":[{"group":"Account and team","pages":[{"title":"Invite team members to your integration","description":"Integrations do not have a dedicated owner, instead they are managed by a team that can be modified as needed. Add team members to your integration to collaborate, contribute, and view analytics data for your integration on the Developer Platform. Your integration team can have up to 200 team members, regardless of whether your integration is Private or Public.","sidebarTitle":"Add team members to integration","href":"/platform/manage/add-team"}]},{"group":"Integration changes","pages":[{"title":"Planning and implementing integration changes","description":"Before making updates to your integration, it's important to consider the potential impact on user migration and existing Zaps. Ensuring your API and Zapier integration remains backwards compatible is crucial to avoid disruption to users. However, we acknowledge certain changes are sometimes necessary and unavoidable. In such cases, consider the best practice for implementation.","href":"/platform/manage/planning-changes"},{"title":"Change authentication type","description":"If your API's authentication method changes, you would need to change the method Zapier uses to authenticate user accounts.","href":"/platform/manage/auth-scheme"},{"title":"Add required authentication field","description":null,"href":"/platform/manage/auth-required"},{"title":"Change authentication field keys","description":null,"href":"/platform/manage/auth-keys"},{"title":"Change trigger or action key","description":null,"href":"/platform/manage/change-keys"},{"title":"Add new required input field","description":null,"href":"/platform/manage/required-input"},{"title":"Change input form field key","description":null,"href":"/platform/manage/input-key"},{"title":"Change output field key","description":null,"href":"/platform/manage/output-key"},{"title":"Change output data response","description":null,"href":"/platform/manage/output"},{"title":"Change trigger from polling to REST Hook","description":null,"href":"/platform/manage/change-trigger"},{"title":"Update perform method for polling trigger","description":null,"href":"/platform/manage/change-perform"},{"title":"Changes to your API can impact your integration","description":null,"href":"/platform/manage/change-api"},{"title":"Export integration to Platform CLI","description":"The Zapier Platform CLI (Command Line Interface) is a toolset you install and run in your local development environment. It allows you to build, test, and manage your Zapier integration through JavaScript code and terminal commands.","href":"/platform/manage/export-cli"},{"title":"Export integration to Platform UI","description":"The Zapier Platform UI is the easiest way for anyone with API experience to build Zapier integrations. It is for users more comfortable with a visual form editor.","href":"/platform/manage/export-ui"},{"title":"Essential tips for integrating quality health practices","description":"Our shared customers rely on Zapier and your integration for business-critical workflows. Addressing feedback early and often ensures users have the best experience, both with Zapier's platform and yours. Follow these tips on how. ","href":"/platform/manage/essential-tips-iq"}]},{"group":"Integration performance","pages":[{"title":null,"description":"Zapier recognizes that temporary unavailability is sometimes inevitable for your API.","Title":"Prepare for API outages","href":"/platform/manage/api-outage"},{"title":"Embed insights definitions","description":"Embed features are available for public integrations.","href":"/platform/manage/embed-insights"},{"title":"Respond to user feedback and bugs","description":"For public integrations, Zapier's Support team logs user requests and reported problems in Zapier's issue tracker, that your team can see from the _Bug \u0026 Feature Requests_ page in the Manage section.","href":"/platform/manage/user-feedback"},{"title":"Improve error response handling","description":"Errors from your API cause pain for users at two vital points:","href":"/platform/manage/error-handling"},{"title":"Active users retention","description":"At Zapier, churn means a user used your integration in their Zaps 29 - 56 days ago, but hasn't run a successful task in one of those Zaps in the past 28 days. This user is considered to have churned from the integration. Maybe they switched to using a competing integration or their workflow had a more periodic or seasonal cadence.","href":"/platform/manage/active-users"},{"title":"Integration insights definitions","description":"Integration quality on Zapier boils down to two main pillars: **Health** and **Depth**.","href":"/platform/manage/integration-insights"},{"title":"Zap activation rates","description":"Consider all of the Zaps that users try to create with your integration's triggers, actions, or searches. The Zap activation rate is the percentage of those Zaps that actually activated within 24 hours of creation, meaning the Zap ran at least one successful task.","href":"/platform/manage/zap-activation"},{"title":"Embed activation rates","description":"Consider all the user clicks on Zap Templates surfaced in your embeds. The embed activation rate is the percentage of those Zaps that actually activated within 24 hours of creation, meaning the Zap ran at least one successful task. It measures the efefctiveness of the Zapier embeds in your product at converting user clicks on Zap Templates to Zap activations.","href":"/platform/manage/embed-activation"}]},{"group":"Sharing","pages":[{"title":"Share your integration","description":"Once an integration is public, all users would have access to it when searching for an app's name in the Zap Editor, or in the [Zapier App Directory](https://zapier.com/apps).","href":"/platform/manage/sharing"}]},{"group":"Versions","pages":[{"title":"Versions","description":"Versions in Developer Platform allow developers to create multiple iterations of their integration to experiment with and implement new features without affecting existing users. Each integration can have many versions, but only one version can have a public status at a one time.","href":"/platform/manage/versions"},{"title":"Clone a version","description":"Cloning allows you to duplicate an existing version of your integration. This is particularly useful when you want to introduce new features or fixes without altering the original integration. When a previous version of your integration has more than 5 active users, you will need to clone that version to make modifications.","href":"/platform/manage/clone"},{"title":"Promote a version","description":"After your integration has entered the beta or public status, you can set a new default version for public use. This process is called promoting a version.","href":"/platform/manage/promote"},{"title":"Migrate users to a new version","description":"If this isn't the first time you've promoted your app - you might have users on older versions.","href":"/platform/manage/migrate"},{"title":"Deprecate or delete a version","description":"Deprecation is an optional process that allows you to set a date from which a non-public version of your integration will no longer be updated. Deprecation is only recommended if the older integration version will eventually stop working, such as if the related API will be removed. Zapier is normally a “set it and forget it” experience for users, so use this feature carefully. Only if the older version will no longer function, should it be deprecated. Please note that deprecating a version is significantly more disruptive to our mutual users than migrating to the latest promoted version, or than leaving users on an older (now) private version if migration is not possible.","href":"/platform/manage/deprecate"},{"title":"Manage a legacy integration","description":null,"href":"/platform/manage/versions-legacy"}]},{"title":"Add integration branding in Platform CLI","description":"When you make a new integration in Zapier CLI, you can add the app's name, description, and homepage to the `package.json` file.","href":"/platform/manage/branding-cli"}]},{"group":"Publish","pages":[{"group":"Branding","pages":[{"title":"Integration branding guidelines","description":"When creating your integration, you'll add your app’s name, logo, description, category, and primary brand color. Consistent branding is essential for helping users recognize and discover your app on Zapier.","href":"/platform/publish/branding-guidelines"},{"title":"Add or modify integration branding and details","description":"When creating a new integration in the Platform UI from the link `https://developer.zapier.com/app/new`, you'll be prompted to add the app name, description, homepage URL and logo.","href":"/platform/publish/add-or-modify-branding"}]},{"group":"Launch process","pages":[{"title":"Build your first public integration on Zapier","description":"This guide gives an overview of the process to publishing a public integration.","href":"/platform/publish/public-integration"},{"title":"Integration build guidelines","description":"Before publishing your integration on Zapier, it is essential to ensure that your integration is well-prepared to provide a seamless and efficient user experience. The following guidelines are designed to assist you in refining your integration before submitting it for review. Adhering to these guidelines will help enhance the functionality and user interaction with your integration and will provide you with the best value and opportunities to harness Zapier as a method of obtaining new users and most commonly, boosting the lifetime value of your current customers.","href":"/platform/publish/integration-build-guidelines"},{"title":"Integration publishing requirements","description":"We're excited you are creating an integration for the [Zapier Platform](https://zapier.com/developer-platform). We're here to help you understand our platform and its requirements so that you can successfully prepare your Zapier integration for publishing. Thousands of partners have built integrations on the Zapier Platform that enable our mutual users to set up Zaps as easily and quickly as possible.","href":"/platform/publish/integration-publishing-requirements"},{"title":"Zap templates","description":"Zapier empowers apps to do together what they can't on their own. With a bit of inspiration and creativity, your users can pull dozens of apps together into unique workflows to get more done with your app in far less time.","href":"/platform/publish/zap-templates"},{"title":"Create help documentation for your users","description":"The Zapier team provide frontline support for your integration, and in order to provide the best experience for your users, help documentation about using your integration in Zaps is hosted in the [Zapier Help Center](https://help.zapier.com/hc/en-us).","href":"/platform/publish/user-help"},{"title":"Best practices for showcasing your integration","description":"Sharing well-crafted content about your Zapier integration can help you improve user adoption, highlight key use cases, and simplify integration processes. Need some inspiration? The following examples show how some of our partners are effectively communicating their Zapier integrations across different platforms.","href":"/platform/publish/best-practices"},{"title":"Zapier Partner Sandbox","description":"Zapier Partner Sandbox is a workspace for people in your organization who are on your integration team.","href":"/platform/publish/zps"}]},{"group":"Partner program","pages":[{"title":"Partner Program","description":"The [Zapier Partner Program](https://zapier.com/developer-platform/partner-program) is a program for Zapier's [6,000+ integration partners](https://zapier.com/apps). It is designed to give all partners a clear path to success for their integrations and reward them with benefits along the way.","href":"/platform/publish/partner-program"},{"title":"Integration success strategies","description":"With 7,000+ public integration partners on Zapier, use these 10 tried-and-true tactics from our top partners to skyrocket your growth and earn you more [benefits from the Partner Program](https://zapier.com/developer-platform/partner-program).","href":"/platform/publish/partner-faq"},{"title":"A Guide to Zapier Partner Program Benefits: Accelerate your integration's growth and reach","description":"Zapier offers a variety of marketing and support benefits to partners. This cheat sheet is designed to help you understand when and how you can access each of these benefits as you unlock them.","href":"/platform/publish/benefits-guide"}]},{"group":"Validation","pages":[{"title":"Integration check reference","description":"Before you can submit your integration for publishing, it runs through a set of automated checks to ensure it's working properly and giving our users (and yours) the best possible experience.","href":"/platform/publish/integration-checks-reference"}]}]},{"group":"Embed","pages":[{"title":"Partner Solutions Documentation","description":"Our partner solutions are the easiest ways to embed Zapier and surface integrations within your product.","href":"/platform/embed/partner-solutions"}]},{"group":"Reference","pages":[{"group":"Use cases","pages":[{"title":"Zapier integration structure for a forms app","description":"Form and survey app integrations built on Zapier allow users to connect mobile data collection forms to send the responses into other apps as new contacts, document templates, messages, and more.","href":"/platform/reference/forms-app"},{"title":"Zapier integration structure for a CRM app","description":"CRM (customer relationship management) apps are detailed databases that link contacts with companies, companies with deals, and more.","href":"/platform/reference/crm-app"},{"title":"Zapier integration structure for a project management app","description":"While you can't automate project work, you can automatically add tasks, create new projects, and keep track of progress via an app integration on Zapier.","href":"/platform/reference/project-app"},{"title":"Zapier integration structure for an AI app","description":"AI app integrations built on Zapier allow users to automate tasks using AI capabilities. Here are some common pain points and recommendations when building AI apps on Zapier.","href":"/platform/reference/ai-app"}]},{"title":"Transfer","description":"[Transfer](https://help.zapier.com/hc/en-us/articles/8496274335885) is a Zapier functionality that enables users to perform bulk operations using their historical data.","href":"/platform/reference/transfer"},{"title":"AI Actions","description":"Zapier's [AI Actions](https://actions.zapier.com/) is an AI alpha product designed to work with natural language-based products. It leverages the Zapier platform, with over [6000 apps](https://zapier.com/apps). You can include the capabilities of Zapier's platform in your own product.","href":"/platform/reference/ai-actions"},{"title":"Custom Actions and API Requests Actions","description":"[Custom Actions](https://help.zapier.com/hc/en-us/articles/16276574838925-App-Extensions-in-Zapier) and [API Requests](https://help.zapier.com/hc/en-us/articles/12899607716493-Set-up-an-API-request-action#prerequisites-0-0) are features that have been developed internally at Zapier, designed to help our mutual customers achieve the most value out of your app integration.","href":"/platform/reference/custom-actions-api-requests"},{"title":"Scripting in converted Legacy Web Builder Integrations","description":"This guide provides instructions on editing and maintaining existing scripting methods for legacy web builder integrations that have been converted to either the Platform UI or Platform CLI.","href":"/platform/reference/legacy-scripting"},{"title":"Changelog","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md","href":"/platform/reference/changelog"},{"title":"CLI Reference","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md","href":"/platform/reference/cli"},{"title":"Schema Reference","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md","href":"/platform/reference/schema"}]},{"group":"Welcome","pages":[{"title":"Zapier Partner Solutions","description":"Add automation to your product with Zapier.","href":"/partner-solutions/getting-started"}]},{"group":"Workflow API","pages":[{"title":"Integrate the Workflow API","description":"Our most powerful tool for building native workflows in your product","href":"/partner-solutions/workflow-api/intro"},{"group":"Building a Workflow","pages":[{"title":"How to Build a Workflow","description":"This guide walks through the entire process of building an automated workflow for your users to use -- from picking apps, adding authentication, filling inputs and publishing.","href":"/partner-solutions/workflow-api/Building-a-Zap"},{"title":"Fields and Fieldsets","description":null,"href":"/partner-solutions/workflow-api/Fields-and-Fieldsets"},{"title":"Selecting an Action","description":"An Action is an operation that can be performed against a third-party API; either a `READ` or a `WRITE`.","href":"/partner-solutions/workflow-api/Selecting-an-Action"},{"title":"Selecting an Authentication","description":"Support users in selecting 3rd party authentications, either through an existing authentication or by adding new.","href":"/partner-solutions/workflow-api/Selecting-an-Authentication"},{"group":"Custom Flows","pages":[{"title":"Testing a Step","description":"Step testing allows for the validation of a configured step, executing any `READ` or `WRITE` actions.","href":"/partner-solutions/workflow-api/testing-a-step"},{"title":"Hardcoding an Action","description":"To help focus the user experience, it can be helpful to hardcode a certain Action to guide users in selecting the most appropriate action for their use-case.","href":"/partner-solutions/workflow-api/Hardcoding-an-Action"},{"title":"Adding an Authentication to your app","description":"Reduce friction when adding an authentication to your own app.","href":"/partner-solutions/workflow-api/adding-an-authentication"}]},{"title":"Known Limitations","description":"Creating workflows using the Zapier Workflow API is a recent addition, and there are some known limitations.","href":"/partner-solutions/workflow-api/limitations"}]},{"title":"Retrieving Apps on Zapier","description":"Listing apps available on Zapier is a simple way to show users all of what's possible on Zapier","href":"/partner-solutions/workflow-api/list-apps"},{"title":"Retrieving a list of users Zaps","description":"Listing a users zaps reveals existing workflows created by users.","href":"/partner-solutions/workflow-api/list-zaps"},{"title":"Retrieving Zap Templates","description":"Zap templates are pre-made Zaps that help users discover popular use cases for automating their work. Each template features a specific use case and the apps needed for it to work.","href":"/partner-solutions/workflow-api/list-zap-templates"},{"title":"Embedding the Zapier Editor","description":"With an embedded Zap editor in your product, your users can create and edit their Zaps without leaving your app.","href":"/partner-solutions/workflow-api/embed-zap-editor"}]},{"group":"Workflow Element","pages":[{"title":"Embed the Workflow Element","description":"The Workflow Element is a prebuilt UI component that offers the quickest—and easiest—way to surface your Zapier integration directly within your own product.","href":"/partner-solutions/workflow-element/intro"},{"title":"Element Security","description":"Keeping our elements secure and usable is critical at Zapier","href":"/partner-solutions/elements-security"},{"title":"Embed Insights","description":"Insights are available to review the performance of your embed, and track usage growth.","href":"/partner-solutions/embed-insights"}]},{"group":"Embed Enhancements","pages":[{"title":"Pre-filled Zaps","description":"Prefills allow you to define the input fields on behalf of the user, simplying the experience of setting up their Zap.","href":"/partner-solutions/pre-filled-zaps"},{"title":"Quick Account Creation","description":"Quick Account Creation is a seamless, accelerated sign-up feature allowing first time Zapier users to skip the standard sign-up procedure and onboarding survey. Enabling Quick Account Creation as part of your embed tool code helps provide a more frictionless experience for end users.","href":"/partner-solutions/quick-account-creation"}]},{"group":"Getting Started With the API","pages":[{"title":"Zapier Authentication","description":"Authenticate with The Zapier Workflow API","href":"/partner-solutions/api-reference/authentication"},{"title":"Rate Limiting","description":"Rate limits when accessing the Workflow API ","href":"/partner-solutions/api-reference/rate-limiting"}]},{"group":"Apps","pages":[{"title":"Get Apps [v1]","description":"This endpoint returns a list of apps sorted popularity. See the List Apps guide to get started.","openapi":"get /v1/apps","href":"/partner-solutions/api-reference/apps/get-apps-[v1]"},{"title":"Get Apps [v2]","description":"This endpoint returns a list of apps sorted by popularity.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","openapi":"get /v2/apps","href":"/partner-solutions/api-reference/apps/get-apps-[v2]"}]},{"group":"Categories","pages":[{"title":"Get Categories","description":"List of Zap categories","openapi":"get /v1/categories","href":"/partner-solutions/api-reference/categories/get-categories"}]},{"group":"Accounts","pages":[{"title":"User Profile","description":"This endpoint returns the authenticated user information\n\n#### OAuth\n\nThis endpoint requires the `profile` OAuth scope.","openapi":"get /v1/profiles/me","href":"/partner-solutions/api-reference/accounts/user-profile"},{"title":"Create Account","description":"Create a new user and obtain an access token. See our Quick Account Creation guide to get started.","openapi":"get /v2/authorize","href":"/partner-solutions/api-reference/accounts/create-account"}]},{"group":"Zap Templates","pages":[{"title":"Get Zap Templates","description":"List popular Zap Templates using your app. See our List Zap Templates guide to get started.","openapi":"get /v1/zap-templates","href":"/partner-solutions/api-reference/zap-templates/get-zap-templates"}]},{"group":"Zaps","pages":[{"title":"Get Zaps [v1]","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","openapi":"get /v1/zaps","href":"/partner-solutions/api-reference/zaps/get-zaps-[v1]"},{"title":"Guess a Zap [Beta]","description":"This endpoint returns a suggested Zap and pre-filled URL to Zapier from a given prompt.","openapi":"post /v2/guess","href":"/partner-solutions/api-reference/zaps/guess-a-zap"},{"title":"Get Zaps [v2]","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\nThe `expand` array can be used to expand selected fields into full objects in the response. Inputs with keys can\nalso be passed to filter Zaps by certain criteria.\n\n#### OAuth\n\nThis endpoint requires the `zap`, `zap:all`, or `zap:account:all` OAuth scope.","openapi":"get /v2/zaps","href":"/partner-solutions/api-reference/zaps/get-zaps-[v2]"},{"title":"Create a Zap","description":"This URL creates a Zap based on the given steps and title.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/zaps","href":"/partner-solutions/api-reference/zaps/create-a-zap"}]},{"group":"Actions","pages":[{"title":"Get Actions","description":"Fetch the available actions for the provided App. It's typical to filter by type so that only actions that make sense for a particular step are shown. Action IDs may not be reused, see our documentation for how to hardcode a particular action.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","openapi":"get /v2/actions","href":"/partner-solutions/api-reference/actions/get-actions"},{"title":"Get Input Fields","description":"Get the Input Fields for a particular Action, using the provided authentication and inputs. See the fields and fieldsets guide for more information.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/actions/{action_id}/inputs","href":"/partner-solutions/api-reference/actions/get-input-fields"},{"title":"Get Choices","description":"Get the possible values for a `SELECT` Input Field.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","openapi":"post /v2/actions/{action_id}/inputs/{input_id}/choices","href":"/partner-solutions/api-reference/actions/get-choices"},{"title":"Get Output Fields","description":"Get the Output Fields for a particular Action, using the provided authentication and inputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/actions/{action_id}/outputs","href":"/partner-solutions/api-reference/actions/get-output-fields"},{"title":"Step Test","description":"Tests the action (step) in the third party api, using the provided authentication and inputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/actions/{action_id}/test","href":"/partner-solutions/api-reference/actions/step-test"}]},{"group":"Authentications","pages":[{"title":"Get Authentications","description":"Fetch the available Authentications for the provided App. This will only return Authentications that are owned by the user and not those that are shared with them, since it's not possible to create Zaps with Authentications you don't own.\n\n#### OAuth\n\nThis endpoint requires the `authentication` OAuth scope.","openapi":"get /v2/authentications","href":"/partner-solutions/api-reference/authentications/get-authentications"},{"title":"Create Authentication","description":"Creates a new Authentication for the provided App. See our Adding an Authentication guide to get started.\n\n#### OAuth\n\nThis endpoint requires the `authentication:write` OAuth scope.","openapi":"post /v2/authentications","href":"/partner-solutions/api-reference/authentications/create-authentication"}]},{"group":"Experimental","pages":[{"title":"Create a Workflow step","description":"Creates a new Workflow Step based on a single provided step and returns a webhook URL that can be used to invoke the Workflow Step and retrieve a response. When creating a Workflow write action step, field values can be hardcoded, or they can contain mapped values. The mapped values should be surrounded with double curly braces.\n\nIn the example request body the Workflow Step contains the field values `email`, `name`, `phone`, and `address` in double curly braces. Then the webhook URL returned can be called with a `POST` request containing a JSON body in the following format:\n\n```\n{\n\"email\": \"user@example.com\",\n\"name\": \"John Doe\",\n\"phone\": \"1234567890\",\n\"address\": \"123 Maple Lane\"\n}\n```\n\nNote that authentications may become invalid over time, and if this occurs, users will be notified by email to fix their authentication. If the authentication is not fixed, trying to run the Workflow Step will time out. Workflow Steps are also (for now) visible and editable as Zaps at https://zapier.com/app/zaps. If a user turns off a Workflow Step Zap, the request will similarly time out. Finally, it is possible that a user can edit the Workflow Step Zap such that it returns unexpected outputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/workflow-steps","href":"/partner-solutions/api-reference/experimental/create-a-workflow-step"}]},{"group":"Schemas","pages":[{"group":"Common Types","pages":[{"title":null,"description":null,"openapi-schema":"Action","href":"/partner-solutions/api-reference/common-types/action"},{"title":null,"description":null,"openapi-schema":"Apps","href":"/partner-solutions/api-reference/common-types/app"},{"title":null,"description":null,"openapi-schema":"Authentication","href":"/partner-solutions/api-reference/common-types/authentication"},{"title":null,"description":null,"openapi-schema":"Choice","href":"/partner-solutions/api-reference/common-types/choice"},{"title":null,"description":null,"openapi-schema":"Fieldset","href":"/partner-solutions/api-reference/common-types/fieldset"},{"title":null,"description":null,"openapi-schema":"InfoField","href":"/partner-solutions/api-reference/common-types/infoField"},{"title":null,"description":null,"openapi-schema":"InputField","href":"/partner-solutions/api-reference/common-types/inputField"},{"title":null,"description":null,"openapi-schema":"OutputField","href":"/partner-solutions/api-reference/common-types/outputField"},{"title":null,"description":null,"openapi-schema":"Zap","href":"/partner-solutions/api-reference/common-types/zap"},{"title":"Errors","description":"Errors in the API follow the \u003ca href=\"https://jsonapi.org/format/#error-objects\" target=\"_blank\"\u003erecommendation\u003c/a\u003e from the JSON API spec.","href":"/partner-solutions/api-reference/common-types/errors"},{"title":"Pagination","description":null,"href":"/partner-solutions/api-reference/common-types/pagination"},{"title":"Requests","description":null,"href":"/partner-solutions/api-reference/common-types/requests"},{"title":"Responses","description":"Responses for the API follow the \u003ca href=\"https://jsonapi.org/format/#fetching-resources-responses-200\" target=\"_blank\"\u003eJSON API spec\u003c/a\u003e for fetching resources.","href":"/partner-solutions/api-reference/common-types/responses"}]}]},{"group":"Getting Started","pages":[{"title":"Introduction","description":"AI Actions exposes Zapier's 7,000+ apps and 30,000+ actions, for selected partners, to build your own custom AI assistants.","href":"/ai-actions/intro"},{"title":"Quickstart","description":"Learn how to kick-start AI Actions by obtaining a partner key, setting up allowed actions, and executing an action through our API.","href":"/ai-actions/quickstart"}]},{"group":"How to","pages":[{"title":"Authentication","description":"Test that the API and auth are working.","openapi":"get /api/v2/auth/check/","href":"/ai-actions/how-tos/auth"},{"title":"Zapier account list","description":"Get a list of Zapier accounts for the current user.","openapi":"get /api/v2/auth/accounts/","href":"/ai-actions/how-tos/account-list"},{"title":"Stored Vs. Stateless Actions","description":null,"href":"/ai-actions/how-tos/stateless-vs-stored"},{"group":"Stored actions","pages":[{"title":"Stored actions introduction","description":null,"href":"/ai-actions/how-tos/stored/intro"},{"title":"Configure stored actions in the AI Actions UI","description":null,"href":"/ai-actions/how-tos/stored/action-configuration"},{"title":"List stored Actions","description":"List all the current actions for the current user.","openapi":"get /api/v2/ai-actions/","href":"/ai-actions/how-tos/stored/list-actions"},{"title":"Run a stored action","description":"Given an action ID and instructions, this will execute the action and return the results.","openapi":"post /api/v2/ai-actions/{ai_action_id}/execute/","href":"/ai-actions/how-tos/stored/run-stored-action"},{"group":"Manage stored actions","pages":[{"title":"Get stored action","description":"Get the details of a specific AI Action.","openapi":"get /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/how-tos/stored/manage/get-action"},{"title":"Create stored action","description":"Create a new AI Action that can be executed by the user later.","openapi":"post /api/v2/ai-actions/","href":"/ai-actions/how-tos/stored/manage/create-action"},{"title":"Update stored action","description":"Update an existing AI Action.","openapi":"put /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/how-tos/stored/manage/update-action"},{"title":"Delete stored action","description":"Delete an AI Action.\n\nReturns `true` if the action was deleted, `false` if it was not found.","openapi":"delete /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/how-tos/stored/manage/delete-action"}]}]},{"group":"Stateless actions","pages":[{"title":"Stateless actions introduction","description":null,"href":"/ai-actions/how-tos/stateless/intro"},{"title":"Run a Stateless Action","description":null,"openapi":"post /api/v2/execute/","href":"/ai-actions/how-tos/stateless/run-stateless-action"}]},{"group":"Gathering action information","pages":[{"title":"Introduction","description":null,"href":"/ai-actions/how-tos/action-info/introduction"},{"title":"Find an app","description":"Search through all Zapier apps.","openapi":"get /api/v2/apps/search/","href":"/ai-actions/how-tos/action-info/find-app"},{"title":"Find an action","description":"Search for Zapier actions by app, ordered by relevancy.","openapi":"get /api/v2/apps/{app}/actions/","href":"/ai-actions/how-tos/action-info/find-action"},{"title":"Choose authentication","description":"Get list of Zapier authentications associated with the requesting user and account.","openapi":"get /api/v2/apps/{app}/auths/","href":"/ai-actions/how-tos/action-info/choose-auth"},{"title":"Get action details and needs","description":"Get details of a specific action, including its needs, gives, and a sample of the action.","openapi":"post /api/v2/apps/{app}/actions/{action}/","href":"/ai-actions/how-tos/action-info/action-details"},{"title":"Get prefill choices","description":"Get prefill choices for an app's prefill.","openapi":"post /api/v2/apps/{app}/choices/{prefill}/","href":"/ai-actions/how-tos/action-info/prefill-choices"}]}]},{"group":"API Reference","pages":[{"group":"system","pages":[{"title":"App Health Check","description":"Check that the app is up and running.","openapi":"get /api/v2/health/","href":"/ai-actions/api-reference/system/app-health-check"}]},{"group":"auth","pages":[{"title":"Check User Auth","description":"Test that the API and auth are working.","openapi":"get /api/v2/auth/check/","href":"/ai-actions/api-reference/auth/check-user-auth"},{"title":"Get Account List","description":"Get a list of Zapier accounts for the current user.","openapi":"get /api/v2/auth/accounts/","href":"/ai-actions/api-reference/auth/get-account-list"},{"title":"Get User Login Link","description":"This will create a link that can be used for \"quick account creation\" for a user.\n\nWhen going to this link, if the provided email already has a Zapier account, the user will be asked to log in.\nIf the email does not have a Zapier account, the user will be asked to create an account with the provided email and name.\n\nUpon creating an account or logging in, the user will be taken to the `redirect_to` URL.\n\nA suggested flow for this is:\n- Check if you have an AI Actions OAuth token for a user\n- If you do not, send the user to a page on your site for initiating PKCE OAuth flow, storing the `code_verifier` for them securely.\n- Use this endpoint, with a `redirect_to` of `https://actions.zapier.com/oauth/authorize/` with the following query parameters:\n - client_id: Your AI Actions OAuth client ID\n - scope: `openid nla:exposed_actions:execute`\n - response_type: `code`\n - redirect_uri: The URL on your site that will handle the OAuth callback, must be in the list of allowed redirect URIs for your AI Actions OAuth client.\n - code_challenge: The SHA256 hash of the `code_verifier` from the previous step.\n - code_challenge_method: `S256`\n\nThe user will get a Zapier account, be brought to AI Actions where they will see the OAuth consent screen, and then will be brought back to your site\nwith an OAuth `code` that can be used with `https://actions.zapier.com/oauth/token/` with the following data in the body with `Content-Type: application/x-www-form-urlencoded`:\n - client_id: Your AI Actions OAuth client ID\n - grant_type: `authorization_code`\n - code_verifier: The verifier stored for your user when generating the login URL\n - redirect_uri: The same URL you used for the `redirect_uri` in the previous step.\n - code: The code in the query parameters of the URL that the user was redirected to.","openapi":"get /api/v2/auth/login-link/","href":"/ai-actions/api-reference/auth/get-user-login-link"},{"title":"Get Oauth Login Link","description":"This will create a link that can be used for \"quick account creation\" followed by OAuth login for a user.\n\nWhen going to this link, if the provided email already has a Zapier account, the user will be asked to log in.\nIf the email does not have a Zapier account, the user will be asked to create an account with the provided email and name.\n\nUpon creating an account or logging in, the user will be taken to\n\nThe user will get a Zapier account, be brought to AI Actions where they will see the OAuth consent screen, and then will be brought back to your site\nwith an OAuth `code` that can be used with `https://actions.zapier.com/oauth/token/` with the following data in the body with `Content-Type: application/x-www-form-urlencoded`:\n - client_id: Your AI Actions OAuth client ID\n - grant_type: `authorization_code`\n - code_verifier: The verifier stored for your user when generating the login URL\n - redirect_uri: The same URL you used for the `redirect_uri` in the previous step.\n - code: The code in the query parameters of the URL that the user was redirected to.","openapi":"get /api/v2/auth/oauth-login-link/","href":"/ai-actions/api-reference/auth/get-oauth-login-link"}]},{"group":"apps","pages":[{"title":"Search Apps","description":"Search through all Zapier apps.","openapi":"get /api/v2/apps/search/","href":"/ai-actions/api-reference/apps/search-apps"},{"title":"Get App Details","description":null,"openapi":"get /api/v2/apps/{app}/","href":"/ai-actions/api-reference/apps/get-app-details"},{"title":"List Authentications For App","description":"Get list of Zapier authentications associated with the requesting user and account.","openapi":"get /api/v2/apps/{app}/auths/","href":"/ai-actions/api-reference/apps/list-authentications-for-app"}]},{"group":"actions","pages":[{"title":"Search Actions","description":"Search for Zapier actions by app, ordered by relevancy.","openapi":"get /api/v2/apps/{app}/actions/","href":"/ai-actions/api-reference/actions/search-actions"},{"title":"Get Action Details","description":"Get details of a specific action, including its needs, gives, and a sample of the action.","openapi":"post /api/v2/apps/{app}/actions/{action}/","href":"/ai-actions/api-reference/actions/get-action-details"},{"title":"Get Prefill Choices","description":"Get prefill choices for an app's prefill.","openapi":"post /api/v2/apps/{app}/choices/{prefill}/","href":"/ai-actions/api-reference/actions/get-prefill-choices"}]},{"group":"execution","pages":[{"title":"Execute Stateless AI Action","description":null,"openapi":"post /api/v2/execute/","href":"/ai-actions/api-reference/execution/execute-stateless-ai-action"},{"title":"Execute Stored AI Action","description":"Given an action ID and instructions, this will execute the action and return the results.","openapi":"post /api/v2/ai-actions/{ai_action_id}/execute/","href":"/ai-actions/api-reference/execution/execute-stored-ai-action"},{"title":"Preview Stored AI Action","description":null,"openapi":"post /api/v2/ai-actions/{ai_action_id}/preview/","href":"/ai-actions/api-reference/execution/preview-stored-ai-action"},{"title":"Rate Execution Log","description":"Rate a specific execution log given feedback from the user.\n\nRating should either be `-1` (bad, thumbs down), `0` (neutral, the default), or `1` (good, thumbs up).\n\nYou can also provide plain text feedback provided by the user. Supplied rating/feedback are patched onto execution log, so you can progressively call this endpoint.","openapi":"post /api/v2/execute/log/{execution_log_id}/rate/","href":"/ai-actions/api-reference/execution/rate-execution-log"}]},{"group":"ai-actions","pages":[{"title":"List AI Actions","description":"List all the current actions for the current user.","openapi":"get /api/v2/ai-actions/","href":"/ai-actions/api-reference/ai-actions/list-ai-actions"},{"title":"Create AI Action","description":"Create a new AI Action that can be executed by the user later.","openapi":"post /api/v2/ai-actions/","href":"/ai-actions/api-reference/ai-actions/create-ai-action"},{"title":"Get AI Action","description":"Get the details of a specific AI Action.","openapi":"get /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/api-reference/ai-actions/get-ai-action"},{"title":"Update AI Action","description":"Update an existing AI Action.","openapi":"put /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/api-reference/ai-actions/update-ai-action"},{"title":"Delete AI Action","description":"Delete an AI Action.\n\nReturns `true` if the action was deleted, `false` if it was not found.","openapi":"delete /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/api-reference/ai-actions/delete-ai-action"}]},{"group":"utilities","pages":[{"title":"Guess Actions","description":null,"openapi":"post /api/v2/guess-actions/","href":"/ai-actions/api-reference/utilities/guess-actions"},{"title":"Shrink Result","description":"**WARNING: This endpoint is not officially supported, and is subject to be changed or removed at any time.**\n\nShrinks the given result payload to git into a specified token budget.\n\nThis tries its best to keep around more important values and truncate less important ones.\n\nThe intent of this endpoint is that after executing an AI Action, you can pass the result into this to get a smaller result that can be passed in to LLMs without hitting the token limit.","openapi":"post /api/v2/shrink-result/","href":"/ai-actions/api-reference/utilities/shrink-result"}]}]},{"group":"Tools","pages":[{"title":"Stateless action creator/runner","description":null,"href":"/ai-actions/tools/stateless-action"}]},{"group":"Libraries","pages":[{"group":"TypeScript (Node.js, Deno)","icon":"node-js","pages":[{"title":"Getting started","description":null,"href":"/ai-actions/libraries/nodejs/getting-started"},{"title":"Authentication","description":null,"href":"/ai-actions/libraries/nodejs/authentication"},{"title":"Usage examples","description":null,"href":"/ai-actions/libraries/nodejs/usage"},{"title":"Next.js","description":null,"href":"/ai-actions/libraries/nodejs/nextjs-reccommendation"}]},{"group":"React Components","icon":"react","pages":[{"title":"Getting started","description":null,"href":"/ai-actions/libraries/react/getting-started"},{"group":"Components","pages":[{"title":"AiActionsProvider","description":null,"href":"/ai-actions/libraries/react/ai-actions-provider"},{"title":"ActionList","description":null,"href":"/ai-actions/libraries/react/action-list"},{"title":"EditAction and CreateAction","description":null,"href":"/ai-actions/libraries/react/edit-action"},{"title":"StatelessActionCreator","description":null,"href":"/ai-actions/libraries/react/stateless-creator"}]}]}]},{"group":"Development Resources","pages":[{"title":"OpenAPI Specification","description":null,"url":"https://actions.zapier.com/api/v2/openapi.json","href":"/ai-actions/developer-resources/openapi"},{"title":"API Key","description":null,"url":"https://actions.zapier.com/credentials/","href":"/ai-actions/developer-resources/keys"},{"title":"API Logs","description":null,"url":"https://actions.zapier.com/logs/","href":"/ai-actions/developer-resources/logs"}]},{"group":"Help","pages":[{"title":"Join our Community","description":null,"url":"https://zapier.com/early-access","href":"/ai-actions/help/community"},{"title":"Submit an issue","description":null,"url":"https://nla.zapier.app/_z/embed/page/clh5sdteo0001ml0pdz8a2aqr?\u0026","href":"/ai-actions/help/bug"}]},{"group":"Apps","pages":[{"openapi":"get /v1/apps","href":"/partner-solutions/apps/get-apps-[v1]","title":"Get Apps [v1]","description":"This endpoint returns a list of apps sorted popularity. See the List Apps guide to get started.","version":null,"autogeneratedByOpenApi":true},{"openapi":"get /v2/apps","href":"/partner-solutions/apps/get-apps-[v2]","title":"Get Apps [v2]","description":"This endpoint returns a list of apps sorted by popularity.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Categories","pages":[{"openapi":"get /v1/categories","href":"/partner-solutions/categories/get-categories","title":"Get Categories","description":"List of Zap categories","version":null,"autogeneratedByOpenApi":true}]},{"group":"Accounts","pages":[{"openapi":"get /v1/profiles/me","href":"/partner-solutions/accounts/user-profile","title":"User Profile","description":"This endpoint returns the authenticated user information\n\n#### OAuth\n\nThis endpoint requires the `profile` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"get /v2/authorize","href":"/partner-solutions/accounts/create-account","title":"Create Account","description":"Create a new user and obtain an access token. See our Quick Account Creation guide to get started.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Zap Templates","pages":[{"openapi":"get /v1/zap-templates","href":"/partner-solutions/zap-templates/get-zap-templates","title":"Get Zap Templates","description":"List popular Zap Templates using your app. See our List Zap Templates guide to get started.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Zaps","pages":[{"openapi":"get /v1/zaps","href":"/partner-solutions/zaps/get-zaps-[v1]","title":"Get Zaps [v1]","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/guess","href":"/partner-solutions/zaps/guess-a-zap-[beta]","title":"Guess a Zap [Beta]","description":"This endpoint returns a suggested Zap and pre-filled URL to Zapier from a given prompt.","version":null,"autogeneratedByOpenApi":true},{"openapi":"get /v2/zaps","href":"/partner-solutions/zaps/get-zaps-[v2]","title":"Get Zaps [v2]","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\nThe `expand` array can be used to expand selected fields into full objects in the response. Inputs with keys can\nalso be passed to filter Zaps by certain criteria.\n\n#### OAuth\n\nThis endpoint requires the `zap`, `zap:all`, or `zap:account:all` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/zaps","href":"/partner-solutions/zaps/create-a-zap","title":"Create a Zap","description":"This URL creates a Zap based on the given steps and title.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Actions","pages":[{"openapi":"get /v2/actions","href":"/partner-solutions/actions/get-actions","title":"Get Actions","description":"Fetch the available actions for the provided App. It's typical to filter by type so that only actions that make sense for a particular step are shown. Action IDs may not be reused, see our documentation for how to hardcode a particular action.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/actions/{action_id}/inputs","href":"/partner-solutions/actions/get-input-fields","title":"Get Input Fields","description":"Get the Input Fields for a particular Action, using the provided authentication and inputs. See the fields and fieldsets guide for more information.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/actions/{action_id}/inputs/{input_id}/choices","href":"/partner-solutions/actions/get-choices","title":"Get Choices","description":"Get the possible values for a `SELECT` Input Field.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/actions/{action_id}/outputs","href":"/partner-solutions/actions/get-output-fields","title":"Get Output Fields","description":"Get the Output Fields for a particular Action, using the provided authentication and inputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/actions/{action_id}/test","href":"/partner-solutions/actions/step-test","title":"Step Test","description":"Tests the action (step) in the third party api, using the provided authentication and inputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Authentications","pages":[{"openapi":"get /v2/authentications","href":"/partner-solutions/authentications/get-authentications","title":"Get Authentications","description":"Fetch the available Authentications for the provided App. This will only return Authentications that are owned by the user and not those that are shared with them, since it's not possible to create Zaps with Authentications you don't own.\n\n#### OAuth\n\nThis endpoint requires the `authentication` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/authentications","href":"/partner-solutions/authentications/create-authentication","title":"Create Authentication","description":"Creates a new Authentication for the provided App. See our Adding an Authentication guide to get started.\n\n#### OAuth\n\nThis endpoint requires the `authentication:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Experimental","pages":[{"openapi":"post /v2/workflow-steps","href":"/partner-solutions/experimental/create-a-workflow-step","title":"Create a Workflow step","description":"Creates a new Workflow Step based on a single provided step and returns a webhook URL that can be used to invoke the Workflow Step and retrieve a response. When creating a Workflow write action step, field values can be hardcoded, or they can contain mapped values. The mapped values should be surrounded with double curly braces.\n\nIn the example request body the Workflow Step contains the field values `email`, `name`, `phone`, and `address` in double curly braces. Then the webhook URL returned can be called with a `POST` request containing a JSON body in the following format:\n\n```\n{\n\"email\": \"user@example.com\",\n\"name\": \"John Doe\",\n\"phone\": \"1234567890\",\n\"address\": \"123 Maple Lane\"\n}\n```\n\nNote that authentications may become invalid over time, and if this occurs, users will be notified by email to fix their authentication. If the authentication is not fixed, trying to run the Workflow Step will time out. Workflow Steps are also (for now) visible and editable as Zaps at https://zapier.com/app/zaps. If a user turns off a Workflow Step Zap, the request will similarly time out. Finally, it is possible that a user can edit the Workflow Step Zap such that it returns unexpected outputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"get /v2/zap-runs","href":"/partner-solutions/experimental/get-zap-runs","title":"Get Zap Runs","description":"This endpoint returns runs for the specified Zaps and provides basic yet essential details about their execution. As the initial version, it serves foundational information, with plans for continuous enhancement to expand its capabilities and improve data output over time.\n\n#### OAuth\n\nThis endpoint requires the `zap:runs` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]}],"docsNavWithMetadata":{"global":{"anchors":[{"anchor":"Community","href":"https://community.zapier.com/","icon":"users"},{"anchor":"Blog","href":"https://zapier.com/blog/","icon":"newspaper"},{"anchor":"Contact Us","href":"https://developer.zapier.com/contact","icon":"envelope"}]},"tabs":[{"tab":"Developer Platform","groups":[{"group":"","pages":[{"title":"Welcome","description":null,"path":"/","href":"/platform/home"},{"title":"Developer Platform Login","description":null,"url":"https://zapier.com/platform/login","href":"/platform/dev-platform-login"}]},{"group":"Quick start","pages":[{"title":"Build your integration on Zapier","description":"This guide will walk you through what steps you need to take to build an integration from start to finish. There are no fees to build an integration with Zapier.","sidebarTitle":"Introduction","href":"/platform/quickstart/build-integration"},{"group":"Developer tools","pages":[{"title":"Platform UI vs Platform CLI","description":"There are two different developer tools to build either private or public integrations with on the Zapier Developer Platform: Platform UI or Platform CLI.","href":"/platform/quickstart/ui-vs-cli"},{"title":"Platform UI tutorial","description":"This tutorial walks you through the process of building an integration on Zapier with authentication, a trigger and an action using the Platform UI.","href":"/platform/quickstart/ui-tutorial"},{"title":"Platform CLI tutorial","description":"This tutorial walks you through the process of building, testing, and pushing an example app to Zapier using Platform CLI. We'll use a mock API for recipes in this tutorial, but for production Zapier apps, you'd want to connect to a real API.","href":"/platform/quickstart/cli-tutorial"},{"title":"Get help with the Zapier Platform","description":"Get help building your app integration through the following channels:","href":"/platform/quickstart/get-help"}]},{"group":"Glossary","pages":[{"title":"Zapier Glossary","description":null,"mode":"wide","href":"/platform/quickstart/glossary"}]},{"group":"How it works","pages":[{"title":"How Zapier works","description":"[Zapier is a tool](https://zapier.com/how-it-works) that helps you automate repetitive tasks between two or more apps, no code necessary. Our customers use Zapier to move information from one app to another automatically rather than manually. Each Zap you create starts with a trigger (something that happens in one app) and then one or more actions (something else that happens in another app).","href":"/platform/quickstart/how-zapier-works"},{"title":"Zapier integration structure","description":"[Zapier's Developer Platform](https://developer.zapier.com/) includes everything needed to build and manage a new Zapier integration. When you access your integration project by name, you'll see the left sidebar outlines the core project structure.","href":"/platform/quickstart/zapier-integration-structure"},{"title":"Private vs public integrations","description":"When building an integration on the Zapier Platform, you must specify the intended audience.","href":"/platform/quickstart/private-vs-public-integrations"}]},{"title":"Recommended triggers and actions","description":"Whether you’re just starting to scope out a new Zapier integration build or have successfully launched your app in the Zapier App Directory, it’s helpful to know what features users find the most valuable and are the most widely used across Zapier’s various [app categories](https://zapier.com/apps). Ensuring your integration covers the foundational triggers, actions, and searches applicable to your app will provide more utility to your users.","href":"/platform/quickstart/recommended-triggers-and-actions"},{"title":"Zapier trusted app developers","description":"If you don't have the time/resources to dedicate towards building and launching your own integration, there are Zapier trusted developers who may be able to assist you. These are individuals/groups who have demonstrated their capabilities by satisfying our requirements for building apps on our Developer Platform, and we recommend as a substitute for building your integration in-house.","href":"/platform/quickstart/trusted-developers"}]},{"group":"Build with UI","pages":[{"title":"Platform UI tutorial","description":"This tutorial walks you through the process of building an integration on Zapier with authentication, a trigger and an action using the Platform UI.","href":"/platform/quickstart/ui-tutorial"},{"group":"Actions","pages":[{"title":"Action","description":"Every Zap starts with a single trigger that watches for new or updated data, starting the user's workflow. Action steps then make use of that data.","href":"/platform/build/action"},{"title":"Add a create action","description":null,"href":"/platform/build/create"},{"title":"Add a search action","description":null,"href":"/platform/build/search"},{"title":"Reorder or remove action","description":"Whenever a user selects your app's integration in a Zapier action step, they'll see every _create_ and _search_ action in your integration. ","href":"/platform/build/reorder-action"},{"title":"Add a search or create action","description":"When adding a _search_ action type, you'll see the option to _Pair an existing search and a create to enable “Find or Create” functionality_ in the _Settings_ page. This embeds the _create_ inside the _search_ step to find or create items in one step of the Zap.","href":"/platform/build/search-or-create"}]},{"group":"Advanced features","pages":[{"title":"Use environment variables in your API call","description":"Integrations can define environment variables that are available when the app's code executes. They are useful when you have data like an OAuth client ID and secret that you don't want to commit to source control. Environment variables can also be used as a way to toggle between a staging and production environment during app development and this would be recommended instead of the use of an independent integration for staging purposes.","href":"/platform/build/env"},{"title":"Add error response handling","description":"If your API returns responses with a status code above 400 that should not automatically throw an error then Zapier recommends enabling skipThrowForStatus.","href":"/platform/build/errors"},{"title":"Reference user-entered details with data bundles","description":"Zapier stores data from users' authentication and input forms for API calls in the `bundle` object. You can reference that data in your integration using `{{bundle.bundleName.field}}` text in API requests and connection labels, replacing `bundleName` with the bundle name and `field` with the input field key or API response field key you need.","href":"/platform/build/bundle"},{"title":"Use Code Mode to refine your API call","description":null,"href":"/platform/build/code-mode"},{"title":"Use hydration in Platform CLI","description":"The best answer to this lives in our [CLI docs](https://docs.zapier.com/platform/reference/cli-docs#dehydration):","href":"/platform/build/hydration-cli"},{"title":"Enable static IP address connection for customers","description":"To enable customers to access your integration by static IP address, all outbound traffic from Zapier to your integration will need to be routed through a smaller set of consistent IP addresses. Any app owner/developer can request to enable the static IP address feature on a private or public app.","href":"/platform/build/static-ip"}]},{"group":"Authentication","pages":[{"title":"Authentication","description":"Connecting an app to Zapier starts with authentication. Users select an app they wish to use in their Zap, authenticating their account with that app to allow Zapier to access their data.","sidebarTitle":"Overview","href":"/platform/build/auth"},{"title":"Add authentication with API Key","description":"API Key authentication passes along a user-entered API Key with every API call. In your Zapier integration using API Key authentication, the API key—and optionally any other data your API needs—is included every time a Zap step runs.","href":"/platform/build/apikeyauth"},{"title":"Add authentication with Basic Authentication","description":"APIs using Basic Authentication will authenticate users with a username and password. In your Zapier integration using Basic Auth, Zapier includes the username and password credentials in the API request bundle every time Zapier polls an API endpoint for new data or posts new data to an API endpoint.","href":"/platform/build/basicauth"},{"title":"Add authentication with Digest Authentication","description":"Digest Auth prompts users to enter their username and password, optionally along with any additional data your API requires for authentication. Zapier makes an unauthenticated API call to get the nonce from your server, and uses it to encrypt and pass the authentication data to your server with each API call.","href":"/platform/build/digestauth"},{"title":"Add authentication with OAuth v2","description":"OAuth v2 authentication matches in appearance the login process users expect from most modern apps.","href":"/platform/build/oauth"},{"title":"Add authentication with Session Authentication","description":"Session authentication has elements of Basic authentication — where Zapier requests a username and password, and OAuth v2 — where Zapier redirects users to the app's site to allow access. User credentials are exchanged for a token used to authenticate subsequent API calls.","href":"/platform/build/sessionauth"},{"title":"Add a connection label","description":"Zapier users can authenticate multiple accounts for any app. By default, every new app account added to Zapier is identified by the app's name, followed by a number (#2, #3, …) for accounts connected after the first.","href":"/platform/build/connection-label"},{"title":"Use computed fields in OAuth or Session Authentication","description":"When adding a field in your integration's authentication configuration, Zapier offers two field type options; field and computed field. The field option allows users to enter account information needed for authentication.","href":"/platform/build/computed-fields"},{"title":"Compute a field from the data of the Test API call","description":"Zapier doesn't store the responses from the test API call for OAuth v2 and session authentication. Using computed fields, you can use data from a test API call later in your Zapier integration.","href":"/platform/build/computed-test-field"},{"title":"Add authentication fields to Request Template","description":"The Request Template is a request editor that lets users set static values that apply to all requests made by this integration. Users can configure the URL params, HTTP headers and request body. This is the perfect place to set authentication fields.","href":"/platform/build/requesttemplate"},{"title":"Validate domain and subdomain input fields during authentication","description":"When adding a subdomain input field, commonly used in OAuth implementations, additional validation is strongly recommended to prevent a potential security vulnerability. If not taken into account, an attacker could utilize a maliciously constructed subdomain field (like `attacker-domain.com/`) in order to redirect OAuth connection requests to that attacker-controlled domain (because `attacker-domain.com/.your-domain.com` resolves to the attacker's domain instead of the expected one). Taking the following steps prevents the potential for an attacker to access your integration's sensitive authentication information, such as the OAuth client ID or secret.","href":"/platform/build/subdomain-validation"}]},{"group":"Input Fields","pages":[{"title":"Field types","description":null,"href":"/platform/build/field-definitions"},{"title":"Add input fields to triggers and actions","description":"When building in the Platform UI, you'll use the Input Designer to create the form users will input data into, to send to your app's API.","href":"/platform/build/add-fields"},{"title":"Send or receive dynamic user-defined fields through your API","description":"Dynamic fields are a type of field built from an API call. Custom code runs to show fields based on other input field data. These are especially useful with project management apps, CRM apps, databases, and any other app where users can add custom, user-defined fields.","href":"/platform/build/dynamic-field"},{"title":"Add line item group field to actions","description":"Input fields in Zapier add one item each time the Zap runs. But, if you want users to be able to add multiple items in a single Zap run, then this can be achieved by using a line item group. This group takes line items, which are comma-separated values, and adds each instance of the values to the app in a single Zap run.","href":"/platform/build/line-items"},{"title":"Search powered fields","href":"/platform/build/search-powered-fields"}]},{"group":"Output Fields","pages":[{"title":"Output data, defining sample data and output fields","description":"This guide will explain what output data, sample data and output fields are and how to modify them in your triggers or actions.","href":"/platform/build/sample-data"},{"title":"Response types Zapier expects","description":"With every API call, Zapier expects the response data to be returned in a specific response type. This can vary depending on what part of your integration you're working on. Use the table below to identify the correct response type to use","href":"/platform/build/response-types"}]},{"group":"Testing","pages":[{"title":"Test authentication","description":"Testing a user's authentication is crucially important, as it is later used to test subsequent trigger and action steps when built.","href":"/platform/build/test-auth"},{"title":"Test triggers or actions","description":"Once authentication is tested, trigger and action steps are easy to test inside Zapier visual builder. Set up the trigger or action settings and API calls, then as the last step the familiar _Test Your API Response_ box appears. It will show any accounts you added to your integration previously during the authentication testing.","href":"/platform/build/test-triggers-actions"},{"title":"Testing Tools","description":"The Zapier platform provides a set of tools to help inform and validate your integration before pushing changes out to users.","href":"/platform/build/test-tools"},{"title":"Test and monitor your integration in your Zapier account","description":"Testing inside the Platform UI is crucial during the building process. To ensure users can benefit from your integration's features, it is equally crucial to test your integration within the Zap editor. This is the best way to notice details that might have been overlooked while building your integration.","href":"/platform/build/test-monitoring"}]},{"group":"Triggers","pages":[{"title":"Trigger","description":null,"href":"/platform/build/trigger"},{"title":"Add a polling trigger","description":"Set up your polling trigger in the Platform UI with the Settings, Input Designer and API Configuration tabs.","href":"/platform/build/polling-trigger"},{"title":"Add a REST Hook trigger","description":"Set up your REST Hook trigger in the Platform UI with the Settings, Input Designer and API Configuration tabs.","href":"/platform/build/hook-trigger"},{"title":"Reorder or remove triggers","description":"Triggers are listed in alphabetical order in the Zap editor and this order cannot be changed.","href":"/platform/build/reorder-trigger"},{"title":"How deduplication works in Zapier","description":"Zapier automatically deduplicates incoming trigger data for your integration, so that Zaps do not run multiple times on the same data. Consider the following requirements for your “New Item” and “Updated Item” triggers to work as users expect.","href":"/platform/build/deduplication"},{"title":"Use pagination in triggers","description":"By default, Zapier triggers fetch new or recently updated data to start Zaps, and only need to find the most recently added items. Triggers can also be used to populate [dynamic dropdown fields](/platform/build/add-fields#dynamic-dropdown), and there they need to find all possible items to populate the field.","href":"/platform/build/pagination-trigger"},{"title":"Add an instant trigger using REST Hooks in Zapier Platform CLI","description":"REST Hooks are an alternative to polling. The main differences are allowing your customers' Zaps to trigger instantly; and avoiding polling triggers' numerous - and sometimes unnecessary - requests to your API's endpoints to check for new data.","href":"/platform/build/cli-hook-trigger"}]},{"group":"Troubleshooting","pages":[{"title":"Zapier operating constraints","description":"Zapier offers a relatively unique run-time environment for your integration and its requests to your API. The environment is stateless and restricts both execution time and payload size to offer normalized reliability and running time. There are three distinct contexts of this run-time that your integration will need to consider.","href":"/platform/build/operating-constraints"},{"title":"Troubleshoot trigger timeouts","description":null,"href":"/platform/build/troubleshoot-trigger-timeouts"},{"title":"Troubleshoot trigger request or response payload sizes","description":null,"href":"/platform/build/troubleshoot-trigger-payload"},{"title":"Troubleshoot action timeouts","description":null,"href":"/platform/build/troubleshoot-action-timeouts"},{"title":"Troubleshoot action request or response payload size","description":null,"href":"/platform/build/troubleshoot-action-payload"},{"title":"Troubleshoot custom fields","description":null,"href":"/platform/build/troubleshoot-custom-fields"},{"title":"Reduce requests to your API","description":null,"href":"/platform/build/reduce-api-requests"},{"title":"Troubleshoot throttles","description":null,"href":"/platform/build/troubleshoot-throttles"},{"title":"Hydration/dehydration limits","description":"[File dehydration](https://github.com/zapier/zapier-platform/blob/main/packages/cli/README.md#dehydration) is an extremely useful tool to remain within time and size constraints for Zapier triggers and actions. However, it does have its own limits.","href":"/platform/build/hydration-limits"},{"title":"Error: An array is expected","description":"When you add a polling trigger or search action to your integration, the Zapier platform [expects a bare array of new or found items returned](/platform/build/response-types), sorted in reverse chronological order. An API may instead return a result _object_ that contains the array of items the trigger/search needs.","href":"/platform/build/error-array-expected"},{"title":"Error: Got a non-object result, expected an object from create","description":null,"href":"/platform/build/error-non-object"},{"title":"Error: Got a non-object result in the array, expected only objects","description":"When using a REST Hook trigger, the data returned by the perform must be an array.","href":"/platform/build/error-non-object-array"}]},{"title":"Use form mode to setup your API calls","description":"In the Platform UI, when building your authentication, triggers and actions, the default setting under _API Configuration_ is to create each component of your integration using Form Mode.","href":"/platform/build/form-mode"}]},{"group":"Build with CLI","pages":[{"title":"Build with CLI","description":"Zapier is a platform for creating integrations and workflows. This CLI is your gateway to creating custom applications on the Zapier platform.","sidebarTitle":"Overview","href":"/platform/build-cli/overview"},{"group":"Features","pages":[{"group":"Input Fields","pages":[{"title":"Input Field Configuration","description":null,"sidebarTitle":"Configuration","href":"/platform/build-cli/input-fields"},{"title":"Field types","description":null,"href":"/platform/build/field-definitions"},{"title":"Dynamic Dropdowns","description":null,"href":"/platform/build-cli/dynamic-dropdowns"}]}]},{"title":"Platform CLI tutorial","description":"This tutorial walks you through the process of building, testing, and pushing an example app to Zapier using Platform CLI. We'll use a mock API for recipes in this tutorial, but for production Zapier apps, you'd want to connect to a real API.","href":"/platform/quickstart/cli-tutorial"},{"title":"Frequently Asked Questions","description":null,"sidebarTitle":"FAQs","href":"/platform/build-cli/faqs"},{"title":"Core Reference","description":"Reference for `zapier-platform-core`","href":"/platform/build-cli/core"},{"title":"CLI Reference","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md","href":"/platform/reference/cli"},{"title":"Schema Reference","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md","href":"/platform/reference/schema"}]},{"group":"Manage","pages":[{"group":"Account and team","pages":[{"title":"Invite team members to your integration","description":"Integrations do not have a dedicated owner, instead they are managed by a team that can be modified as needed. Add team members to your integration to collaborate, contribute, and view analytics data for your integration on the Developer Platform. Your integration team can have up to 200 team members, regardless of whether your integration is Private or Public.","sidebarTitle":"Add team members to integration","href":"/platform/manage/add-team"}]},{"group":"Integration changes","pages":[{"title":"Planning and implementing integration changes","description":"Before making updates to your integration, it's important to consider the potential impact on user migration and existing Zaps. Ensuring your API and Zapier integration remains backwards compatible is crucial to avoid disruption to users. However, we acknowledge certain changes are sometimes necessary and unavoidable. In such cases, consider the best practice for implementation.","href":"/platform/manage/planning-changes"},{"title":"Change authentication type","description":"If your API's authentication method changes, you would need to change the method Zapier uses to authenticate user accounts.","href":"/platform/manage/auth-scheme"},{"title":"Add required authentication field","description":null,"href":"/platform/manage/auth-required"},{"title":"Change authentication field keys","description":null,"href":"/platform/manage/auth-keys"},{"title":"Change trigger or action key","description":null,"href":"/platform/manage/change-keys"},{"title":"Add new required input field","description":null,"href":"/platform/manage/required-input"},{"title":"Change input form field key","description":null,"href":"/platform/manage/input-key"},{"title":"Change output field key","description":null,"href":"/platform/manage/output-key"},{"title":"Change output data response","description":null,"href":"/platform/manage/output"},{"title":"Change trigger from polling to REST Hook","description":null,"href":"/platform/manage/change-trigger"},{"title":"Update perform method for polling trigger","description":null,"href":"/platform/manage/change-perform"},{"title":"Changes to your API can impact your integration","description":null,"href":"/platform/manage/change-api"},{"title":"Export integration to Platform CLI","description":"The Zapier Platform CLI (Command Line Interface) is a toolset you install and run in your local development environment. It allows you to build, test, and manage your Zapier integration through JavaScript code and terminal commands.","href":"/platform/manage/export-cli"},{"title":"Export integration to Platform UI","description":"The Zapier Platform UI is the easiest way for anyone with API experience to build Zapier integrations. It is for users more comfortable with a visual form editor.","href":"/platform/manage/export-ui"},{"title":"Essential tips for integrating quality health practices","description":"Our shared customers rely on Zapier and your integration for business-critical workflows. Addressing feedback early and often ensures users have the best experience, both with Zapier's platform and yours. Follow these tips on how. ","href":"/platform/manage/essential-tips-iq"}]},{"group":"Integration performance","pages":[{"title":null,"description":"Zapier recognizes that temporary unavailability is sometimes inevitable for your API.","Title":"Prepare for API outages","href":"/platform/manage/api-outage"},{"title":"Embed insights definitions","description":"Embed features are available for public integrations.","href":"/platform/manage/embed-insights"},{"title":"Respond to user feedback and bugs","description":"For public integrations, Zapier's Support team logs user requests and reported problems in Zapier's issue tracker, that your team can see from the _Bug \u0026 Feature Requests_ page in the Manage section.","href":"/platform/manage/user-feedback"},{"title":"Improve error response handling","description":"Errors from your API cause pain for users at two vital points:","href":"/platform/manage/error-handling"},{"title":"Active users retention","description":"At Zapier, churn means a user used your integration in their Zaps 29 - 56 days ago, but hasn't run a successful task in one of those Zaps in the past 28 days. This user is considered to have churned from the integration. Maybe they switched to using a competing integration or their workflow had a more periodic or seasonal cadence.","href":"/platform/manage/active-users"},{"title":"Integration insights definitions","description":"Integration quality on Zapier boils down to two main pillars: **Health** and **Depth**.","href":"/platform/manage/integration-insights"},{"title":"Zap activation rates","description":"Consider all of the Zaps that users try to create with your integration's triggers, actions, or searches. The Zap activation rate is the percentage of those Zaps that actually activated within 24 hours of creation, meaning the Zap ran at least one successful task.","href":"/platform/manage/zap-activation"},{"title":"Embed activation rates","description":"Consider all the user clicks on Zap Templates surfaced in your embeds. The embed activation rate is the percentage of those Zaps that actually activated within 24 hours of creation, meaning the Zap ran at least one successful task. It measures the efefctiveness of the Zapier embeds in your product at converting user clicks on Zap Templates to Zap activations.","href":"/platform/manage/embed-activation"}]},{"group":"Sharing","pages":[{"title":"Share your integration","description":"Once an integration is public, all users would have access to it when searching for an app's name in the Zap Editor, or in the [Zapier App Directory](https://zapier.com/apps).","href":"/platform/manage/sharing"}]},{"group":"Versions","pages":[{"title":"Versions","description":"Versions in Developer Platform allow developers to create multiple iterations of their integration to experiment with and implement new features without affecting existing users. Each integration can have many versions, but only one version can have a public status at a one time.","href":"/platform/manage/versions"},{"title":"Clone a version","description":"Cloning allows you to duplicate an existing version of your integration. This is particularly useful when you want to introduce new features or fixes without altering the original integration. When a previous version of your integration has more than 5 active users, you will need to clone that version to make modifications.","href":"/platform/manage/clone"},{"title":"Promote a version","description":"After your integration has entered the beta or public status, you can set a new default version for public use. This process is called promoting a version.","href":"/platform/manage/promote"},{"title":"Migrate users to a new version","description":"If this isn't the first time you've promoted your app - you might have users on older versions.","href":"/platform/manage/migrate"},{"title":"Deprecate or delete a version","description":"Deprecation is an optional process that allows you to set a date from which a non-public version of your integration will no longer be updated. Deprecation is only recommended if the older integration version will eventually stop working, such as if the related API will be removed. Zapier is normally a “set it and forget it” experience for users, so use this feature carefully. Only if the older version will no longer function, should it be deprecated. Please note that deprecating a version is significantly more disruptive to our mutual users than migrating to the latest promoted version, or than leaving users on an older (now) private version if migration is not possible.","href":"/platform/manage/deprecate"},{"title":"Manage a legacy integration","description":null,"href":"/platform/manage/versions-legacy"}]},{"title":"Add integration branding in Platform CLI","description":"When you make a new integration in Zapier CLI, you can add the app's name, description, and homepage to the `package.json` file.","href":"/platform/manage/branding-cli"}]},{"group":"Publish","pages":[{"group":"Branding","pages":[{"title":"Integration branding guidelines","description":"When creating your integration, you'll add your app’s name, logo, description, category, and primary brand color. Consistent branding is essential for helping users recognize and discover your app on Zapier.","href":"/platform/publish/branding-guidelines"},{"title":"Add or modify integration branding and details","description":"When creating a new integration in the Platform UI from the link `https://developer.zapier.com/app/new`, you'll be prompted to add the app name, description, homepage URL and logo.","href":"/platform/publish/add-or-modify-branding"}]},{"group":"Launch process","pages":[{"title":"Build your first public integration on Zapier","description":"This guide gives an overview of the process to publishing a public integration.","href":"/platform/publish/public-integration"},{"title":"Integration build guidelines","description":"Before publishing your integration on Zapier, it is essential to ensure that your integration is well-prepared to provide a seamless and efficient user experience. The following guidelines are designed to assist you in refining your integration before submitting it for review. Adhering to these guidelines will help enhance the functionality and user interaction with your integration and will provide you with the best value and opportunities to harness Zapier as a method of obtaining new users and most commonly, boosting the lifetime value of your current customers.","href":"/platform/publish/integration-build-guidelines"},{"title":"Integration publishing requirements","description":"We're excited you are creating an integration for the [Zapier Platform](https://zapier.com/developer-platform). We're here to help you understand our platform and its requirements so that you can successfully prepare your Zapier integration for publishing. Thousands of partners have built integrations on the Zapier Platform that enable our mutual users to set up Zaps as easily and quickly as possible.","href":"/platform/publish/integration-publishing-requirements"},{"title":"Zap templates","description":"Zapier empowers apps to do together what they can't on their own. With a bit of inspiration and creativity, your users can pull dozens of apps together into unique workflows to get more done with your app in far less time.","href":"/platform/publish/zap-templates"},{"title":"Create help documentation for your users","description":"The Zapier team provide frontline support for your integration, and in order to provide the best experience for your users, help documentation about using your integration in Zaps is hosted in the [Zapier Help Center](https://help.zapier.com/hc/en-us).","href":"/platform/publish/user-help"},{"title":"Best practices for showcasing your integration","description":"Sharing well-crafted content about your Zapier integration can help you improve user adoption, highlight key use cases, and simplify integration processes. Need some inspiration? The following examples show how some of our partners are effectively communicating their Zapier integrations across different platforms.","href":"/platform/publish/best-practices"},{"title":"Zapier Partner Sandbox","description":"Zapier Partner Sandbox is a workspace for people in your organization who are on your integration team.","href":"/platform/publish/zps"}]},{"group":"Partner program","pages":[{"title":"Partner Program","description":"The [Zapier Partner Program](https://zapier.com/developer-platform/partner-program) is a program for Zapier's [6,000+ integration partners](https://zapier.com/apps). It is designed to give all partners a clear path to success for their integrations and reward them with benefits along the way.","href":"/platform/publish/partner-program"},{"title":"Integration success strategies","description":"With 7,000+ public integration partners on Zapier, use these 10 tried-and-true tactics from our top partners to skyrocket your growth and earn you more [benefits from the Partner Program](https://zapier.com/developer-platform/partner-program).","href":"/platform/publish/partner-faq"},{"title":"A Guide to Zapier Partner Program Benefits: Accelerate your integration's growth and reach","description":"Zapier offers a variety of marketing and support benefits to partners. This cheat sheet is designed to help you understand when and how you can access each of these benefits as you unlock them.","href":"/platform/publish/benefits-guide"}]},{"group":"Validation","pages":[{"title":"Integration check reference","description":"Before you can submit your integration for publishing, it runs through a set of automated checks to ensure it's working properly and giving our users (and yours) the best possible experience.","href":"/platform/publish/integration-checks-reference"}]}]},{"group":"Embed","pages":[{"title":"Partner Solutions Documentation","description":"Our partner solutions are the easiest ways to embed Zapier and surface integrations within your product.","href":"/platform/embed/partner-solutions"}]},{"group":"Reference","pages":[{"group":"Use cases","pages":[{"title":"Zapier integration structure for a forms app","description":"Form and survey app integrations built on Zapier allow users to connect mobile data collection forms to send the responses into other apps as new contacts, document templates, messages, and more.","href":"/platform/reference/forms-app"},{"title":"Zapier integration structure for a CRM app","description":"CRM (customer relationship management) apps are detailed databases that link contacts with companies, companies with deals, and more.","href":"/platform/reference/crm-app"},{"title":"Zapier integration structure for a project management app","description":"While you can't automate project work, you can automatically add tasks, create new projects, and keep track of progress via an app integration on Zapier.","href":"/platform/reference/project-app"},{"title":"Zapier integration structure for an AI app","description":"AI app integrations built on Zapier allow users to automate tasks using AI capabilities. Here are some common pain points and recommendations when building AI apps on Zapier.","href":"/platform/reference/ai-app"}]},{"title":"Transfer","description":"[Transfer](https://help.zapier.com/hc/en-us/articles/8496274335885) is a Zapier functionality that enables users to perform bulk operations using their historical data.","href":"/platform/reference/transfer"},{"title":"AI Actions","description":"Zapier's [AI Actions](https://actions.zapier.com/) is an AI alpha product designed to work with natural language-based products. It leverages the Zapier platform, with over [6000 apps](https://zapier.com/apps). You can include the capabilities of Zapier's platform in your own product.","href":"/platform/reference/ai-actions"},{"title":"Custom Actions and API Requests Actions","description":"[Custom Actions](https://help.zapier.com/hc/en-us/articles/16276574838925-App-Extensions-in-Zapier) and [API Requests](https://help.zapier.com/hc/en-us/articles/12899607716493-Set-up-an-API-request-action#prerequisites-0-0) are features that have been developed internally at Zapier, designed to help our mutual customers achieve the most value out of your app integration.","href":"/platform/reference/custom-actions-api-requests"},{"title":"Scripting in converted Legacy Web Builder Integrations","description":"This guide provides instructions on editing and maintaining existing scripting methods for legacy web builder integrations that have been converted to either the Platform UI or Platform CLI.","href":"/platform/reference/legacy-scripting"},{"title":"Changelog","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/CHANGELOG.md","href":"/platform/reference/changelog"},{"title":"CLI Reference","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md","href":"/platform/reference/cli"},{"title":"Schema Reference","description":null,"url":"https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md","href":"/platform/reference/schema"}]}]},{"tab":"Partner Solutions","groups":[{"group":"Welcome","pages":[{"title":"Zapier Partner Solutions","description":"Add automation to your product with Zapier.","href":"/partner-solutions/getting-started"}]},{"group":"Workflow API","pages":[{"title":"Integrate the Workflow API","description":"Our most powerful tool for building native workflows in your product","href":"/partner-solutions/workflow-api/intro"},{"group":"Building a Workflow","pages":[{"title":"How to Build a Workflow","description":"This guide walks through the entire process of building an automated workflow for your users to use -- from picking apps, adding authentication, filling inputs and publishing.","href":"/partner-solutions/workflow-api/Building-a-Zap"},{"title":"Fields and Fieldsets","description":null,"href":"/partner-solutions/workflow-api/Fields-and-Fieldsets"},{"title":"Selecting an Action","description":"An Action is an operation that can be performed against a third-party API; either a `READ` or a `WRITE`.","href":"/partner-solutions/workflow-api/Selecting-an-Action"},{"title":"Selecting an Authentication","description":"Support users in selecting 3rd party authentications, either through an existing authentication or by adding new.","href":"/partner-solutions/workflow-api/Selecting-an-Authentication"},{"group":"Custom Flows","pages":[{"title":"Testing a Step","description":"Step testing allows for the validation of a configured step, executing any `READ` or `WRITE` actions.","href":"/partner-solutions/workflow-api/testing-a-step"},{"title":"Hardcoding an Action","description":"To help focus the user experience, it can be helpful to hardcode a certain Action to guide users in selecting the most appropriate action for their use-case.","href":"/partner-solutions/workflow-api/Hardcoding-an-Action"},{"title":"Adding an Authentication to your app","description":"Reduce friction when adding an authentication to your own app.","href":"/partner-solutions/workflow-api/adding-an-authentication"}]},{"title":"Known Limitations","description":"Creating workflows using the Zapier Workflow API is a recent addition, and there are some known limitations.","href":"/partner-solutions/workflow-api/limitations"}]},{"title":"Retrieving Apps on Zapier","description":"Listing apps available on Zapier is a simple way to show users all of what's possible on Zapier","href":"/partner-solutions/workflow-api/list-apps"},{"title":"Retrieving a list of users Zaps","description":"Listing a users zaps reveals existing workflows created by users.","href":"/partner-solutions/workflow-api/list-zaps"},{"title":"Retrieving Zap Templates","description":"Zap templates are pre-made Zaps that help users discover popular use cases for automating their work. Each template features a specific use case and the apps needed for it to work.","href":"/partner-solutions/workflow-api/list-zap-templates"},{"title":"Embedding the Zapier Editor","description":"With an embedded Zap editor in your product, your users can create and edit their Zaps without leaving your app.","href":"/partner-solutions/workflow-api/embed-zap-editor"}]},{"group":"Workflow Element","pages":[{"title":"Embed the Workflow Element","description":"The Workflow Element is a prebuilt UI component that offers the quickest—and easiest—way to surface your Zapier integration directly within your own product.","href":"/partner-solutions/workflow-element/intro"},{"title":"Element Security","description":"Keeping our elements secure and usable is critical at Zapier","href":"/partner-solutions/elements-security"},{"title":"Embed Insights","description":"Insights are available to review the performance of your embed, and track usage growth.","href":"/partner-solutions/embed-insights"}]},{"group":"Embed Enhancements","pages":[{"title":"Pre-filled Zaps","description":"Prefills allow you to define the input fields on behalf of the user, simplying the experience of setting up their Zap.","href":"/partner-solutions/pre-filled-zaps"},{"title":"Quick Account Creation","description":"Quick Account Creation is a seamless, accelerated sign-up feature allowing first time Zapier users to skip the standard sign-up procedure and onboarding survey. Enabling Quick Account Creation as part of your embed tool code helps provide a more frictionless experience for end users.","href":"/partner-solutions/quick-account-creation"}]},{"group":"Getting Started With the API","pages":[{"title":"Zapier Authentication","description":"Authenticate with The Zapier Workflow API","href":"/partner-solutions/api-reference/authentication"},{"title":"Rate Limiting","description":"Rate limits when accessing the Workflow API ","href":"/partner-solutions/api-reference/rate-limiting"}]},{"group":"Apps","pages":[{"title":"Get Apps [v1]","description":"This endpoint returns a list of apps sorted popularity. See the List Apps guide to get started.","openapi":"get /v1/apps","href":"/partner-solutions/api-reference/apps/get-apps-[v1]"},{"title":"Get Apps [v2]","description":"This endpoint returns a list of apps sorted by popularity.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","openapi":"get /v2/apps","href":"/partner-solutions/api-reference/apps/get-apps-[v2]"}]},{"group":"Categories","pages":[{"title":"Get Categories","description":"List of Zap categories","openapi":"get /v1/categories","href":"/partner-solutions/api-reference/categories/get-categories"}]},{"group":"Accounts","pages":[{"title":"User Profile","description":"This endpoint returns the authenticated user information\n\n#### OAuth\n\nThis endpoint requires the `profile` OAuth scope.","openapi":"get /v1/profiles/me","href":"/partner-solutions/api-reference/accounts/user-profile"},{"title":"Create Account","description":"Create a new user and obtain an access token. See our Quick Account Creation guide to get started.","openapi":"get /v2/authorize","href":"/partner-solutions/api-reference/accounts/create-account"}]},{"group":"Zap Templates","pages":[{"title":"Get Zap Templates","description":"List popular Zap Templates using your app. See our List Zap Templates guide to get started.","openapi":"get /v1/zap-templates","href":"/partner-solutions/api-reference/zap-templates/get-zap-templates"}]},{"group":"Zaps","pages":[{"title":"Get Zaps [v1]","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","openapi":"get /v1/zaps","href":"/partner-solutions/api-reference/zaps/get-zaps-[v1]"},{"title":"Guess a Zap [Beta]","description":"This endpoint returns a suggested Zap and pre-filled URL to Zapier from a given prompt.","openapi":"post /v2/guess","href":"/partner-solutions/api-reference/zaps/guess-a-zap"},{"title":"Get Zaps [v2]","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\nThe `expand` array can be used to expand selected fields into full objects in the response. Inputs with keys can\nalso be passed to filter Zaps by certain criteria.\n\n#### OAuth\n\nThis endpoint requires the `zap`, `zap:all`, or `zap:account:all` OAuth scope.","openapi":"get /v2/zaps","href":"/partner-solutions/api-reference/zaps/get-zaps-[v2]"},{"title":"Create a Zap","description":"This URL creates a Zap based on the given steps and title.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/zaps","href":"/partner-solutions/api-reference/zaps/create-a-zap"}]},{"group":"Actions","pages":[{"title":"Get Actions","description":"Fetch the available actions for the provided App. It's typical to filter by type so that only actions that make sense for a particular step are shown. Action IDs may not be reused, see our documentation for how to hardcode a particular action.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","openapi":"get /v2/actions","href":"/partner-solutions/api-reference/actions/get-actions"},{"title":"Get Input Fields","description":"Get the Input Fields for a particular Action, using the provided authentication and inputs. See the fields and fieldsets guide for more information.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/actions/{action_id}/inputs","href":"/partner-solutions/api-reference/actions/get-input-fields"},{"title":"Get Choices","description":"Get the possible values for a `SELECT` Input Field.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","openapi":"post /v2/actions/{action_id}/inputs/{input_id}/choices","href":"/partner-solutions/api-reference/actions/get-choices"},{"title":"Get Output Fields","description":"Get the Output Fields for a particular Action, using the provided authentication and inputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/actions/{action_id}/outputs","href":"/partner-solutions/api-reference/actions/get-output-fields"},{"title":"Step Test","description":"Tests the action (step) in the third party api, using the provided authentication and inputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/actions/{action_id}/test","href":"/partner-solutions/api-reference/actions/step-test"}]},{"group":"Authentications","pages":[{"title":"Get Authentications","description":"Fetch the available Authentications for the provided App. This will only return Authentications that are owned by the user and not those that are shared with them, since it's not possible to create Zaps with Authentications you don't own.\n\n#### OAuth\n\nThis endpoint requires the `authentication` OAuth scope.","openapi":"get /v2/authentications","href":"/partner-solutions/api-reference/authentications/get-authentications"},{"title":"Create Authentication","description":"Creates a new Authentication for the provided App. See our Adding an Authentication guide to get started.\n\n#### OAuth\n\nThis endpoint requires the `authentication:write` OAuth scope.","openapi":"post /v2/authentications","href":"/partner-solutions/api-reference/authentications/create-authentication"}]},{"group":"Experimental","pages":[{"title":"Create a Workflow step","description":"Creates a new Workflow Step based on a single provided step and returns a webhook URL that can be used to invoke the Workflow Step and retrieve a response. When creating a Workflow write action step, field values can be hardcoded, or they can contain mapped values. The mapped values should be surrounded with double curly braces.\n\nIn the example request body the Workflow Step contains the field values `email`, `name`, `phone`, and `address` in double curly braces. Then the webhook URL returned can be called with a `POST` request containing a JSON body in the following format:\n\n```\n{\n\"email\": \"user@example.com\",\n\"name\": \"John Doe\",\n\"phone\": \"1234567890\",\n\"address\": \"123 Maple Lane\"\n}\n```\n\nNote that authentications may become invalid over time, and if this occurs, users will be notified by email to fix their authentication. If the authentication is not fixed, trying to run the Workflow Step will time out. Workflow Steps are also (for now) visible and editable as Zaps at https://zapier.com/app/zaps. If a user turns off a Workflow Step Zap, the request will similarly time out. Finally, it is possible that a user can edit the Workflow Step Zap such that it returns unexpected outputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","openapi":"post /v2/workflow-steps","href":"/partner-solutions/api-reference/experimental/create-a-workflow-step"}]},{"group":"Schemas","pages":[{"group":"Common Types","pages":[{"title":null,"description":null,"openapi-schema":"Action","href":"/partner-solutions/api-reference/common-types/action"},{"title":null,"description":null,"openapi-schema":"Apps","href":"/partner-solutions/api-reference/common-types/app"},{"title":null,"description":null,"openapi-schema":"Authentication","href":"/partner-solutions/api-reference/common-types/authentication"},{"title":null,"description":null,"openapi-schema":"Choice","href":"/partner-solutions/api-reference/common-types/choice"},{"title":null,"description":null,"openapi-schema":"Fieldset","href":"/partner-solutions/api-reference/common-types/fieldset"},{"title":null,"description":null,"openapi-schema":"InfoField","href":"/partner-solutions/api-reference/common-types/infoField"},{"title":null,"description":null,"openapi-schema":"InputField","href":"/partner-solutions/api-reference/common-types/inputField"},{"title":null,"description":null,"openapi-schema":"OutputField","href":"/partner-solutions/api-reference/common-types/outputField"},{"title":null,"description":null,"openapi-schema":"Zap","href":"/partner-solutions/api-reference/common-types/zap"},{"title":"Errors","description":"Errors in the API follow the \u003ca href=\"https://jsonapi.org/format/#error-objects\" target=\"_blank\"\u003erecommendation\u003c/a\u003e from the JSON API spec.","href":"/partner-solutions/api-reference/common-types/errors"},{"title":"Pagination","description":null,"href":"/partner-solutions/api-reference/common-types/pagination"},{"title":"Requests","description":null,"href":"/partner-solutions/api-reference/common-types/requests"},{"title":"Responses","description":"Responses for the API follow the \u003ca href=\"https://jsonapi.org/format/#fetching-resources-responses-200\" target=\"_blank\"\u003eJSON API spec\u003c/a\u003e for fetching resources.","href":"/partner-solutions/api-reference/common-types/responses"}]}]},{"group":"Apps","pages":[{"openapi":"get /v1/apps","href":"/partner-solutions/apps/get-apps-[v1]","title":"Get Apps [v1]","description":"This endpoint returns a list of apps sorted popularity. See the List Apps guide to get started.","version":null,"autogeneratedByOpenApi":true},{"openapi":"get /v2/apps","href":"/partner-solutions/apps/get-apps-[v2]","title":"Get Apps [v2]","description":"This endpoint returns a list of apps sorted by popularity.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Categories","pages":[{"openapi":"get /v1/categories","href":"/partner-solutions/categories/get-categories","title":"Get Categories","description":"List of Zap categories","version":null,"autogeneratedByOpenApi":true}]},{"group":"Accounts","pages":[{"openapi":"get /v1/profiles/me","href":"/partner-solutions/accounts/user-profile","title":"User Profile","description":"This endpoint returns the authenticated user information\n\n#### OAuth\n\nThis endpoint requires the `profile` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"get /v2/authorize","href":"/partner-solutions/accounts/create-account","title":"Create Account","description":"Create a new user and obtain an access token. See our Quick Account Creation guide to get started.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Zap Templates","pages":[{"openapi":"get /v1/zap-templates","href":"/partner-solutions/zap-templates/get-zap-templates","title":"Get Zap Templates","description":"List popular Zap Templates using your app. See our List Zap Templates guide to get started.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Zaps","pages":[{"openapi":"get /v1/zaps","href":"/partner-solutions/zaps/get-zaps-[v1]","title":"Get Zaps [v1]","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/guess","href":"/partner-solutions/zaps/guess-a-zap-[beta]","title":"Guess a Zap [Beta]","description":"This endpoint returns a suggested Zap and pre-filled URL to Zapier from a given prompt.","version":null,"autogeneratedByOpenApi":true},{"openapi":"get /v2/zaps","href":"/partner-solutions/zaps/get-zaps-[v2]","title":"Get Zaps [v2]","description":"This endpoint returns a list of Zaps for the authenticated Zapier user.\n\nThe `expand` array can be used to expand selected fields into full objects in the response. Inputs with keys can\nalso be passed to filter Zaps by certain criteria.\n\n#### OAuth\n\nThis endpoint requires the `zap`, `zap:all`, or `zap:account:all` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/zaps","href":"/partner-solutions/zaps/create-a-zap","title":"Create a Zap","description":"This URL creates a Zap based on the given steps and title.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Actions","pages":[{"openapi":"get /v2/actions","href":"/partner-solutions/actions/get-actions","title":"Get Actions","description":"Fetch the available actions for the provided App. It's typical to filter by type so that only actions that make sense for a particular step are shown. Action IDs may not be reused, see our documentation for how to hardcode a particular action.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/actions/{action_id}/inputs","href":"/partner-solutions/actions/get-input-fields","title":"Get Input Fields","description":"Get the Input Fields for a particular Action, using the provided authentication and inputs. See the fields and fieldsets guide for more information.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/actions/{action_id}/inputs/{input_id}/choices","href":"/partner-solutions/actions/get-choices","title":"Get Choices","description":"Get the possible values for a `SELECT` Input Field.\n\n#### OAuth\n\nThis endpoint requires the `zap` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/actions/{action_id}/outputs","href":"/partner-solutions/actions/get-output-fields","title":"Get Output Fields","description":"Get the Output Fields for a particular Action, using the provided authentication and inputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/actions/{action_id}/test","href":"/partner-solutions/actions/step-test","title":"Step Test","description":"Tests the action (step) in the third party api, using the provided authentication and inputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Authentications","pages":[{"openapi":"get /v2/authentications","href":"/partner-solutions/authentications/get-authentications","title":"Get Authentications","description":"Fetch the available Authentications for the provided App. This will only return Authentications that are owned by the user and not those that are shared with them, since it's not possible to create Zaps with Authentications you don't own.\n\n#### OAuth\n\nThis endpoint requires the `authentication` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"post /v2/authentications","href":"/partner-solutions/authentications/create-authentication","title":"Create Authentication","description":"Creates a new Authentication for the provided App. See our Adding an Authentication guide to get started.\n\n#### OAuth\n\nThis endpoint requires the `authentication:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]},{"group":"Experimental","pages":[{"openapi":"post /v2/workflow-steps","href":"/partner-solutions/experimental/create-a-workflow-step","title":"Create a Workflow step","description":"Creates a new Workflow Step based on a single provided step and returns a webhook URL that can be used to invoke the Workflow Step and retrieve a response. When creating a Workflow write action step, field values can be hardcoded, or they can contain mapped values. The mapped values should be surrounded with double curly braces.\n\nIn the example request body the Workflow Step contains the field values `email`, `name`, `phone`, and `address` in double curly braces. Then the webhook URL returned can be called with a `POST` request containing a JSON body in the following format:\n\n```\n{\n\"email\": \"user@example.com\",\n\"name\": \"John Doe\",\n\"phone\": \"1234567890\",\n\"address\": \"123 Maple Lane\"\n}\n```\n\nNote that authentications may become invalid over time, and if this occurs, users will be notified by email to fix their authentication. If the authentication is not fixed, trying to run the Workflow Step will time out. Workflow Steps are also (for now) visible and editable as Zaps at https://zapier.com/app/zaps. If a user turns off a Workflow Step Zap, the request will similarly time out. Finally, it is possible that a user can edit the Workflow Step Zap such that it returns unexpected outputs.\n\n#### OAuth\n\nThis endpoint requires the `zap:write` OAuth scope.","version":null,"autogeneratedByOpenApi":true},{"openapi":"get /v2/zap-runs","href":"/partner-solutions/experimental/get-zap-runs","title":"Get Zap Runs","description":"This endpoint returns runs for the specified Zaps and provides basic yet essential details about their execution. As the initial version, it serves foundational information, with plans for continuous enhancement to expand its capabilities and improve data output over time.\n\n#### OAuth\n\nThis endpoint requires the `zap:runs` OAuth scope.","version":null,"autogeneratedByOpenApi":true}]}]},{"tab":"AI Actions","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","description":"AI Actions exposes Zapier's 7,000+ apps and 30,000+ actions, for selected partners, to build your own custom AI assistants.","href":"/ai-actions/intro"},{"title":"Quickstart","description":"Learn how to kick-start AI Actions by obtaining a partner key, setting up allowed actions, and executing an action through our API.","href":"/ai-actions/quickstart"}]},{"group":"How to","pages":[{"title":"Authentication","description":"Test that the API and auth are working.","openapi":"get /api/v2/auth/check/","href":"/ai-actions/how-tos/auth"},{"title":"Zapier account list","description":"Get a list of Zapier accounts for the current user.","openapi":"get /api/v2/auth/accounts/","href":"/ai-actions/how-tos/account-list"},{"title":"Stored Vs. Stateless Actions","description":null,"href":"/ai-actions/how-tos/stateless-vs-stored"},{"group":"Stored actions","pages":[{"title":"Stored actions introduction","description":null,"href":"/ai-actions/how-tos/stored/intro"},{"title":"Configure stored actions in the AI Actions UI","description":null,"href":"/ai-actions/how-tos/stored/action-configuration"},{"title":"List stored Actions","description":"List all the current actions for the current user.","openapi":"get /api/v2/ai-actions/","href":"/ai-actions/how-tos/stored/list-actions"},{"title":"Run a stored action","description":"Given an action ID and instructions, this will execute the action and return the results.","openapi":"post /api/v2/ai-actions/{ai_action_id}/execute/","href":"/ai-actions/how-tos/stored/run-stored-action"},{"group":"Manage stored actions","pages":[{"title":"Get stored action","description":"Get the details of a specific AI Action.","openapi":"get /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/how-tos/stored/manage/get-action"},{"title":"Create stored action","description":"Create a new AI Action that can be executed by the user later.","openapi":"post /api/v2/ai-actions/","href":"/ai-actions/how-tos/stored/manage/create-action"},{"title":"Update stored action","description":"Update an existing AI Action.","openapi":"put /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/how-tos/stored/manage/update-action"},{"title":"Delete stored action","description":"Delete an AI Action.\n\nReturns `true` if the action was deleted, `false` if it was not found.","openapi":"delete /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/how-tos/stored/manage/delete-action"}]}]},{"group":"Stateless actions","pages":[{"title":"Stateless actions introduction","description":null,"href":"/ai-actions/how-tos/stateless/intro"},{"title":"Run a Stateless Action","description":null,"openapi":"post /api/v2/execute/","href":"/ai-actions/how-tos/stateless/run-stateless-action"}]},{"group":"Gathering action information","pages":[{"title":"Introduction","description":null,"href":"/ai-actions/how-tos/action-info/introduction"},{"title":"Find an app","description":"Search through all Zapier apps.","openapi":"get /api/v2/apps/search/","href":"/ai-actions/how-tos/action-info/find-app"},{"title":"Find an action","description":"Search for Zapier actions by app, ordered by relevancy.","openapi":"get /api/v2/apps/{app}/actions/","href":"/ai-actions/how-tos/action-info/find-action"},{"title":"Choose authentication","description":"Get list of Zapier authentications associated with the requesting user and account.","openapi":"get /api/v2/apps/{app}/auths/","href":"/ai-actions/how-tos/action-info/choose-auth"},{"title":"Get action details and needs","description":"Get details of a specific action, including its needs, gives, and a sample of the action.","openapi":"post /api/v2/apps/{app}/actions/{action}/","href":"/ai-actions/how-tos/action-info/action-details"},{"title":"Get prefill choices","description":"Get prefill choices for an app's prefill.","openapi":"post /api/v2/apps/{app}/choices/{prefill}/","href":"/ai-actions/how-tos/action-info/prefill-choices"}]}]},{"group":"API Reference","pages":[{"group":"system","pages":[{"title":"App Health Check","description":"Check that the app is up and running.","openapi":"get /api/v2/health/","href":"/ai-actions/api-reference/system/app-health-check"}]},{"group":"auth","pages":[{"title":"Check User Auth","description":"Test that the API and auth are working.","openapi":"get /api/v2/auth/check/","href":"/ai-actions/api-reference/auth/check-user-auth"},{"title":"Get Account List","description":"Get a list of Zapier accounts for the current user.","openapi":"get /api/v2/auth/accounts/","href":"/ai-actions/api-reference/auth/get-account-list"},{"title":"Get User Login Link","description":"This will create a link that can be used for \"quick account creation\" for a user.\n\nWhen going to this link, if the provided email already has a Zapier account, the user will be asked to log in.\nIf the email does not have a Zapier account, the user will be asked to create an account with the provided email and name.\n\nUpon creating an account or logging in, the user will be taken to the `redirect_to` URL.\n\nA suggested flow for this is:\n- Check if you have an AI Actions OAuth token for a user\n- If you do not, send the user to a page on your site for initiating PKCE OAuth flow, storing the `code_verifier` for them securely.\n- Use this endpoint, with a `redirect_to` of `https://actions.zapier.com/oauth/authorize/` with the following query parameters:\n - client_id: Your AI Actions OAuth client ID\n - scope: `openid nla:exposed_actions:execute`\n - response_type: `code`\n - redirect_uri: The URL on your site that will handle the OAuth callback, must be in the list of allowed redirect URIs for your AI Actions OAuth client.\n - code_challenge: The SHA256 hash of the `code_verifier` from the previous step.\n - code_challenge_method: `S256`\n\nThe user will get a Zapier account, be brought to AI Actions where they will see the OAuth consent screen, and then will be brought back to your site\nwith an OAuth `code` that can be used with `https://actions.zapier.com/oauth/token/` with the following data in the body with `Content-Type: application/x-www-form-urlencoded`:\n - client_id: Your AI Actions OAuth client ID\n - grant_type: `authorization_code`\n - code_verifier: The verifier stored for your user when generating the login URL\n - redirect_uri: The same URL you used for the `redirect_uri` in the previous step.\n - code: The code in the query parameters of the URL that the user was redirected to.","openapi":"get /api/v2/auth/login-link/","href":"/ai-actions/api-reference/auth/get-user-login-link"},{"title":"Get Oauth Login Link","description":"This will create a link that can be used for \"quick account creation\" followed by OAuth login for a user.\n\nWhen going to this link, if the provided email already has a Zapier account, the user will be asked to log in.\nIf the email does not have a Zapier account, the user will be asked to create an account with the provided email and name.\n\nUpon creating an account or logging in, the user will be taken to\n\nThe user will get a Zapier account, be brought to AI Actions where they will see the OAuth consent screen, and then will be brought back to your site\nwith an OAuth `code` that can be used with `https://actions.zapier.com/oauth/token/` with the following data in the body with `Content-Type: application/x-www-form-urlencoded`:\n - client_id: Your AI Actions OAuth client ID\n - grant_type: `authorization_code`\n - code_verifier: The verifier stored for your user when generating the login URL\n - redirect_uri: The same URL you used for the `redirect_uri` in the previous step.\n - code: The code in the query parameters of the URL that the user was redirected to.","openapi":"get /api/v2/auth/oauth-login-link/","href":"/ai-actions/api-reference/auth/get-oauth-login-link"}]},{"group":"apps","pages":[{"title":"Search Apps","description":"Search through all Zapier apps.","openapi":"get /api/v2/apps/search/","href":"/ai-actions/api-reference/apps/search-apps"},{"title":"Get App Details","description":null,"openapi":"get /api/v2/apps/{app}/","href":"/ai-actions/api-reference/apps/get-app-details"},{"title":"List Authentications For App","description":"Get list of Zapier authentications associated with the requesting user and account.","openapi":"get /api/v2/apps/{app}/auths/","href":"/ai-actions/api-reference/apps/list-authentications-for-app"}]},{"group":"actions","pages":[{"title":"Search Actions","description":"Search for Zapier actions by app, ordered by relevancy.","openapi":"get /api/v2/apps/{app}/actions/","href":"/ai-actions/api-reference/actions/search-actions"},{"title":"Get Action Details","description":"Get details of a specific action, including its needs, gives, and a sample of the action.","openapi":"post /api/v2/apps/{app}/actions/{action}/","href":"/ai-actions/api-reference/actions/get-action-details"},{"title":"Get Prefill Choices","description":"Get prefill choices for an app's prefill.","openapi":"post /api/v2/apps/{app}/choices/{prefill}/","href":"/ai-actions/api-reference/actions/get-prefill-choices"}]},{"group":"execution","pages":[{"title":"Execute Stateless AI Action","description":null,"openapi":"post /api/v2/execute/","href":"/ai-actions/api-reference/execution/execute-stateless-ai-action"},{"title":"Execute Stored AI Action","description":"Given an action ID and instructions, this will execute the action and return the results.","openapi":"post /api/v2/ai-actions/{ai_action_id}/execute/","href":"/ai-actions/api-reference/execution/execute-stored-ai-action"},{"title":"Preview Stored AI Action","description":null,"openapi":"post /api/v2/ai-actions/{ai_action_id}/preview/","href":"/ai-actions/api-reference/execution/preview-stored-ai-action"},{"title":"Rate Execution Log","description":"Rate a specific execution log given feedback from the user.\n\nRating should either be `-1` (bad, thumbs down), `0` (neutral, the default), or `1` (good, thumbs up).\n\nYou can also provide plain text feedback provided by the user. Supplied rating/feedback are patched onto execution log, so you can progressively call this endpoint.","openapi":"post /api/v2/execute/log/{execution_log_id}/rate/","href":"/ai-actions/api-reference/execution/rate-execution-log"}]},{"group":"ai-actions","pages":[{"title":"List AI Actions","description":"List all the current actions for the current user.","openapi":"get /api/v2/ai-actions/","href":"/ai-actions/api-reference/ai-actions/list-ai-actions"},{"title":"Create AI Action","description":"Create a new AI Action that can be executed by the user later.","openapi":"post /api/v2/ai-actions/","href":"/ai-actions/api-reference/ai-actions/create-ai-action"},{"title":"Get AI Action","description":"Get the details of a specific AI Action.","openapi":"get /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/api-reference/ai-actions/get-ai-action"},{"title":"Update AI Action","description":"Update an existing AI Action.","openapi":"put /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/api-reference/ai-actions/update-ai-action"},{"title":"Delete AI Action","description":"Delete an AI Action.\n\nReturns `true` if the action was deleted, `false` if it was not found.","openapi":"delete /api/v2/ai-actions/{ai_action_id}/","href":"/ai-actions/api-reference/ai-actions/delete-ai-action"}]},{"group":"utilities","pages":[{"title":"Guess Actions","description":null,"openapi":"post /api/v2/guess-actions/","href":"/ai-actions/api-reference/utilities/guess-actions"},{"title":"Shrink Result","description":"**WARNING: This endpoint is not officially supported, and is subject to be changed or removed at any time.**\n\nShrinks the given result payload to git into a specified token budget.\n\nThis tries its best to keep around more important values and truncate less important ones.\n\nThe intent of this endpoint is that after executing an AI Action, you can pass the result into this to get a smaller result that can be passed in to LLMs without hitting the token limit.","openapi":"post /api/v2/shrink-result/","href":"/ai-actions/api-reference/utilities/shrink-result"}]}]},{"group":"Tools","pages":[{"title":"Stateless action creator/runner","description":null,"href":"/ai-actions/tools/stateless-action"}]},{"group":"Libraries","pages":[{"group":"TypeScript (Node.js, Deno)","icon":"node-js","pages":[{"title":"Getting started","description":null,"href":"/ai-actions/libraries/nodejs/getting-started"},{"title":"Authentication","description":null,"href":"/ai-actions/libraries/nodejs/authentication"},{"title":"Usage examples","description":null,"href":"/ai-actions/libraries/nodejs/usage"},{"title":"Next.js","description":null,"href":"/ai-actions/libraries/nodejs/nextjs-reccommendation"}]},{"group":"React Components","icon":"react","pages":[{"title":"Getting started","description":null,"href":"/ai-actions/libraries/react/getting-started"},{"group":"Components","pages":[{"title":"AiActionsProvider","description":null,"href":"/ai-actions/libraries/react/ai-actions-provider"},{"title":"ActionList","description":null,"href":"/ai-actions/libraries/react/action-list"},{"title":"EditAction and CreateAction","description":null,"href":"/ai-actions/libraries/react/edit-action"},{"title":"StatelessActionCreator","description":null,"href":"/ai-actions/libraries/react/stateless-creator"}]}]}]},{"group":"Development Resources","pages":[{"title":"OpenAPI Specification","description":null,"url":"https://actions.zapier.com/api/v2/openapi.json","href":"/ai-actions/developer-resources/openapi"},{"title":"API Key","description":null,"url":"https://actions.zapier.com/credentials/","href":"/ai-actions/developer-resources/keys"},{"title":"API Logs","description":null,"url":"https://actions.zapier.com/logs/","href":"/ai-actions/developer-resources/logs"}]},{"group":"Help","pages":[{"title":"Join our Community","description":null,"url":"https://zapier.com/early-access","href":"/ai-actions/help/community"},{"title":"Submit an issue","description":null,"url":"https://nla.zapier.app/_z/embed/page/clh5sdteo0001ml0pdz8a2aqr?\u0026","href":"/ai-actions/help/bug"}]}]}]},"pageMetadata":{"title":"Welcome","description":null,"path":"/","href":"/platform/home"},"mintConfig":{"layout":"topnav","sidebar":{"items":"container"},"topbar":{"style":"default"},"search":{"location":"top"},"rounded":"default","codeBlock":{"mode":"dark"},"topbarCtaButton":{"name":"Sign Up","url":"https://zapier.com/sign-up","style":"pill","arrow":false},"$schema":"https://mintlify.com/schema.json","name":"Zapier","logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/dark.svg"},"favicon":"/favicon.png","openapi":["https://actions.zapier.com/api/v2/openapi.json"],"colors":{"primary":"#FF4F00","light":"#FE6C2A","dark":"#FF4F00","anchors":{"from":"#ff4f00","to":"#FE6C2A"}},"topbarLinks":[{"url":"https://zapier.com/platform/login","name":"Developer Platform Login","_id":"67abccd35460d958c1f7a291"},{"url":"platform/reference/cli-docs","name":"Platform CLI","_id":"67abccd35460d958c1f7a292"}],"navigation":[{"group":"","pages":["platform/home","platform/dev-platform-login"]},{"group":"Quick start","pages":["platform/quickstart/build-integration",{"group":"Developer tools","pages":["platform/quickstart/ui-vs-cli","platform/quickstart/ui-tutorial","platform/quickstart/cli-tutorial","platform/quickstart/get-help"]},{"group":"Glossary","pages":["platform/quickstart/glossary"]},{"group":"How it works","pages":["platform/quickstart/how-zapier-works","platform/quickstart/zapier-integration-structure","platform/quickstart/private-vs-public-integrations"]},"platform/quickstart/recommended-triggers-and-actions","platform/quickstart/trusted-developers"]},{"group":"Build with UI","pages":["platform/quickstart/ui-tutorial",{"group":"Actions","pages":["platform/build/action","platform/build/create","platform/build/search","platform/build/reorder-action","platform/build/search-or-create"]},{"group":"Advanced features","pages":["platform/build/env","platform/build/errors","platform/build/bundle","platform/build/code-mode","platform/build/hydration-cli","platform/build/static-ip"]},{"group":"Authentication","pages":["platform/build/auth","platform/build/apikeyauth","platform/build/basicauth","platform/build/digestauth","platform/build/oauth","platform/build/sessionauth","platform/build/connection-label","platform/build/computed-fields","platform/build/computed-test-field","platform/build/requesttemplate","platform/build/subdomain-validation"]},{"group":"Input Fields","pages":["platform/build/field-definitions","platform/build/add-fields","platform/build/dynamic-field","platform/build/line-items","platform/build/search-powered-fields"]},{"group":"Output Fields","pages":["platform/build/sample-data","platform/build/response-types"]},{"group":"Testing","pages":["platform/build/test-auth","platform/build/test-triggers-actions","platform/build/test-tools","platform/build/test-monitoring"]},{"group":"Triggers","pages":["platform/build/trigger","platform/build/polling-trigger","platform/build/hook-trigger","platform/build/reorder-trigger","platform/build/deduplication","platform/build/pagination-trigger","platform/build/cli-hook-trigger"]},{"group":"Troubleshooting","pages":["platform/build/operating-constraints","platform/build/troubleshoot-trigger-timeouts","platform/build/troubleshoot-trigger-payload","platform/build/troubleshoot-action-timeouts","platform/build/troubleshoot-action-payload","platform/build/troubleshoot-custom-fields","platform/build/reduce-api-requests","platform/build/troubleshoot-throttles","platform/build/hydration-limits","platform/build/error-array-expected","platform/build/error-non-object","platform/build/error-non-object-array"]},"platform/build/form-mode"]},{"group":"Build with CLI","pages":["platform/build-cli/overview",{"group":"Features","pages":[{"group":"Input Fields","pages":["platform/build-cli/input-fields","platform/build/field-definitions","platform/build-cli/dynamic-dropdowns"]}]},"platform/quickstart/cli-tutorial","platform/build-cli/faqs","platform/build-cli/core","platform/reference/cli","platform/reference/schema"]},{"group":"Manage","pages":[{"group":"Account and team","pages":["platform/manage/add-team"]},{"group":"Integration changes","pages":["platform/manage/planning-changes","platform/manage/auth-scheme","platform/manage/auth-required","platform/manage/auth-keys","platform/manage/change-keys","platform/manage/required-input","platform/manage/input-key","platform/manage/output-key","platform/manage/output","platform/manage/change-trigger","platform/manage/change-perform","platform/manage/change-api","platform/manage/export-cli","platform/manage/export-ui","platform/manage/essential-tips-iq"]},{"group":"Integration performance","pages":["platform/manage/api-outage","platform/manage/embed-insights","platform/manage/user-feedback","platform/manage/error-handling","platform/manage/active-users","platform/manage/integration-insights","platform/manage/zap-activation","platform/manage/embed-activation"]},{"group":"Sharing","pages":["platform/manage/sharing"]},{"group":"Versions","pages":["platform/manage/versions","platform/manage/clone","platform/manage/promote","platform/manage/migrate","platform/manage/deprecate","platform/manage/versions-legacy"]},"platform/manage/branding-cli"]},{"group":"Publish","pages":[{"group":"Branding","pages":["platform/publish/branding-guidelines","platform/publish/add-or-modify-branding"]},{"group":"Launch process","pages":["platform/publish/public-integration","platform/publish/integration-build-guidelines","platform/publish/integration-publishing-requirements","platform/publish/zap-templates","platform/publish/user-help","platform/publish/best-practices","platform/publish/zps"]},{"group":"Partner program","pages":["platform/publish/partner-program","platform/publish/partner-faq","platform/publish/benefits-guide"]},{"group":"Validation","pages":["platform/publish/integration-checks-reference"]}]},{"group":"Embed","pages":["platform/embed/partner-solutions"]},{"group":"Reference","pages":[{"group":"Use cases","pages":["platform/reference/forms-app","platform/reference/crm-app","platform/reference/project-app","platform/reference/ai-app"]},"platform/reference/transfer","platform/reference/ai-actions","platform/reference/custom-actions-api-requests","platform/reference/legacy-scripting","platform/reference/changelog","platform/reference/cli","platform/reference/schema"]},{"group":"Welcome","pages":["partner-solutions/getting-started"]},{"group":"Workflow API","pages":["partner-solutions/workflow-api/intro",{"group":"Building a Workflow","pages":["partner-solutions/workflow-api/Building-a-Zap","partner-solutions/workflow-api/Fields-and-Fieldsets","partner-solutions/workflow-api/Selecting-an-Action","partner-solutions/workflow-api/Selecting-an-Authentication",{"group":"Custom Flows","pages":["partner-solutions/workflow-api/testing-a-step","partner-solutions/workflow-api/Hardcoding-an-Action","partner-solutions/workflow-api/adding-an-authentication"]},"partner-solutions/workflow-api/limitations"]},"partner-solutions/workflow-api/list-apps","partner-solutions/workflow-api/list-zaps","partner-solutions/workflow-api/list-zap-templates","partner-solutions/workflow-api/embed-zap-editor"]},{"group":"Workflow Element","pages":["partner-solutions/workflow-element/intro","partner-solutions/elements-security","partner-solutions/embed-insights"]},{"group":"Embed Enhancements","pages":["partner-solutions/pre-filled-zaps","partner-solutions/quick-account-creation"]},{"group":"Getting Started With the API","pages":["partner-solutions/api-reference/authentication","partner-solutions/api-reference/rate-limiting"]},{"group":"Apps","pages":["partner-solutions/api-reference/apps/get-apps-[v1]","partner-solutions/api-reference/apps/get-apps-[v2]"]},{"group":"Categories","pages":["partner-solutions/api-reference/categories/get-categories"]},{"group":"Accounts","pages":["partner-solutions/api-reference/accounts/user-profile","partner-solutions/api-reference/accounts/create-account"]},{"group":"Zap Templates","pages":["partner-solutions/api-reference/zap-templates/get-zap-templates"]},{"group":"Zaps","pages":["partner-solutions/api-reference/zaps/get-zaps-[v1]","partner-solutions/api-reference/zaps/guess-a-zap","partner-solutions/api-reference/zaps/get-zaps-[v2]","partner-solutions/api-reference/zaps/create-a-zap"]},{"group":"Actions","pages":["partner-solutions/api-reference/actions/get-actions","partner-solutions/api-reference/actions/get-input-fields","partner-solutions/api-reference/actions/get-choices","partner-solutions/api-reference/actions/get-output-fields","partner-solutions/api-reference/actions/step-test"]},{"group":"Authentications","pages":["partner-solutions/api-reference/authentications/get-authentications","partner-solutions/api-reference/authentications/create-authentication"]},{"group":"Experimental","pages":["partner-solutions/api-reference/experimental/create-a-workflow-step"]},{"group":"Schemas","pages":[{"group":"Common Types","pages":["partner-solutions/api-reference/common-types/action","partner-solutions/api-reference/common-types/app","partner-solutions/api-reference/common-types/authentication","partner-solutions/api-reference/common-types/choice","partner-solutions/api-reference/common-types/fieldset","partner-solutions/api-reference/common-types/infoField","partner-solutions/api-reference/common-types/inputField","partner-solutions/api-reference/common-types/outputField","partner-solutions/api-reference/common-types/zap","partner-solutions/api-reference/common-types/errors","partner-solutions/api-reference/common-types/pagination","partner-solutions/api-reference/common-types/requests","partner-solutions/api-reference/common-types/responses"]}]},{"group":"Getting Started","pages":["ai-actions/intro","ai-actions/quickstart"]},{"group":"How to","pages":["ai-actions/how-tos/auth","ai-actions/how-tos/account-list","ai-actions/how-tos/stateless-vs-stored",{"group":"Stored actions","pages":["ai-actions/how-tos/stored/intro","ai-actions/how-tos/stored/action-configuration","ai-actions/how-tos/stored/list-actions","ai-actions/how-tos/stored/run-stored-action",{"group":"Manage stored actions","pages":["ai-actions/how-tos/stored/manage/get-action","ai-actions/how-tos/stored/manage/create-action","ai-actions/how-tos/stored/manage/update-action","ai-actions/how-tos/stored/manage/delete-action"]}]},{"group":"Stateless actions","pages":["ai-actions/how-tos/stateless/intro","ai-actions/how-tos/stateless/run-stateless-action"]},{"group":"Gathering action information","pages":["ai-actions/how-tos/action-info/introduction","ai-actions/how-tos/action-info/find-app","ai-actions/how-tos/action-info/find-action","ai-actions/how-tos/action-info/choose-auth","ai-actions/how-tos/action-info/action-details","ai-actions/how-tos/action-info/prefill-choices"]}]},{"group":"API Reference","pages":[{"group":"system","pages":["ai-actions/api-reference/system/app-health-check"]},{"group":"auth","pages":["ai-actions/api-reference/auth/check-user-auth","ai-actions/api-reference/auth/get-account-list","ai-actions/api-reference/auth/get-user-login-link","ai-actions/api-reference/auth/get-oauth-login-link"]},{"group":"apps","pages":["ai-actions/api-reference/apps/search-apps","ai-actions/api-reference/apps/get-app-details","ai-actions/api-reference/apps/list-authentications-for-app"]},{"group":"actions","pages":["ai-actions/api-reference/actions/search-actions","ai-actions/api-reference/actions/get-action-details","ai-actions/api-reference/actions/get-prefill-choices"]},{"group":"execution","pages":["ai-actions/api-reference/execution/execute-stateless-ai-action","ai-actions/api-reference/execution/execute-stored-ai-action","ai-actions/api-reference/execution/preview-stored-ai-action","ai-actions/api-reference/execution/rate-execution-log"]},{"group":"ai-actions","pages":["ai-actions/api-reference/ai-actions/list-ai-actions","ai-actions/api-reference/ai-actions/create-ai-action","ai-actions/api-reference/ai-actions/get-ai-action","ai-actions/api-reference/ai-actions/update-ai-action","ai-actions/api-reference/ai-actions/delete-ai-action"]},{"group":"utilities","pages":["ai-actions/api-reference/utilities/guess-actions","ai-actions/api-reference/utilities/shrink-result"]}]},{"group":"Tools","pages":["ai-actions/tools/stateless-action"]},{"group":"Libraries","pages":[{"group":"TypeScript (Node.js, Deno)","icon":"node-js","pages":["ai-actions/libraries/nodejs/getting-started","ai-actions/libraries/nodejs/authentication","ai-actions/libraries/nodejs/usage","ai-actions/libraries/nodejs/nextjs-reccommendation"]},{"group":"React Components","icon":"react","pages":["ai-actions/libraries/react/getting-started",{"group":"Components","pages":["ai-actions/libraries/react/ai-actions-provider","ai-actions/libraries/react/action-list","ai-actions/libraries/react/edit-action","ai-actions/libraries/react/stateless-creator"]}]}]},{"group":"Development Resources","pages":["ai-actions/developer-resources/openapi","ai-actions/developer-resources/keys","ai-actions/developer-resources/logs"]},{"group":"Help","pages":["ai-actions/help/community","ai-actions/help/bug"]},{"group":"Apps","pages":["partner-solutions/apps/get-apps-[v1]","partner-solutions/apps/get-apps-[v2]"]},{"group":"Categories","pages":["partner-solutions/categories/get-categories"]},{"group":"Accounts","pages":["partner-solutions/accounts/user-profile","partner-solutions/accounts/create-account"]},{"group":"Zap Templates","pages":["partner-solutions/zap-templates/get-zap-templates"]},{"group":"Zaps","pages":["partner-solutions/zaps/get-zaps-[v1]","partner-solutions/zaps/guess-a-zap-[beta]","partner-solutions/zaps/get-zaps-[v2]","partner-solutions/zaps/create-a-zap"]},{"group":"Actions","pages":["partner-solutions/actions/get-actions","partner-solutions/actions/get-input-fields","partner-solutions/actions/get-choices","partner-solutions/actions/get-output-fields","partner-solutions/actions/step-test"]},{"group":"Authentications","pages":["partner-solutions/authentications/get-authentications","partner-solutions/authentications/create-authentication"]},{"group":"Experimental","pages":["partner-solutions/experimental/create-a-workflow-step","partner-solutions/experimental/get-zap-runs"]}],"primaryTab":{"name":"Home"},"anchors":[{"name":"Community","url":"https://community.zapier.com/","icon":"users","_id":"67abccd35460d958c1f7a28e"},{"name":"Blog","url":"https://zapier.com/blog/","icon":"newspaper","_id":"67abccd35460d958c1f7a28f"},{"name":"Contact Us","url":"https://developer.zapier.com/contact","icon":"envelope","_id":"67abccd35460d958c1f7a290"}],"tabs":[{"name":"Home","url":"/","_id":"67abccd35460d958c1f7a28a"},{"name":"Developer Platform","url":"platform/","_id":"67abccd35460d958c1f7a28b"},{"name":"Partner Solutions","url":"partner-solutions/","_id":"67abccd35460d958c1f7a28c","openapi":"https://api.zapier.com/schema"},{"name":"AI Actions","url":"ai-actions/","_id":"67abccd35460d958c1f7a28d"}],"background":{"style":"windows"},"isWhiteLabeled":true,"redirects":[{"destination":"/platform/build-cli/overview","source":"/platform/reference/cli-docs","_id":"67abccd35460d958c1f7a287"},{"destination":"/platform/build-cli/dynamic-dropdowns","source":"/platform/build/dynamic-dropdowns","_id":"67abccd35460d958c1f7a288"},{"destination":"/platform/build-cli/dynamic-dropdowns","source":"/platform/build/search-powered-fields","_id":"67abccd35460d958c1f7a289"}],"footerSocials":{"facebook":"http://www.facebook.com/ZapierApp?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier","linkedin":"https://www.linkedin.com/company/zapier/?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier","x":"https://twitter.com/zapier?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier#!/zapier","youtube":"https://www.youtube.com/user/ZapierApp/videos?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier"}},"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Zapier","colors":{"primary":"#FF4F00","light":"#FE6C2A","dark":"#FF4F00"},"favicon":"/favicon.png","navigation":{"tabs":[{"tab":"Developer Platform","groups":[{"group":"","pages":["platform/home","platform/dev-platform-login"]},{"group":"Quick start","pages":["platform/quickstart/build-integration",{"group":"Developer tools","pages":["platform/quickstart/ui-vs-cli","platform/quickstart/ui-tutorial","platform/quickstart/cli-tutorial","platform/quickstart/get-help"]},{"group":"Glossary","pages":["platform/quickstart/glossary"]},{"group":"How it works","pages":["platform/quickstart/how-zapier-works","platform/quickstart/zapier-integration-structure","platform/quickstart/private-vs-public-integrations"]},"platform/quickstart/recommended-triggers-and-actions","platform/quickstart/trusted-developers"]},{"group":"Build with UI","pages":["platform/quickstart/ui-tutorial",{"group":"Actions","pages":["platform/build/action","platform/build/create","platform/build/search","platform/build/reorder-action","platform/build/search-or-create"]},{"group":"Advanced features","pages":["platform/build/env","platform/build/errors","platform/build/bundle","platform/build/code-mode","platform/build/hydration-cli","platform/build/static-ip"]},{"group":"Authentication","pages":["platform/build/auth","platform/build/apikeyauth","platform/build/basicauth","platform/build/digestauth","platform/build/oauth","platform/build/sessionauth","platform/build/connection-label","platform/build/computed-fields","platform/build/computed-test-field","platform/build/requesttemplate","platform/build/subdomain-validation"]},{"group":"Input Fields","pages":["platform/build/field-definitions","platform/build/add-fields","platform/build/dynamic-field","platform/build/line-items","platform/build/search-powered-fields"]},{"group":"Output Fields","pages":["platform/build/sample-data","platform/build/response-types"]},{"group":"Testing","pages":["platform/build/test-auth","platform/build/test-triggers-actions","platform/build/test-tools","platform/build/test-monitoring"]},{"group":"Triggers","pages":["platform/build/trigger","platform/build/polling-trigger","platform/build/hook-trigger","platform/build/reorder-trigger","platform/build/deduplication","platform/build/pagination-trigger","platform/build/cli-hook-trigger"]},{"group":"Troubleshooting","pages":["platform/build/operating-constraints","platform/build/troubleshoot-trigger-timeouts","platform/build/troubleshoot-trigger-payload","platform/build/troubleshoot-action-timeouts","platform/build/troubleshoot-action-payload","platform/build/troubleshoot-custom-fields","platform/build/reduce-api-requests","platform/build/troubleshoot-throttles","platform/build/hydration-limits","platform/build/error-array-expected","platform/build/error-non-object","platform/build/error-non-object-array"]},"platform/build/form-mode"]},{"group":"Build with CLI","pages":["platform/build-cli/overview",{"group":"Features","pages":[{"group":"Input Fields","pages":["platform/build-cli/input-fields","platform/build/field-definitions","platform/build-cli/dynamic-dropdowns"]}]},"platform/quickstart/cli-tutorial","platform/build-cli/faqs","platform/build-cli/core","platform/reference/cli","platform/reference/schema"]},{"group":"Manage","pages":[{"group":"Account and team","pages":["platform/manage/add-team"]},{"group":"Integration changes","pages":["platform/manage/planning-changes","platform/manage/auth-scheme","platform/manage/auth-required","platform/manage/auth-keys","platform/manage/change-keys","platform/manage/required-input","platform/manage/input-key","platform/manage/output-key","platform/manage/output","platform/manage/change-trigger","platform/manage/change-perform","platform/manage/change-api","platform/manage/export-cli","platform/manage/export-ui","platform/manage/essential-tips-iq"]},{"group":"Integration performance","pages":["platform/manage/api-outage","platform/manage/embed-insights","platform/manage/user-feedback","platform/manage/error-handling","platform/manage/active-users","platform/manage/integration-insights","platform/manage/zap-activation","platform/manage/embed-activation"]},{"group":"Sharing","pages":["platform/manage/sharing"]},{"group":"Versions","pages":["platform/manage/versions","platform/manage/clone","platform/manage/promote","platform/manage/migrate","platform/manage/deprecate","platform/manage/versions-legacy"]},"platform/manage/branding-cli"]},{"group":"Publish","pages":[{"group":"Branding","pages":["platform/publish/branding-guidelines","platform/publish/add-or-modify-branding"]},{"group":"Launch process","pages":["platform/publish/public-integration","platform/publish/integration-build-guidelines","platform/publish/integration-publishing-requirements","platform/publish/zap-templates","platform/publish/user-help","platform/publish/best-practices","platform/publish/zps"]},{"group":"Partner program","pages":["platform/publish/partner-program","platform/publish/partner-faq","platform/publish/benefits-guide"]},{"group":"Validation","pages":["platform/publish/integration-checks-reference"]}]},{"group":"Embed","pages":["platform/embed/partner-solutions"]},{"group":"Reference","pages":[{"group":"Use cases","pages":["platform/reference/forms-app","platform/reference/crm-app","platform/reference/project-app","platform/reference/ai-app"]},"platform/reference/transfer","platform/reference/ai-actions","platform/reference/custom-actions-api-requests","platform/reference/legacy-scripting","platform/reference/changelog","platform/reference/cli","platform/reference/schema"]}]},{"tab":"Partner Solutions","openapi":{"source":"https://api.zapier.com/schema","directory":"partner-solutions/"},"groups":[{"group":"Welcome","pages":["partner-solutions/getting-started"]},{"group":"Workflow API","pages":["partner-solutions/workflow-api/intro",{"group":"Building a Workflow","pages":["partner-solutions/workflow-api/Building-a-Zap","partner-solutions/workflow-api/Fields-and-Fieldsets","partner-solutions/workflow-api/Selecting-an-Action","partner-solutions/workflow-api/Selecting-an-Authentication",{"group":"Custom Flows","pages":["partner-solutions/workflow-api/testing-a-step","partner-solutions/workflow-api/Hardcoding-an-Action","partner-solutions/workflow-api/adding-an-authentication"]},"partner-solutions/workflow-api/limitations"]},"partner-solutions/workflow-api/list-apps","partner-solutions/workflow-api/list-zaps","partner-solutions/workflow-api/list-zap-templates","partner-solutions/workflow-api/embed-zap-editor"]},{"group":"Workflow Element","pages":["partner-solutions/workflow-element/intro","partner-solutions/elements-security","partner-solutions/embed-insights"]},{"group":"Embed Enhancements","pages":["partner-solutions/pre-filled-zaps","partner-solutions/quick-account-creation"]},{"group":"Getting Started With the API","pages":["partner-solutions/api-reference/authentication","partner-solutions/api-reference/rate-limiting"]},{"group":"Apps","pages":["partner-solutions/api-reference/apps/get-apps-[v1]","partner-solutions/api-reference/apps/get-apps-[v2]"]},{"group":"Categories","pages":["partner-solutions/api-reference/categories/get-categories"]},{"group":"Accounts","pages":["partner-solutions/api-reference/accounts/user-profile","partner-solutions/api-reference/accounts/create-account"]},{"group":"Zap Templates","pages":["partner-solutions/api-reference/zap-templates/get-zap-templates"]},{"group":"Zaps","pages":["partner-solutions/api-reference/zaps/get-zaps-[v1]","partner-solutions/api-reference/zaps/guess-a-zap","partner-solutions/api-reference/zaps/get-zaps-[v2]","partner-solutions/api-reference/zaps/create-a-zap"]},{"group":"Actions","pages":["partner-solutions/api-reference/actions/get-actions","partner-solutions/api-reference/actions/get-input-fields","partner-solutions/api-reference/actions/get-choices","partner-solutions/api-reference/actions/get-output-fields","partner-solutions/api-reference/actions/step-test"]},{"group":"Authentications","pages":["partner-solutions/api-reference/authentications/get-authentications","partner-solutions/api-reference/authentications/create-authentication"]},{"group":"Experimental","pages":["partner-solutions/api-reference/experimental/create-a-workflow-step"]},{"group":"Schemas","pages":[{"group":"Common Types","pages":["partner-solutions/api-reference/common-types/action","partner-solutions/api-reference/common-types/app","partner-solutions/api-reference/common-types/authentication","partner-solutions/api-reference/common-types/choice","partner-solutions/api-reference/common-types/fieldset","partner-solutions/api-reference/common-types/infoField","partner-solutions/api-reference/common-types/inputField","partner-solutions/api-reference/common-types/outputField","partner-solutions/api-reference/common-types/zap","partner-solutions/api-reference/common-types/errors","partner-solutions/api-reference/common-types/pagination","partner-solutions/api-reference/common-types/requests","partner-solutions/api-reference/common-types/responses"]}]},{"group":"Apps","pages":["partner-solutions/apps/get-apps-[v1]","partner-solutions/apps/get-apps-[v2]"]},{"group":"Categories","pages":["partner-solutions/categories/get-categories"]},{"group":"Accounts","pages":["partner-solutions/accounts/user-profile","partner-solutions/accounts/create-account"]},{"group":"Zap Templates","pages":["partner-solutions/zap-templates/get-zap-templates"]},{"group":"Zaps","pages":["partner-solutions/zaps/get-zaps-[v1]","partner-solutions/zaps/guess-a-zap-[beta]","partner-solutions/zaps/get-zaps-[v2]","partner-solutions/zaps/create-a-zap"]},{"group":"Actions","pages":["partner-solutions/actions/get-actions","partner-solutions/actions/get-input-fields","partner-solutions/actions/get-choices","partner-solutions/actions/get-output-fields","partner-solutions/actions/step-test"]},{"group":"Authentications","pages":["partner-solutions/authentications/get-authentications","partner-solutions/authentications/create-authentication"]},{"group":"Experimental","pages":["partner-solutions/experimental/create-a-workflow-step","partner-solutions/experimental/get-zap-runs"]}]},{"tab":"AI Actions","groups":[{"group":"Getting Started","pages":["ai-actions/intro","ai-actions/quickstart"]},{"group":"How to","pages":["ai-actions/how-tos/auth","ai-actions/how-tos/account-list","ai-actions/how-tos/stateless-vs-stored",{"group":"Stored actions","pages":["ai-actions/how-tos/stored/intro","ai-actions/how-tos/stored/action-configuration","ai-actions/how-tos/stored/list-actions","ai-actions/how-tos/stored/run-stored-action",{"group":"Manage stored actions","pages":["ai-actions/how-tos/stored/manage/get-action","ai-actions/how-tos/stored/manage/create-action","ai-actions/how-tos/stored/manage/update-action","ai-actions/how-tos/stored/manage/delete-action"]}]},{"group":"Stateless actions","pages":["ai-actions/how-tos/stateless/intro","ai-actions/how-tos/stateless/run-stateless-action"]},{"group":"Gathering action information","pages":["ai-actions/how-tos/action-info/introduction","ai-actions/how-tos/action-info/find-app","ai-actions/how-tos/action-info/find-action","ai-actions/how-tos/action-info/choose-auth","ai-actions/how-tos/action-info/action-details","ai-actions/how-tos/action-info/prefill-choices"]}]},{"group":"API Reference","pages":[{"group":"system","pages":["ai-actions/api-reference/system/app-health-check"]},{"group":"auth","pages":["ai-actions/api-reference/auth/check-user-auth","ai-actions/api-reference/auth/get-account-list","ai-actions/api-reference/auth/get-user-login-link","ai-actions/api-reference/auth/get-oauth-login-link"]},{"group":"apps","pages":["ai-actions/api-reference/apps/search-apps","ai-actions/api-reference/apps/get-app-details","ai-actions/api-reference/apps/list-authentications-for-app"]},{"group":"actions","pages":["ai-actions/api-reference/actions/search-actions","ai-actions/api-reference/actions/get-action-details","ai-actions/api-reference/actions/get-prefill-choices"]},{"group":"execution","pages":["ai-actions/api-reference/execution/execute-stateless-ai-action","ai-actions/api-reference/execution/execute-stored-ai-action","ai-actions/api-reference/execution/preview-stored-ai-action","ai-actions/api-reference/execution/rate-execution-log"]},{"group":"ai-actions","pages":["ai-actions/api-reference/ai-actions/list-ai-actions","ai-actions/api-reference/ai-actions/create-ai-action","ai-actions/api-reference/ai-actions/get-ai-action","ai-actions/api-reference/ai-actions/update-ai-action","ai-actions/api-reference/ai-actions/delete-ai-action"]},{"group":"utilities","pages":["ai-actions/api-reference/utilities/guess-actions","ai-actions/api-reference/utilities/shrink-result"]}]},{"group":"Tools","pages":["ai-actions/tools/stateless-action"]},{"group":"Libraries","pages":[{"group":"TypeScript (Node.js, Deno)","icon":"node-js","pages":["ai-actions/libraries/nodejs/getting-started","ai-actions/libraries/nodejs/authentication","ai-actions/libraries/nodejs/usage","ai-actions/libraries/nodejs/nextjs-reccommendation"]},{"group":"React Components","icon":"react","pages":["ai-actions/libraries/react/getting-started",{"group":"Components","pages":["ai-actions/libraries/react/ai-actions-provider","ai-actions/libraries/react/action-list","ai-actions/libraries/react/edit-action","ai-actions/libraries/react/stateless-creator"]}]}]},{"group":"Development Resources","pages":["ai-actions/developer-resources/openapi","ai-actions/developer-resources/keys","ai-actions/developer-resources/logs"]},{"group":"Help","pages":["ai-actions/help/community","ai-actions/help/bug"]}]}],"global":{"anchors":[{"anchor":"Community","href":"https://community.zapier.com/","icon":"users"},{"anchor":"Blog","href":"https://zapier.com/blog/","icon":"newspaper"},{"anchor":"Contact Us","href":"https://developer.zapier.com/contact","icon":"envelope"}]}},"logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/dark.svg"},"api":{"openapi":["https://actions.zapier.com/api/v2/openapi.json"]},"background":{"decoration":"windows"},"navbar":{"links":[{"label":"Developer Platform Login","href":"https://zapier.com/platform/login"},{"label":"Platform CLI","href":"platform/reference/cli-docs"}],"primary":{"type":"button","label":"Sign Up","href":"https://zapier.com/sign-up"}},"footer":{"socials":{"facebook":"http://www.facebook.com/ZapierApp?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier","linkedin":"https://www.linkedin.com/company/zapier/?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier","x":"https://twitter.com/zapier?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier#!/zapier","youtube":"https://www.youtube.com/user/ZapierApp/videos?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier"}},"redirects":[{"destination":"/platform/build-cli/overview","source":"/platform/reference/cli-docs","_id":"67abccd35460d958c1f7a287"},{"destination":"/platform/build-cli/dynamic-dropdowns","source":"/platform/build/dynamic-dropdowns","_id":"67abccd35460d958c1f7a288"},{"destination":"/platform/build-cli/dynamic-dropdowns","source":"/platform/build/search-powered-fields","_id":"67abccd35460d958c1f7a289"}]},"apiReferenceData":{}},"favicons":{"icons":[{"rel":"apple-touch-icon","sizes":"180x180","href":"https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/apple-touch-icon.png?v=3","type":"image/png"},{"rel":"icon","sizes":"32x32","href":"https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/favicon-32x32.png?v=3","type":"image/png"},{"rel":"icon","sizes":"16x16","href":"https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/favicon-16x16.png?v=3","type":"image/png"},{"rel":"shortcut icon","href":"https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/favicon.ico?v=3","type":"image/x-icon"}],"browserconfig":"https://mintlify.s3-us-west-1.amazonaws.com/zapier-82f0e938/_generated/favicon/browserconfig.xml?v=3"},"subdomain":"zapier-82f0e938","actualSubdomain":"zapier-82f0e938","internalAnalyticsWriteKey":"phc_TXdpocbGVeZVm5VJmAsHTMrCofBQu3e0kN8HGMNGTVW","trieve":{"chatEnabled":true,"datasetId":"514c61e8-45d3-48bf-bb56-a169d0427c86"},"shouldIndex":true,"org":{"plan":"enterprise","createdAt":"2024-02-01T16:24:34.652Z"},"cssFiles":[{"_id":"670019a01caa3b49d1d561fc","filePath":"styles.css","subdomain":"zapier-82f0e938","__v":0,"content":"@font-face {\n font-family: \"Degular Display - Semibold\";\n src: url('https://fonts.zapier.com/Degular/DegularDisplay-Semibold.woff2');\n font-display: fallback;\n font-weight: 400;\n}\n\nh1,h2,h3,h4{\n font-family: \"Degular Display - Semibold\";\n letter-spacing: 1px !important ;\n}\n"},{"_id":"6717c6508955a5ff0edda91e","filePath":"index.css","subdomain":"zapier-82f0e938","__v":0,"content":".hero-container {\n display: flex;\n flex-direction: row;\n /* flex-wrap: wrap; */\n align-items: center;\n justify-content: center;\n text-align: left;\n padding: 6rem 2rem;\n width: 80%;\n border-bottom: 2px solid #FF4F00;\n margin: 0 auto;\n}\n.hero-text {\n width: 600px;\n margin-right: 2rem;\n}\n@media screen and (max-width: 1300px) {\n .hero-container {\n flex-direction: column;\n text-align: center;\n }\n .hero-text {\n margin-right: 0rem;\n /* Added margin to separate text from image for small screens */\n margin-bottom: 2rem;\n }\n .hero-video {\n max-width: 600px;\n }\n}\n"}],"jsFiles":[{"_id":"67127e659c32b795362d077b","filePath":"content/welcome.js","subdomain":"zapier-82f0e938","__v":0,"content":"console.info(\n '%cDig into the Zapier Docs!',\n 'font-weight: bold; font-size: 1rem; text-shadow: #474747 2px 2px 2px, 2px 1px 1px rgba(255,79,0,0); color: #FFFFFF; background: #FF4F00; padding: 5px; border: 1px solid #ffffff; border-radius: 2px;'\n);\n\nfunction replaceWithLogoutNav(name) {\n const loginLinkNode =\n document.querySelector('a[href=\"https://zapier.com/platform/login\"]');\n\n const ul = loginLinkNode.closest('ul');\n\n const liName = document.createElement('li');\n liName.appendChild(document.createTextNode(name));\n\n const liLogout = document.createElement('li');\n liLogout.setAttribute('class', 'whitespace-nowrap hidden lg:flex');\n liLogout.setAttribute('id', 'topbar-cta-button');\n\n const aLogout = document.createElement('a');\n aLogout.setAttribute('href', 'https://zapier.com/logout');\n aLogout.setAttribute('target', '_blank');\n aLogout.setAttribute('class', 'group px-4 py-1.5 relative inline-flex items-center text-sm font-medium');\n\n const spanFrame = document.createElement('span');\n spanFrame.setAttribute('class', 'absolute inset-0 bg-primary-dark dark:bg-primary-light/10 border-primary-light/30 rounded-full dark:border group-hover:opacity-[0.9] dark:group-hover:border-primary-light/60');\n\n const divLogout = document.createElement('div');\n divLogout.setAttribute('class', 'mr-0.5 space-x-2.5 flex items-center');\n\n const spanLogout = document.createElement('span');\n spanLogout.setAttribute('class', 'z-10 text-white dark:text-primary-light');\n spanLogout.appendChild(document.createTextNode('Logout'))\n\n aLogout.appendChild(spanFrame);\n divLogout.appendChild(spanLogout)\n aLogout.appendChild(divLogout)\n liLogout.appendChild(aLogout);\n ul.replaceChildren(liName, liLogout);\n}\n\nfetch('https://zapier.com/api/v4/session', {credentials: 'include'})\n .then(function (response) {\n return response.json();\n })\n .then(function (session) {\n console.info({ session });\n\n const {\n first_name: name,\n is_logged_in: isLoggedIn,\n // photo_url: photoUrl,\n } = session;\n\n if (!isLoggedIn) {\n return;\n }\n\n replaceWithLogoutNav(name);\n });\n"}],"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {Heading} = _components;\n if (!Heading) _missingMdxReference(\"Heading\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(Heading, {\n level: \"3\",\n id: \"explore-our-guides-and-start-building-a-zapier-integration-today\",\n children: \"Explore our guides and start building a Zapier integration today\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Welcome to the Zapier Developer Platform documentation! Whether you are a new or experienced integration builder, this is your go-to resource for learning how to create and manage powerful apps on the Zapier platform.\"\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"what-you-ll-find-here\",\n children: \"What You’ll Find Here\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Getting Started\"\n }), \": Learn the basics of building integrations, from understanding Zapier’s architecture to setting up your first app using the \", _jsx(_components.strong, {\n children: \"Visual Builder\"\n }), \" or \", _jsx(_components.strong, {\n children: \"CLI\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Visual Builder Guide\"\n }), \": If you’re looking for a fast, no-code way to integrate your app with Zapier, the Visual Builder is the place to start. It’s ideal for quick deployment and collaboration across teams, even without developer expertise.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"CLI Guide\"\n }), \": For more complex needs, dive into the \", _jsx(_components.strong, {\n children: \"Zapier CLI\"\n }), \", which gives developers full control over the integration process, using custom code to handle authentication, triggers, actions, and searches.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Best Practices\"\n }), \": Guidance on how to optimize your integrations for performance, user experience, and maintainability.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Advanced Features\"\n }), \": Explore OAuth authentication, dynamic dropdowns, and other advanced options to provide a more customized experience in your integration.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Deployment and Testing\"\n }), \": Once your integration is ready, follow the steps for deploying, testing, and promoting your app version to Zapier’s marketplace of over 1 million users.\"]\n }), \"\\n\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"why-build-on-zapier\",\n children: \"Why Build on Zapier?\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Reach Millions of Users\"\n }), \": By integrating with Zapier, your app becomes part of a thriving ecosystem that connects with thousands of other services.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Save Time with Automation\"\n }), \": Zapier simplifies repetitive tasks, letting your users focus on what matters most by automating workflows across tools.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Fast and Flexible\"\n }), \": Use the Visual Builder for quick, no-code setups or the CLI for full control and customization.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"quick-links\",\n children: \"Quick Links\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://zapier.com/resources/guides/quick-start\",\n children: \"Getting Started Tutorial\"\n })\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://developer.zapier.com/\",\n children: \"Zapier Developer Platform\"\n })\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://docs.zapier.com/platform/reference/cli-docs\",\n children: \"CLI Documentation\"\n })\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Ready to dive in? Choose your path—start building with the Visual Builder or master the CLI for complete customization.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{"config":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Zapier","colors":{"primary":"#FF4F00","light":"#FE6C2A","dark":"#FF4F00"},"favicon":"/favicon.png","navigation":{"tabs":[{"tab":"Developer Platform","groups":[{"group":"","pages":["platform/home","platform/dev-platform-login"]},{"group":"Quick start","pages":["platform/quickstart/build-integration",{"group":"Developer tools","pages":["platform/quickstart/ui-vs-cli","platform/quickstart/ui-tutorial","platform/quickstart/cli-tutorial","platform/quickstart/get-help"]},{"group":"Glossary","pages":["platform/quickstart/glossary"]},{"group":"How it works","pages":["platform/quickstart/how-zapier-works","platform/quickstart/zapier-integration-structure","platform/quickstart/private-vs-public-integrations"]},"platform/quickstart/recommended-triggers-and-actions","platform/quickstart/trusted-developers"]},{"group":"Build with UI","pages":["platform/quickstart/ui-tutorial",{"group":"Actions","pages":["platform/build/action","platform/build/create","platform/build/search","platform/build/reorder-action","platform/build/search-or-create"]},{"group":"Advanced features","pages":["platform/build/env","platform/build/errors","platform/build/bundle","platform/build/code-mode","platform/build/hydration-cli","platform/build/static-ip"]},{"group":"Authentication","pages":["platform/build/auth","platform/build/apikeyauth","platform/build/basicauth","platform/build/digestauth","platform/build/oauth","platform/build/sessionauth","platform/build/connection-label","platform/build/computed-fields","platform/build/computed-test-field","platform/build/requesttemplate","platform/build/subdomain-validation"]},{"group":"Input Fields","pages":["platform/build/field-definitions","platform/build/add-fields","platform/build/dynamic-field","platform/build/line-items","platform/build/search-powered-fields"]},{"group":"Output Fields","pages":["platform/build/sample-data","platform/build/response-types"]},{"group":"Testing","pages":["platform/build/test-auth","platform/build/test-triggers-actions","platform/build/test-tools","platform/build/test-monitoring"]},{"group":"Triggers","pages":["platform/build/trigger","platform/build/polling-trigger","platform/build/hook-trigger","platform/build/reorder-trigger","platform/build/deduplication","platform/build/pagination-trigger","platform/build/cli-hook-trigger"]},{"group":"Troubleshooting","pages":["platform/build/operating-constraints","platform/build/troubleshoot-trigger-timeouts","platform/build/troubleshoot-trigger-payload","platform/build/troubleshoot-action-timeouts","platform/build/troubleshoot-action-payload","platform/build/troubleshoot-custom-fields","platform/build/reduce-api-requests","platform/build/troubleshoot-throttles","platform/build/hydration-limits","platform/build/error-array-expected","platform/build/error-non-object","platform/build/error-non-object-array"]},"platform/build/form-mode"]},{"group":"Build with CLI","pages":["platform/build-cli/overview",{"group":"Features","pages":[{"group":"Input Fields","pages":["platform/build-cli/input-fields","platform/build/field-definitions","platform/build-cli/dynamic-dropdowns"]}]},"platform/quickstart/cli-tutorial","platform/build-cli/faqs","platform/build-cli/core","platform/reference/cli","platform/reference/schema"]},{"group":"Manage","pages":[{"group":"Account and team","pages":["platform/manage/add-team"]},{"group":"Integration changes","pages":["platform/manage/planning-changes","platform/manage/auth-scheme","platform/manage/auth-required","platform/manage/auth-keys","platform/manage/change-keys","platform/manage/required-input","platform/manage/input-key","platform/manage/output-key","platform/manage/output","platform/manage/change-trigger","platform/manage/change-perform","platform/manage/change-api","platform/manage/export-cli","platform/manage/export-ui","platform/manage/essential-tips-iq"]},{"group":"Integration performance","pages":["platform/manage/api-outage","platform/manage/embed-insights","platform/manage/user-feedback","platform/manage/error-handling","platform/manage/active-users","platform/manage/integration-insights","platform/manage/zap-activation","platform/manage/embed-activation"]},{"group":"Sharing","pages":["platform/manage/sharing"]},{"group":"Versions","pages":["platform/manage/versions","platform/manage/clone","platform/manage/promote","platform/manage/migrate","platform/manage/deprecate","platform/manage/versions-legacy"]},"platform/manage/branding-cli"]},{"group":"Publish","pages":[{"group":"Branding","pages":["platform/publish/branding-guidelines","platform/publish/add-or-modify-branding"]},{"group":"Launch process","pages":["platform/publish/public-integration","platform/publish/integration-build-guidelines","platform/publish/integration-publishing-requirements","platform/publish/zap-templates","platform/publish/user-help","platform/publish/best-practices","platform/publish/zps"]},{"group":"Partner program","pages":["platform/publish/partner-program","platform/publish/partner-faq","platform/publish/benefits-guide"]},{"group":"Validation","pages":["platform/publish/integration-checks-reference"]}]},{"group":"Embed","pages":["platform/embed/partner-solutions"]},{"group":"Reference","pages":[{"group":"Use cases","pages":["platform/reference/forms-app","platform/reference/crm-app","platform/reference/project-app","platform/reference/ai-app"]},"platform/reference/transfer","platform/reference/ai-actions","platform/reference/custom-actions-api-requests","platform/reference/legacy-scripting","platform/reference/changelog","platform/reference/cli","platform/reference/schema"]}]},{"tab":"Partner Solutions","openapi":{"source":"https://api.zapier.com/schema","directory":"partner-solutions/"},"groups":[{"group":"Welcome","pages":["partner-solutions/getting-started"]},{"group":"Workflow API","pages":["partner-solutions/workflow-api/intro",{"group":"Building a Workflow","pages":["partner-solutions/workflow-api/Building-a-Zap","partner-solutions/workflow-api/Fields-and-Fieldsets","partner-solutions/workflow-api/Selecting-an-Action","partner-solutions/workflow-api/Selecting-an-Authentication",{"group":"Custom Flows","pages":["partner-solutions/workflow-api/testing-a-step","partner-solutions/workflow-api/Hardcoding-an-Action","partner-solutions/workflow-api/adding-an-authentication"]},"partner-solutions/workflow-api/limitations"]},"partner-solutions/workflow-api/list-apps","partner-solutions/workflow-api/list-zaps","partner-solutions/workflow-api/list-zap-templates","partner-solutions/workflow-api/embed-zap-editor"]},{"group":"Workflow Element","pages":["partner-solutions/workflow-element/intro","partner-solutions/elements-security","partner-solutions/embed-insights"]},{"group":"Embed Enhancements","pages":["partner-solutions/pre-filled-zaps","partner-solutions/quick-account-creation"]},{"group":"Getting Started With the API","pages":["partner-solutions/api-reference/authentication","partner-solutions/api-reference/rate-limiting"]},{"group":"Apps","pages":["partner-solutions/api-reference/apps/get-apps-[v1]","partner-solutions/api-reference/apps/get-apps-[v2]"]},{"group":"Categories","pages":["partner-solutions/api-reference/categories/get-categories"]},{"group":"Accounts","pages":["partner-solutions/api-reference/accounts/user-profile","partner-solutions/api-reference/accounts/create-account"]},{"group":"Zap Templates","pages":["partner-solutions/api-reference/zap-templates/get-zap-templates"]},{"group":"Zaps","pages":["partner-solutions/api-reference/zaps/get-zaps-[v1]","partner-solutions/api-reference/zaps/guess-a-zap","partner-solutions/api-reference/zaps/get-zaps-[v2]","partner-solutions/api-reference/zaps/create-a-zap"]},{"group":"Actions","pages":["partner-solutions/api-reference/actions/get-actions","partner-solutions/api-reference/actions/get-input-fields","partner-solutions/api-reference/actions/get-choices","partner-solutions/api-reference/actions/get-output-fields","partner-solutions/api-reference/actions/step-test"]},{"group":"Authentications","pages":["partner-solutions/api-reference/authentications/get-authentications","partner-solutions/api-reference/authentications/create-authentication"]},{"group":"Experimental","pages":["partner-solutions/api-reference/experimental/create-a-workflow-step"]},{"group":"Schemas","pages":[{"group":"Common Types","pages":["partner-solutions/api-reference/common-types/action","partner-solutions/api-reference/common-types/app","partner-solutions/api-reference/common-types/authentication","partner-solutions/api-reference/common-types/choice","partner-solutions/api-reference/common-types/fieldset","partner-solutions/api-reference/common-types/infoField","partner-solutions/api-reference/common-types/inputField","partner-solutions/api-reference/common-types/outputField","partner-solutions/api-reference/common-types/zap","partner-solutions/api-reference/common-types/errors","partner-solutions/api-reference/common-types/pagination","partner-solutions/api-reference/common-types/requests","partner-solutions/api-reference/common-types/responses"]}]},{"group":"Apps","pages":["partner-solutions/apps/get-apps-[v1]","partner-solutions/apps/get-apps-[v2]"]},{"group":"Categories","pages":["partner-solutions/categories/get-categories"]},{"group":"Accounts","pages":["partner-solutions/accounts/user-profile","partner-solutions/accounts/create-account"]},{"group":"Zap Templates","pages":["partner-solutions/zap-templates/get-zap-templates"]},{"group":"Zaps","pages":["partner-solutions/zaps/get-zaps-[v1]","partner-solutions/zaps/guess-a-zap-[beta]","partner-solutions/zaps/get-zaps-[v2]","partner-solutions/zaps/create-a-zap"]},{"group":"Actions","pages":["partner-solutions/actions/get-actions","partner-solutions/actions/get-input-fields","partner-solutions/actions/get-choices","partner-solutions/actions/get-output-fields","partner-solutions/actions/step-test"]},{"group":"Authentications","pages":["partner-solutions/authentications/get-authentications","partner-solutions/authentications/create-authentication"]},{"group":"Experimental","pages":["partner-solutions/experimental/create-a-workflow-step","partner-solutions/experimental/get-zap-runs"]}]},{"tab":"AI Actions","groups":[{"group":"Getting Started","pages":["ai-actions/intro","ai-actions/quickstart"]},{"group":"How to","pages":["ai-actions/how-tos/auth","ai-actions/how-tos/account-list","ai-actions/how-tos/stateless-vs-stored",{"group":"Stored actions","pages":["ai-actions/how-tos/stored/intro","ai-actions/how-tos/stored/action-configuration","ai-actions/how-tos/stored/list-actions","ai-actions/how-tos/stored/run-stored-action",{"group":"Manage stored actions","pages":["ai-actions/how-tos/stored/manage/get-action","ai-actions/how-tos/stored/manage/create-action","ai-actions/how-tos/stored/manage/update-action","ai-actions/how-tos/stored/manage/delete-action"]}]},{"group":"Stateless actions","pages":["ai-actions/how-tos/stateless/intro","ai-actions/how-tos/stateless/run-stateless-action"]},{"group":"Gathering action information","pages":["ai-actions/how-tos/action-info/introduction","ai-actions/how-tos/action-info/find-app","ai-actions/how-tos/action-info/find-action","ai-actions/how-tos/action-info/choose-auth","ai-actions/how-tos/action-info/action-details","ai-actions/how-tos/action-info/prefill-choices"]}]},{"group":"API Reference","pages":[{"group":"system","pages":["ai-actions/api-reference/system/app-health-check"]},{"group":"auth","pages":["ai-actions/api-reference/auth/check-user-auth","ai-actions/api-reference/auth/get-account-list","ai-actions/api-reference/auth/get-user-login-link","ai-actions/api-reference/auth/get-oauth-login-link"]},{"group":"apps","pages":["ai-actions/api-reference/apps/search-apps","ai-actions/api-reference/apps/get-app-details","ai-actions/api-reference/apps/list-authentications-for-app"]},{"group":"actions","pages":["ai-actions/api-reference/actions/search-actions","ai-actions/api-reference/actions/get-action-details","ai-actions/api-reference/actions/get-prefill-choices"]},{"group":"execution","pages":["ai-actions/api-reference/execution/execute-stateless-ai-action","ai-actions/api-reference/execution/execute-stored-ai-action","ai-actions/api-reference/execution/preview-stored-ai-action","ai-actions/api-reference/execution/rate-execution-log"]},{"group":"ai-actions","pages":["ai-actions/api-reference/ai-actions/list-ai-actions","ai-actions/api-reference/ai-actions/create-ai-action","ai-actions/api-reference/ai-actions/get-ai-action","ai-actions/api-reference/ai-actions/update-ai-action","ai-actions/api-reference/ai-actions/delete-ai-action"]},{"group":"utilities","pages":["ai-actions/api-reference/utilities/guess-actions","ai-actions/api-reference/utilities/shrink-result"]}]},{"group":"Tools","pages":["ai-actions/tools/stateless-action"]},{"group":"Libraries","pages":[{"group":"TypeScript (Node.js, Deno)","icon":"node-js","pages":["ai-actions/libraries/nodejs/getting-started","ai-actions/libraries/nodejs/authentication","ai-actions/libraries/nodejs/usage","ai-actions/libraries/nodejs/nextjs-reccommendation"]},{"group":"React Components","icon":"react","pages":["ai-actions/libraries/react/getting-started",{"group":"Components","pages":["ai-actions/libraries/react/ai-actions-provider","ai-actions/libraries/react/action-list","ai-actions/libraries/react/edit-action","ai-actions/libraries/react/stateless-creator"]}]}]},{"group":"Development Resources","pages":["ai-actions/developer-resources/openapi","ai-actions/developer-resources/keys","ai-actions/developer-resources/logs"]},{"group":"Help","pages":["ai-actions/help/community","ai-actions/help/bug"]}]}],"global":{"anchors":[{"anchor":"Community","href":"https://community.zapier.com/","icon":"users"},{"anchor":"Blog","href":"https://zapier.com/blog/","icon":"newspaper"},{"anchor":"Contact Us","href":"https://developer.zapier.com/contact","icon":"envelope"}]}},"logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/zapier-82f0e938/logo/dark.svg"},"api":{"openapi":["https://actions.zapier.com/api/v2/openapi.json"]},"background":{"decoration":"windows"},"navbar":{"links":[{"label":"Developer Platform Login","href":"https://zapier.com/platform/login"},{"label":"Platform CLI","href":"platform/reference/cli-docs"}],"primary":{"type":"button","label":"Sign Up","href":"https://zapier.com/sign-up"}},"footer":{"socials":{"facebook":"http://www.facebook.com/ZapierApp?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier","linkedin":"https://www.linkedin.com/company/zapier/?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier","x":"https://twitter.com/zapier?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier#!/zapier","youtube":"https://www.youtube.com/user/ZapierApp/videos?utm_source=zapier.com\u0026amp;utm_medium=referral\u0026amp;utm_campaign=zapier"}},"redirects":[{"destination":"/platform/build-cli/overview","source":"/platform/reference/cli-docs","_id":"67abccd35460d958c1f7a287"},{"destination":"/platform/build-cli/dynamic-dropdowns","source":"/platform/build/dynamic-dropdowns","_id":"67abccd35460d958c1f7a288"},{"destination":"/platform/build-cli/dynamic-dropdowns","source":"/platform/build/search-powered-fields","_id":"67abccd35460d958c1f7a289"}]},"pageMetadata":{"title":"Welcome","description":null,"path":"/","href":"/platform/home"}}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"}},"gitSource":{"type":"gitlab","owner":"zapier/public-api","repo":"public-api-docs","projectId":56036607,"deployBranch":"main","contentDirectory":"","isPrivate":true}},"__N_SSG":true},"page":"/_sites/[subdomain]/[[...slug]]","query":{"subdomain":"zapier-82f0e938","slug":["platform","home"]},"buildId":"hy3puFCEyypkbxdK0kPb_","isFallback":false,"isExperimentalCompile":false,"gsp":true,"scriptLoader":[]}</script></html></body></html>