A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.
If value is `null`, then no authentication is required to use the app. Client ID-authenticated requests will never have this object's fields populated.
The latest versioned identifier for the app's current implementation (e.g. HubSpotCLIAPI@1.4.18). For versionless implementations this matches key (e.g. GoogleSheetsV2API). This is the latest promoted version, not a pinned or historical version.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Zapier","colors":{"primary":"#FF4F00","light":"#FE6C2A","dark":"#FF4F00"},"logo":{"light":"https://mintcdn.com/zapier-82f0e938/uPbDC0jSuXgHCaWD/logo/light.svg?fit=max\u0026auto=format\u0026n=uPbDC0jSuXgHCaWD\u0026q=85\u0026s=b6a37289cb22ac1a9681572651874765","dark":"https://mintcdn.com/zapier-82f0e938/b1yEJJDZ7v1EncmE/logo/dark.svg?fit=max\u0026auto=format\u0026n=b1yEJJDZ7v1EncmE\u0026q=85\u0026s=2c393c141bc7fbb0051aaa46b103f5e8","href":"https://zapier.com"},"favicon":"https://mintcdn.com/zapier-82f0e938/1jtyk4mqAs_J-p30/favicon.png?fit=max\u0026auto=format\u0026n=1jtyk4mqAs_J-p30\u0026q=85\u0026s=a26d7c83b71f1cdec48ae963245f407f","api":{"openapi":["https://api.zapier.com/schema","api-reference/specs/trigger-inbox.yaml","api-reference/specs/actions.yaml","api-reference/specs/connections.yaml","api-reference/specs/agentic-management.yaml"]},"background":{"color":{"light":"#FFFEFB"}},"navbar":{"primary":{"type":"button","label":"Sign Up","href":"https://zapier.com/sign-up"}},"footer":{},"seo":{"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-K7GFJTV"}},"contextual":{"options":["copy","view",{"title":"Open in ChatGPT","description":"Ask ChatGPT about this page","icon":"/images/logos/branded/openai.svg","href":{"base":"https://chatgpt.com/","query":[{"key":"q","value":"Read https://docs.zapier.com$path.md and help me apply it. Ask what I am building before giving steps."}]}},{"title":"Open in Claude","description":"Ask Claude about this page","icon":"/images/logos/branded/claude.svg","href":{"base":"https://claude.ai/new","query":[{"key":"q","value":"Read https://docs.zapier.com$path.md and help me apply it. Ask what I am building before giving steps."}]}},{"title":"Open in Perplexity","description":"Ask Perplexity about this page","icon":"/images/logos/branded/perplexity.svg","href":{"base":"https://www.perplexity.ai/search","query":[{"key":"q","value":"Read https://docs.zapier.com$path.md and help me apply it. Ask what I am building before giving steps."}]}},{"title":"Open in Claude Code","description":"Use this page in Claude Code","icon":"/images/logos/branded/claude.svg","href":{"base":"claude://code/new","query":[{"key":"q","value":"Read https://docs.zapier.com$path.md and help me apply it to this project. Check what is already here before giving steps."}]}},{"title":"Open in Codex","description":"Use this page in Codex","icon":"/images/logos/branded/openai.svg","href":{"base":"codex://new","query":[{"key":"prompt","value":"Read https://docs.zapier.com$path.md and help me apply it to this project. Check what is already here before giving steps."}]}},{"title":"Open in Cursor","description":"Use this page in Cursor","icon":"/images/logos/branded/cursor.svg","href":{"base":"cursor://anysphere.cursor-deeplink/prompt","query":[{"key":"text","value":"Read https://docs.zapier.com$path.md and help me apply it to this project. Check what is already here before giving steps."}]}}],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://community.zapier.com/"},{"anchor":"Changelog","icon":"rss","href":"/white-label/changelog"},{"anchor":"Contact Us","icon":"envelope","href":"https://developer.zapier.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zapier-82f0e938","hasAudioNarration":false,"actualSubdomain":"zapier-82f0e938","customDomains":["docs.zapier.com"],"gitSource":{"type":"gitlab","owner":"zapier/public-api","repo":"public-api-docs","projectId":56036607,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae51da7cb1669b16a31b9f0","collectionId":"56f68a96-b850-4f94-a3af-288e6b77d8ee","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae51da7cb1669b16a31b9f0"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae51da7cb1669b16a31b9f0","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Build a Zapier integration","count":149},{"language":"default","tag":"Developer Platform","count":149},{"language":"default","tag":"Embed Zapier","count":105},{"language":"default","tag":"Powered by Zapier","count":86},{"language":"default","tag":"Use Zapier in your tools","count":79},{"language":"default","tag":"Zapier MCP","count":67},{"language":"default","tag":"API reference","count":60},{"language":"default","tag":"Build with UI","count":52},{"language":"default","tag":"API specification","count":50},{"language":"default","tag":"Get started","count":46}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6ac8f1f2b9b3f8640f05a146","deploymentId":"67001931f47db52dbf2b872a","questionText":"How do I build a public Zapier integration?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T13:53:54.782Z","updatedAt":"2026-10-09T13:53:54.782Z","__v":0},{"_id":"6ac8f1e5b9b3f8640f05a0d1","deploymentId":"67001931f47db52dbf2b872a","questionText":"What's the difference between the SDK and Platform CLI?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T13:53:41.586Z","updatedAt":"2026-10-09T13:53:41.586Z","__v":0},{"_id":"6ac8f1d4b9b3f8640f05a051","deploymentId":"67001931f47db52dbf2b872a","questionText":"How do I connect Zapier MCP to my MCP client?","status":"active","generatedBy":"manual","createdAt":"2026-10-09T13:53:24.465Z","updatedAt":"2026-10-09T13:53:24.465Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:\"Degular Display - Semibold\";src:url(https://fonts.zapier.com/Degular/DegularDisplay-Semibold.woff2);font-display:fallback;font-weight:400}@font-face{font-family:\"Serrif\";src:url(/fonts/serrif-300.woff2) format('woff2');font-display:swap;font-weight:300;font-style:normal}@font-face{font-family:\"Degular Display\";src:url(/fonts/degular-display-500.woff2) format('woff2');font-display:swap;font-weight:500;font-style:normal}@font-face{font-family:\"Degular Display\";src:url(/fonts/degular-display-600.woff2) format('woff2');font-display:swap;font-weight:600;font-style:normal}h2,h3,h4,header h1{font-family:\"Degular Display - Semibold\";font-weight:400!important;letter-spacing:.08rem!important}#chat-assistant-floating-input,.chat-assistant-floating-input,[data-component-part=chat-assistant-floating-input]{display:none!important}.card h2{font-size:1.2rem}.card code{text-decoration:none}:root:not(.dark) .card,:root:not(.dark) .code-block,:root:not(.dark) .code-block pre,:root:not(.dark) .code-block-background,:root:not(.dark) .code-group,:root:not(.dark) .code-group pre,:root:not(.dark) .shiki{background-color:#fffefb!important}.cta-button,.docs-nav-label{letter-spacing:.01em;text-decoration:none!important}.cta-button{display:inline-flex;align-items:center;gap:8px;padding:12px 24px;width:fit-content;background:#ff4f00;color:#fff!important;font-weight:600;font-size:15px;border:0;border-radius:8px;box-shadow:0 2px 8px rgba(255,79,0,.25);transition:all .2s ease;margin:1em 0}.cta-button:hover{background:#e64600;color:#fff!important;text-decoration:none!important;box-shadow:0 4px 12px rgba(255,79,0,.35);transform:translateY(-1px)}.cta-button:active{transform:translateY(0);box-shadow:0 1px 4px rgba(255,79,0,.3)}blockquote.sr-only+h2{margin-top:0}#navbar a[href=\"https://zapier.com\"],#navbar a[href=\"https://zapier.com\"] img{padding-right:0!important;margin-right:0!important}.docs-nav-label{color:#201515!important;font-family:\"Degular Display - Medium\",ui-sans-serif,system-ui,sans-serif;font-weight:400;font-size:1.5rem;margin-left:-.6rem;transition:color .15s ease;vertical-align:middle;cursor:pointer}.docs-nav-label:hover{color:#939084!important;text-decoration:none!important}.dark .docs-nav-label{color:#fffefb!important}.dark .docs-nav-label:hover{color:#c5c0b1!important}[role=menu]:focus,[role=menu]:focus-visible{outline-width:1px}footer:not(#zapier-universal-footer){display:none!important}#zapier-universal-footer{display:block!important;background-color:#fffdf9;font-family:'Inter',Helvetica,arial,sans-serif;font-size:14px;line-height:24px;color:#201515;-webkit-font-smoothing:antialiased;width:100%;margin-top:2rem}.dark #zapier-universal-footer{background-color:#2d2e2e;color:#fffdf9}.zuf{max-width:1200px;margin:0 auto;padding:30px;display:grid;grid-template-rows:auto;grid-template-columns:100%;grid-template-areas:'links' 'socials' 'logo' 'meta';justify-items:center;align-items:center;gap:30px}@media (min-width:650px){.zuf{grid-template-columns:max-content 1fr;grid-template-areas:'links links' 'socials socials' 'logo meta'}}@media (min-width:980px){.zuf{grid-template-columns:max-content 1fr;grid-template-areas:'socials links' 'logo meta'}}.zuf-row--bottom,.zuf-row--top{display:contents}.zuf-socials{grid-area:socials;display:inline-flex;flex-wrap:wrap;align-items:center;gap:10px}@media (min-width:980px){.zuf-socials{justify-self:start}}.zuf-follow{font-size:14px;line-height:20px;font-weight:400;color:#574e4c;white-space:nowrap}.dark .zuf-follow{color:#a8a5a0}.zuf-icon{display:flex;align-items:center;justify-content:center;width:30px;height:30px;border-radius:100%;background-color:#a8a5a0;text-decoration:none!important;transition:background-color .15s ease}.zuf-icon img,.zuf-icon svg{width:16px;height:16px;fill:#fffdf9}.dark .zuf-icon{background-color:#403f3e}.dark .zuf-icon svg,.dark .zuf-logo path{fill:#fffdf9}.zuf-icon[aria-label*=Facebook]:focus,.zuf-icon[aria-label*=Facebook]:hover{background-color:#3b5998;outline:0}.zuf-icon[aria-label*=LinkedIn]:focus,.zuf-icon[aria-label*=LinkedIn]:hover{background-color:#0976b4;outline:0}.zuf-icon[aria-label*=X]:focus,.zuf-icon[aria-label*=X]:hover{background-color:#00aced;outline:0}.zuf-icon[aria-label*=YouTube]:focus,.zuf-icon[aria-label*=YouTube]:hover{background-color:#e52d27;outline:0}.zuf-icon[aria-label*=blog]:focus,.zuf-icon[aria-label*=blog]:hover{background-color:#ff4f00;outline:0}.zuf-links{grid-area:links;display:flex;flex-wrap:wrap;align-items:center;justify-content:center;column-gap:12.5px;row-gap:10px;width:100%}@media (min-width:980px){.zuf-links{justify-content:flex-end}}.zuf-links a{font-family:'Inter',Helvetica,arial,sans-serif;font-size:14px;line-height:24px;font-weight:500;color:#201515!important;padding:0 5px;white-space:nowrap;text-decoration:none!important}.zuf-links a:focus,.zuf-links a:hover{color:#3d4592!important;outline:0}.dark .zuf-links a{color:#fffdf9!important}.dark .zuf-links a:focus,.dark .zuf-links a:hover,.dark .zuf-meta a:focus,.dark .zuf-meta a:hover{color:#90a1ed!important}.zuf-logo,.zuf-meta a{text-decoration:none!important}.zuf-logo{grid-area:logo;display:inline-flex;align-items:center}.zuf-logo svg{display:block}.zuf-logo path{fill:#201515}.zuf-logo path[fill=\"#FF4F00\"]{fill:#ff4f00!important}@media (min-width:650px){.zuf-logo{justify-self:start}}.zuf-meta{grid-area:meta;font-size:14px;line-height:24px;font-weight:400;color:#574e4c;display:flex;flex-wrap:wrap;align-items:center;justify-content:center;row-gap:10px}.dark .zuf-meta{color:#a8a5a0}.zuf-meta a{padding:5px 10px;color:#574e4c!important}.zuf-meta a:focus,.zuf-meta a:hover{color:#3d4592!important;outline:0}.dark .zuf-meta a{color:#a8a5a0!important}@media (min-width:650px){.zuf-meta{justify-self:end;justify-content:flex-end}}.zuf-meta span{margin-right:10px}@media (max-width:979px){.zuf{padding:20px}}"},{"filePath":"index.css","content":".docs-landing{width:100%;margin:0 auto}#navbar{background:#fffef8!important;backdrop-filter:none!important}.dark #navbar{background:#18181b!important}.docs-landing-hero-bg{background:#201515}.docs-landing-hero-bg .dl-hero-title{color:#fff}.docs-landing-hero-bg .docs-landing-lead{color:rgba(255,255,255,.6)}.dark .docs-landing-hero-bg{background:#26201f;border-bottom:1px solid rgba(255,255,255,.08)}.docs-landing-hero{display:grid;grid-template-columns:minmax(0,1fr);gap:clamp(1.5rem,3.5vw,2.5rem);align-items:center;max-width:1180px;margin:0 auto;padding:48px clamp(1.25rem,4vw,2rem) clamp(1.25rem,2.5vw,1.75rem)}.dl-hero-copy,.docs-landing-hero-inner{text-align:center}.dl-hero-copy{max-width:640px;margin:0 auto}.docs-landing-eyebrow{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif;font-size:.75rem;font-weight:600;letter-spacing:.14em;text-transform:uppercase;color:#605d52;margin:0 0 1.25rem}.docs-landing-title{font-family:\"Degular Display - Semibold\",ui-sans-serif,system-ui,sans-serif;font-size:clamp(2.25rem,4.5vw,3.25rem);line-height:1.08;font-weight:400!important;margin:0 0 1rem;letter-spacing:.08rem!important}.docs-landing-lead{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif;font-size:1rem;line-height:1.5;color:#201515;margin:0 auto;max-width:62ch}.dark .docs-landing-lead{color:var(--muted-foreground, #a1a1aa)}.docs-landing-media{border-radius:14px;overflow:hidden;box-shadow:0 1px 2px rgba(15,23,42,.06),0 12px 40px rgba(15,23,42,.12);border:1px solid rgba(255,79,0,.12);background:rgba(255,79,0,.04)}.docs-landing-video{display:block;width:100%;height:auto;vertical-align:middle}.docs-landing-products{max-width:1180px;margin:0 auto;padding:clamp(2.5rem,5vw,4rem) clamp(1.25rem,4vw,2rem) clamp(3rem,6vw,5rem)}.docs-landing-section-title{font-family:\"Degular Display - Semibold\",ui-sans-serif,system-ui,sans-serif;font-size:clamp(1.5rem,2.5vw,1.875rem);font-weight:400!important;text-align:left;margin:0 0 2.25rem;letter-spacing:.08rem!important}.dl-hero-title{font-family:\"Degular Display\",ui-sans-serif,system-ui,sans-serif;font-size:clamp(2.5rem,4.8vw,3.5rem);line-height:1.1;font-weight:500;letter-spacing:-.03em!important;color:var(--foreground, #18181b);margin:0 0 .6875rem}.dark .dl-hero-demo code,.dark .dl-hero-title{color:var(--foreground, #fafafa)}.dl-hero-title-accent{color:#ff4f00}.dark .dl-hero-title-accent{color:#ff8a5c}.dl-demo-panel,.dl-hero-demo{border:1px solid rgba(9,9,11,.1);overflow:hidden}.dl-hero-demo{display:flex;align-items:center;justify-content:center;aspect-ratio:1/1;min-height:fit-content;padding:clamp(1rem,3vw,1.75rem);border-radius:10px;background-image:url(/images/pattern-abstract.jpg);background-size:cover;background-position:center;background-repeat:no-repeat}.dark .dl-demo-panel,.dark .dl-hero-demo{border-color:rgba(255,255,255,.12)}.dl-demo-panel{width:100%;border-radius:12px;background:#fff;box-shadow:0 1px 2px rgba(15,23,42,.06),0 12px 40px rgba(15,23,42,.14)}.dark .dl-demo-panel{background:#18181b}.dl-demo-clients{display:flex;flex-wrap:wrap;align-items:center;gap:.5rem;padding:.5rem .75rem;border-bottom:1px solid rgba(9,9,11,.08)}.dark .dl-demo-clients{border-bottom-color:rgba(255,255,255,.1)}.dl-demo-chip{width:36px;height:36px;border-radius:8px;border:1px solid rgba(9,9,11,.1);background:#fff;flex:none;margin:0!important}.dark .dl-demo-chip{border-color:rgba(255,255,255,.14)}.dl-demo-chip--padded{padding:6px}.dl-demo-arch-agents{display:flex;gap:.625rem;padding:1rem 1rem .75rem}.dl-demo-arch-col{flex:1;display:flex;flex-direction:column;gap:.375rem}.dl-demo-arch-label{font-size:.6875rem;font-weight:500;color:var(--muted-foreground, #71717a);margin:0 0 .125rem;letter-spacing:.01em}.dl-demo-arch-label--spacer{visibility:hidden;pointer-events:none;user-select:none}.dl-demo-arch-chip{display:flex;align-items:center;gap:.4375rem;padding:.3125rem .5625rem;border-radius:7px;border:1px solid rgba(9,9,11,.1);background:#fff;font-size:.75rem;font-weight:500;color:#09090b;line-height:1;white-space:nowrap}.dl-demo-arch-chip--muted{background:0 0;border-style:dashed;color:var(--muted-foreground, #71717a)}.dl-demo-arch-chip--logo{justify-content:center;padding:.375rem;width:36px;height:36px}.dl-demo-arch-icon{width:22px;height:22px;border-radius:4px;flex:none}.dl-demo-arch-chip--icon-pad .dl-demo-arch-icon{padding:3px}.dl-demo-arch-merge{position:relative;height:28px;margin:0 1rem}.dl-demo-arch-merge::before{content:'';position:absolute;left:25%;right:25%;top:0;height:14px;border-left:1px solid rgba(9,9,11,.1);border-right:1px solid rgba(9,9,11,.1);border-bottom:1px solid rgba(9,9,11,.1);border-bottom-left-radius:4px;border-bottom-right-radius:4px}.dl-demo-arch-merge::after{content:'';position:absolute;left:50%;transform:translateX(-50%);top:14px;bottom:0;width:1px;background:rgba(9,9,11,.1)}.dl-demo-arch-zapier{display:flex;align-items:center;justify-content:center;gap:.5rem;margin:0 1rem;padding:.625rem 1rem;border:1px solid rgba(9,9,11,.1);border-radius:10px;background:#fff}.dl-demo-arch-stem{display:flex;justify-content:center;height:20px}.dl-demo-arch-stem::after{content:'';width:1px;height:100%;background:rgba(9,9,11,.1)}.dl-demo-arch-apps{display:flex;flex-wrap:wrap;align-items:center;justify-content:center;gap:.375rem;padding:0 1rem .875rem}.dl-demo-arch-app{display:inline-flex;align-items:center;padding:.25rem .625rem;border-radius:6px;border:1px solid rgba(9,9,11,.1);background:#fff;font-size:.6875rem;font-weight:500;color:#09090b;white-space:nowrap}.dl-demo-arch-app--more{background:0 0;border-color:#e06c2c;color:#e06c2c;font-weight:600;text-decoration:none}.dl-demo-arch-app--more:hover{background:rgba(224,108,44,.06)}.dark .dl-demo-arch-stem::after{background:rgba(255,255,255,.1)}.dark .dl-demo-arch-app,.dark .dl-demo-arch-chip{background:rgba(255,255,255,.06);border-color:rgba(255,255,255,.12);color:#fafafa}.dl-demo-arch-zapier-badge{font-size:.8125rem;font-weight:600;color:#09090b;letter-spacing:-.01em}.dl-demo-arch-zapier-plus{font-size:.8125rem;font-weight:600;color:#e06c2c}.dark .dl-demo-arch-chip--muted{background:0 0;border-color:rgba(255,255,255,.15);color:var(--muted-foreground, #a1a1aa)}.dark .dl-demo-arch-merge::before,.dark .dl-demo-arch-zapier{border-color:rgba(255,255,255,.1)}.dark .dl-demo-arch-merge::after{background:rgba(255,255,255,.1)}.dark .dl-demo-arch-zapier{background:rgba(255,255,255,.04)}.dark .dl-demo-arch-zapier-badge{color:#fafafa}.dl-demo-more{display:inline-flex;align-items:center;justify-content:center;width:36px;height:36px;border-radius:8px;border:1px dashed rgba(9,9,11,.22);font-size:.9375rem;font-weight:500;line-height:1;color:var(--muted-foreground, #52525b);flex:none}.dark .dl-demo-more{border-color:rgba(255,255,255,.2);color:var(--muted-foreground, #a1a1aa)}.dl-demo-body{display:flex;flex-direction:column;gap:.375rem;padding:.5625rem .75rem .625rem}.dl-demo-prompt,.dl-demo-row{padding:.4375rem .625rem;border:1px solid rgba(9,9,11,.1);border-radius:7px}.dl-demo-prompt{font-size:.75rem;color:var(--muted-foreground, #52525b)}.dl-demo-row{display:flex;align-items:center;justify-content:space-between;gap:1rem}.dark .dl-demo-prompt,.dark .dl-demo-row{border-color:rgba(255,255,255,.12)}.dl-demo-status{font-size:.6875rem;font-weight:700;letter-spacing:.12em;text-transform:uppercase;color:#ff4f00}.dl-demo-action{display:flex;align-items:center;justify-content:space-between;gap:.75rem;padding:.375rem .625rem;border-left:2px solid #ff4f00;border-radius:0 7px 7px 0;background:rgba(9,9,11,.03)}.dark .dl-demo-action{background:rgba(255,255,255,.04)}.dl-demo-action span,.dl-demo-foot{font-size:.75rem;color:var(--muted-foreground, #52525b)}.dl-demo-action span{text-align:right}.dl-demo-foot{display:flex;align-items:center;justify-content:space-between;gap:1rem;padding-top:.25rem}.dl-hero-demo code{font-family:ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;font-size:.75rem;background:0 0;border:0;padding:0;color:var(--foreground, #18181b)}.dl-section{max-width:1180px;margin:0 auto;padding:clamp(1.5rem,3vw,2.25rem) clamp(1.25rem,4vw,2rem)}.dl-eyebrow{font-size:.6875rem;font-weight:700;letter-spacing:.12em;text-transform:uppercase;color:#ff4f00;margin:0 0 .4375rem}.dl-heading{font-size:clamp(1.375rem,2.4vw,1.75rem);line-height:1.2;font-weight:600;letter-spacing:-.01em!important;color:var(--foreground, #18181b);margin:0 0 .5rem;max-width:40ch}.dark .dl-heading{color:var(--foreground, #fafafa)}.dl-lead{font-size:.9375rem;line-height:1.55;color:var(--muted-foreground, #52525b);margin:0 0 1.25rem;max-width:68ch}.dark .dl-lead{color:var(--muted-foreground, #a1a1aa)}.dl-grid{display:grid;gap:.75rem;align-items:stretch}.dl-grid--2{grid-template-columns:repeat(2,minmax(0,1fr))}.dl-grid--3{grid-template-columns:repeat(3,minmax(0,1fr))}.dl-grid--4{grid-template-columns:repeat(4,minmax(0,1fr))}.dl-card{display:flex;flex-direction:column;gap:.5rem;padding:1.125rem 1.25rem 1.25rem;border:1px solid rgba(9,9,11,.1);background:#f8f4f0}.dark .dl-card{border-color:rgba(255,255,255,.12);background:rgba(255,255,255,.02)}.dl-card-mark{align-self:flex-start;margin-bottom:.25rem;color:#ff4f00}.dl-card-eyebrow{font-size:.6875rem;font-weight:700;letter-spacing:.12em;text-transform:uppercase;color:#ff4f00;margin:0}.dl-card-title{font-family:\"Serrif\",ui-serif,serif;font-size:1.5rem;font-weight:300;line-height:1.1;letter-spacing:-.03em;color:var(--foreground, #18181b);margin:0}.dark .dl-card-title{color:var(--foreground, #fafafa)}.dl-card-desc{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif;font-size:.9375rem;line-height:1.55;color:var(--muted-foreground, #52525b);margin:0}.dark .dl-card-desc,.dark .dl-pill{color:var(--muted-foreground, #a1a1aa)}.dl-pills{display:flex;flex-wrap:wrap;gap:.375rem;margin:.125rem 0 0}.dl-pill{font-size:.75rem;line-height:1;padding:.375rem .625rem;border-radius:999px;border:1px solid rgba(9,9,11,.14);color:var(--muted-foreground, #52525b);white-space:nowrap}.dark .dl-pill{border-color:rgba(255,255,255,.16)}.dl-pill>a{color:inherit!important;text-decoration:none!important}.dl-pill:has(>a):hover{border-color:rgba(9,9,11,.34)}.dark .dl-pill:has(>a):hover{border-color:rgba(255,255,255,.34)}.dl-pill--accent{border-color:rgba(255,79,0,.35);background:rgba(255,79,0,.06);color:#ff4f00}.dark .dl-pill--accent{border-color:rgba(255,79,0,.45);color:#ff8a5c}.dl-code{font-family:ui-monospace,SFMono-Regular,Menlo,Consolas,monospace;font-size:.8125rem;line-height:1.7;background:rgba(9,9,11,.04);border-radius:8px;padding:.75rem .875rem;margin:.125rem 0;overflow-x:auto;color:var(--foreground, #18181b)}.dl-code span{display:block;white-space:pre}.dl-code--shell span::before{content:\"\\276F \";color:#ff4f00}.dark .dl-code{background:rgba(255,255,255,.05);color:var(--foreground, #fafafa)}.dl-cta{margin-top:auto;padding-top:.5rem;font-size:.875rem;font-weight:600;color:#ff4f00!important;text-decoration:none!important}.dl-cta:hover{text-decoration:underline!important}@media screen and (max-width:1024px){.dl-grid--3,.dl-grid--4{grid-template-columns:repeat(2,minmax(0,1fr))}}@media screen and (max-width:640px){.dl-grid--2,.dl-grid--3,.dl-grid--4{grid-template-columns:1fr}}.docs-landing-next{max-width:1180px;margin:0 auto;padding:clamp(1.5rem,3vw,2.25rem) clamp(1.25rem,4vw,2rem) clamp(2.25rem,4vw,3.25rem)}.docs-landing-next-title{font-size:2rem;line-height:1.2;font-weight:600;letter-spacing:-.01em!important;color:var(--foreground, #18181b);margin:0 0 1.25rem}.dark .docs-landing-next-title{color:var(--foreground, #fafafa)}.docs-landing-next-grid{display:grid;grid-template-columns:repeat(4,minmax(0,1fr));column-gap:clamp(1.5rem,4vw,3rem)}.docs-landing-next-item{position:relative;display:block;padding:.875rem 0 1.25rem;border-top:1px solid rgba(9,9,11,.12);text-decoration:none!important;transition:border-top-color .2s ease}.docs-landing-next-item:hover{border-top-color:#ff4f00}.dark .docs-landing-next-item{border-top-color:rgba(255,255,255,.14)}.docs-landing-next-item-title{display:block;font-size:1rem;font-weight:600;color:var(--foreground, #18181b);margin-bottom:.25rem}.docs-landing-next-item-title::after{content:\" \\2192\";color:#ff4f00}.dark .docs-landing-next-item-title{color:var(--foreground, #fafafa)}.docs-landing-next-item:hover .docs-landing-next-item-title{text-decoration:underline}.docs-landing-next-item-desc{display:block;font-size:.9375rem;line-height:1.55;color:var(--muted-foreground, #52525b)}.dark .docs-landing-next-item-desc{color:var(--muted-foreground, #a1a1aa)}@media screen and (max-width:768px){.docs-landing-next-grid{grid-template-columns:1fr}}.hero-container{display:flex;flex-direction:row;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:1024px){.docs-landing-hero{grid-template-columns:1fr}.docs-landing-media{max-width:640px;margin:0 auto}}@media screen and (max-width:1300px){.hero-container{flex-direction:column;text-align:center}.hero-text{margin-right:0;margin-bottom:2rem}.hero-video{max-width:600px}}.dl-section-heading{font-size:2rem;line-height:1.2;font-weight:600;letter-spacing:-.01em!important;color:var(--foreground, #18181b);margin:0 0 1.25rem}.dark .dl-section-heading{color:var(--foreground, #fafafa)}.dl-bands{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:.75rem}.dl-band,.dl-band-main{display:flex;flex-direction:column}.dl-band{border:1px solid rgba(9,9,11,.1);overflow:hidden;background:#f8f4f0}.dark .dl-band{border-color:rgba(255,255,255,.12);background:rgba(255,255,255,.02)}.dl-band-main{gap:.5rem;padding:1.125rem 1.25rem 1.25rem;border-bottom:1px solid rgba(9,9,11,.1)}.dark .dl-band-main{background:rgba(255,255,255,.02);border-bottom-color:rgba(255,255,255,.12)}.dl-band-badge{align-self:flex-start;margin:0;padding:.1875rem .4375rem;border:1px solid rgba(255,79,0,.4);border-radius:5px;font-size:.625rem;font-weight:700;letter-spacing:.12em;text-transform:uppercase;color:#ff4f00}.dl-band-title{font-family:\"Serrif\",ui-serif,serif;font-size:1.5rem;font-weight:300!important;line-height:1.1;letter-spacing:-.03em!important;color:var(--foreground, #18181b);margin:.125rem 0 0!important}.dark .dl-band-title{color:var(--foreground, #fafafa)}.dl-band-icon,.dl-band-title-mark{align-self:flex-start;margin-bottom:16px;color:#ff4f00}.dl-band-icon{margin-bottom:8px}.dl-band-desc{font-family:\"Inter\",ui-sans-serif,system-ui,sans-serif;font-size:.9375rem;line-height:1.55;color:var(--muted-foreground, #52525b);margin:0;max-width:none}.dark .dl-band-desc{color:var(--muted-foreground, #a1a1aa)}.dl-band-main .dl-hero-demo{box-shadow:none;margin-top:.375rem}.dl-band-media{display:block;width:100%;height:auto;border:1px solid rgba(9,9,11,.1);border-radius:10px;margin:.375rem 0 0!important}.dark .dl-band-media{border-color:rgba(255,255,255,.12)}.dl-band-list{display:flex;flex:1;flex-direction:column}.dl-band-row{position:relative;display:grid;grid-template-columns:28px 1fr;grid-template-rows:auto auto;column-gap:.625rem;row-gap:.1875rem;align-items:center;flex:1;padding:.8125rem 2.25rem .8125rem 1.25rem;border-bottom:1px solid rgba(9,9,11,.08);text-decoration:none!important;transition:background .15s ease}.dl-band-row .dl-band-row-icon{grid-row:1/-1;align-self:center}.dl-band-row .dl-band-row-desc,.dl-band-row .dl-band-row-title{grid-column:2}.dl-band-row:not(:has(.dl-band-row-icon)){grid-template-columns:1fr}.dl-band-row:not(:has(.dl-band-row-icon)) .dl-band-row-desc,.dl-band-row:not(:has(.dl-band-row-icon)) .dl-band-row-title{grid-column:1}.dark .dl-band-row{border-bottom-color:rgba(255,255,255,.1)}.dl-band-row:last-child{border-bottom:none}.dl-band-row:hover{background:rgba(255,79,0,.04)}.dl-band-row::after{content:\"\\2192\";position:absolute;top:50%;right:1rem;transform:translateY(-50%);font-size:1rem;color:#ff4f00;transition:transform .15s ease}.dl-band-row:hover::after{transform:translateY(-50%) translateX(2px)}.dl-band-row>a,.docs-landing-next-item>a{position:absolute;inset:0;z-index:1}.dl-band-row>a:focus-visible,.docs-landing-next-item>a:focus-visible{outline:2px solid #ff4f00;outline-offset:-2px}.dl-band-row-icon{display:flex;align-items:center;justify-content:center;flex-shrink:0;width:28px;height:28px;color:#ff4f00}.dark .dl-band-row-icon{color:#ff8a5c}.dl-band-row-icon svg{width:16px;height:16px}.dl-band-row-title{font-size:.9375rem;font-weight:600;color:var(--foreground, #18181b)}.dark .dl-band-row-title{color:var(--foreground, #fafafa)}.dl-band-row:hover .dl-band-row-title{text-decoration:underline}.dl-band-row-desc{font-size:.875rem;line-height:1.5;color:var(--muted-foreground, #52525b)}.dark .dl-band-row-desc{color:var(--muted-foreground, #a1a1aa)}@media screen and (max-width:900px){.dl-bands{grid-template-columns:1fr}}"}],"page":{"pagePath":"powered-by-zapier/api-reference/common-types/app","slug":"/powered-by-zapier/api-reference/common-types/app","pageMetadata":{"openapi-schema":"Apps","title":null,"description":null,"href":"/powered-by-zapier/api-reference/common-types/app"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi-schema":"Apps","title":null,"description":null,"href":"/powered-by-zapier/api-reference/common-types/app"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/zapier-82f0e938/f426fe1f80e04ec5/content/welcome.js","/_mintlify/custom/zapier-82f0e938/8e22ee5176c0f2d3/content/page-view.js","/_mintlify/custom/zapier-82f0e938/ba23268896a334a3/content/events-core.js","/_mintlify/custom/zapier-82f0e938/a4a4aa1a440a45f6/content/webmcp.js","/_mintlify/custom/zapier-82f0e938/00b5c2b78afe2715/logo-nav.js","/_mintlify/custom/zapier-82f0e938/4312bb950916a05a/universal-footer.js"],"openApiReferenceData":{"schemaData":{"type":"object","description":"An app that integrates with Zapier","properties":{"id":{"type":"string","description":"Unique id of the app","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"image":{"type":"string","description":"Default image/icon to represent the app.","isRequired":true,"uniqueKey":"image","typeLabel":"string"},"links":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"links.additionalProperties","typeLabel":"any"},"description":"A url that, when visited, will direct the user to authenticate with the app and allow Zapier access to the app, thus creating a new Authentication.\n\n If value is `null`, then no authentication is required to use the app. Client ID-authenticated requests will never have this object's fields populated.","isRequired":true,"uniqueKey":"links","typeLabel":"object"},"action_types":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"action_types.items.[INDEX]","typeLabel":"any"},"description":"A list of action types for this specific App","isRequired":true,"uniqueKey":"action_types","typeLabel":"any[]"},"title":{"type":"string","description":"Human readable name of the app","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"images":{"type":"object","description":"The URL of images (of various sizes) for this specific App","required":["url_128x128","url_16x16","url_32x32","url_64x64"],"properties":{"url_16x16":{"type":"string","description":"16x16 resolution image URL","isRequired":true,"uniqueKey":"images.url_16x16","typeLabel":"string"},"url_32x32":{"type":"string","description":"32x32 resolution image URL","isRequired":true,"uniqueKey":"images.url_32x32","typeLabel":"string"},"url_64x64":{"type":"string","description":"64x64 resolution image URL","isRequired":true,"uniqueKey":"images.url_64x64","typeLabel":"string"},"url_128x128":{"type":"string","description":"128x128 resolution image URL","isRequired":true,"uniqueKey":"images.url_128x128","typeLabel":"string"}},"isRequired":true,"uniqueKey":"images","typeLabel":"object"},"hex_color":{"type":"string","description":"A branded color that can be used to represent the app.","isRequired":true,"uniqueKey":"hex_color","typeLabel":"string"},"categories":{"type":"array","items":{"type":"object","description":"Category an app belongs to.","properties":{"slug":{"type":"string","description":"The shortened slug name for this category","isRequired":true,"uniqueKey":"categories.items.[INDEX].slug","typeLabel":"string"}},"required":["slug"],"uniqueKey":"categories.items.[INDEX]","typeLabel":"object"},"description":"A list of categories to which this app belongs. Helpful in identifying apps by type and functionality.","isRequired":true,"uniqueKey":"categories","typeLabel":"object[]"},"description":{"type":"string","description":"Human readable description of the app.","isRequired":true,"uniqueKey":"description","typeLabel":"string"},"key":{"oneOf":[{"type":"string","description":"A stable, versionless key that identifies the app's current implementation (e.g. `HubSpotCLIAPI`).","uniqueKey":"key.oneOf.0","typeLabel":"string"},{"type":"null","description":"A stable, versionless key that identifies the app's current implementation (e.g. `HubSpotCLIAPI`).","uniqueKey":"key.oneOf.1","typeLabel":"null"}],"uniqueKey":"key","typeLabel":"string | null"},"selected_api":{"oneOf":[{"type":"string","description":"The latest versioned identifier for the app's current implementation (e.g. `HubSpotCLIAPI@1.4.18`). For versionless implementations this matches `key` (e.g. `GoogleSheetsV2API`). This is the latest promoted version, not a pinned or historical version.","uniqueKey":"selected_api.oneOf.0","typeLabel":"string"},{"type":"null","description":"The latest versioned identifier for the app's current implementation (e.g. `HubSpotCLIAPI@1.4.18`). For versionless implementations this matches `key` (e.g. `GoogleSheetsV2API`). This is the latest promoted version, not a pinned or historical version.","uniqueKey":"selected_api.oneOf.1","typeLabel":"null"}],"uniqueKey":"selected_api","typeLabel":"string | null"},"type":{"type":"string","default":"app","description":"The type of this object.","uniqueKey":"type","typeLabel":"string"}},"required":["action_types","categories","description","hex_color","id","image","images","links","title"],"uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"id":"\u003cstring>","image":"\u003cstring>","links":{},"action_types":["\u003cunknown>"],"title":"\u003cstring>","images":{"url_16x16":"\u003cstring>","url_32x32":"\u003cstring>","url_64x64":"\u003cstring>","url_128x128":"\u003cstring>"},"hex_color":"\u003cstring>","categories":[{"slug":"\u003cstring>"}],"description":"\u003cstring>","key":"\u003cstring>","selected_api":"\u003cstring>","type":"app"}}},"originalFileLocation":"https://api.zapier.com/schema"},"subdomain":"zapier-82f0e938","siteName":"Zapier","title":"App - Zapier","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T08:14:09.299Z","gitLastModified":"2025-11-07T20:52:55.000Z","originalFileLocation":"powered-by-zapier/api-reference/common-types/app.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Zapier\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"App - Zapier\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Zapier\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zapier-82f0e938.mintlify.app/_mintlify/api/og/v2?division=Common+Types\u0026amp;title=App\u0026amp;theme=d7e460cb9cc5ba95e728a619\u0026amp;signature=2cf266a5f713274cf2907e1898cf21752b09e6406c83c4ae03d85b42d9d6e9b9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"App - Zapier\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zapier-82f0e938.mintlify.app/_mintlify/api/og/v2?division=Common+Types\u0026amp;title=App\u0026amp;theme=d7e460cb9cc5ba95e728a619\u0026amp;signature=2cf266a5f713274cf2907e1898cf21752b09e6406c83c4ae03d85b42d9d6e9b9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/zapier-82f0e938/YBlPOOl2M7kSqqiA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Zapier\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF4F00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/powered-by-zapier/api-reference/common-types/app.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zapier.com/#organization\",\"name\":\"Zapier\",\"url\":\"https://docs.zapier.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zapier-82f0e938/uPbDC0jSuXgHCaWD/logo/light.svg?fit=max\u0026auto=format\u0026n=uPbDC0jSuXgHCaWD\u0026q=85\u0026s=b6a37289cb22ac1a9681572651874765\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zapier.com#website\",\"name\":\"Zapier\",\"url\":\"https://docs.zapier.com\",\"publisher\":{\"@id\":\"https://docs.zapier.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app#webpage\",\"url\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app\",\"name\":\"App\",\"dateModified\":\"2025-11-07T20:52:55.000Z\",\"isPartOf\":{\"@id\":\"https://docs.zapier.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API specification\",\"item\":\"https://docs.zapier.com/powered-by-zapier/api-reference/oauth-scopes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Schemas\",\"item\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/action\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Common Types\",\"item\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/action\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"App\",\"item\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app#apireference\",\"headline\":\"App\",\"name\":\"App\",\"url\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zapier.com/powered-by-zapier/api-reference/common-types/app#webpage\"},\"dateModified\":\"2025-11-07T20:52:55.000Z\",\"publisher\":{\"@id\":\"https://docs.zapier.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zapier.com#website\"}}]}\u003c/script>","siteName":"Zapier","nav":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://community.zapier.com/"},{"anchor":"Changelog","icon":"rss","href":"/white-label/changelog"},{"anchor":"Contact Us","icon":"envelope","href":"https://developer.zapier.com/contact"}]},"tabs":[{"tab":"Home","hidden":true,"searchable":true,"pages":[{"mode":"custom","title":"Zapier developer docs: MCP, SDK, integrations, and embedding","sidebarTitle":"Zapier developer documentation","href":""}]},{"tab":"Use Zapier in your tools","menu":[{"item":"Install Zapier","description":"Gets you to a first action. Zapier MCP by default, with the SDK and CLI as alternatives.","pages":[{"title":"Zapier developer tools installation: MCP, SDK, CLI setup","sidebarTitle":"Install Zapier","href":"/install"}]},{"item":"Zapier MCP","description":"Connect from inside your AI client. Your agent runs actions across 9,000+ apps.","groups":[{"group":"Overview","pages":[{"title":"Zapier MCP: Model Context Protocol for 9,000+ app integrations","sidebarTitle":"What is Zapier MCP","href":"/mcp/home"},{"title":"How Zapier MCP servers work","sidebarTitle":"How servers work","href":"/mcp/overview/how-servers-work"},{"title":"How Zapier MCP connections work: OAuth and connection tokens","sidebarTitle":"How connections work","href":"/mcp/overview/how-connections-work"},{"title":"How Zapier MCP tools work","sidebarTitle":"How tools work","href":"/mcp/overview/how-tools-work"},{"title":"Usage and billing","sidebarTitle":"Usage and billing","href":"/mcp/overview/usage"}]},{"group":"Get started","pages":[{"title":"Zapier MCP quickstart: connect your MCP client and run your first tool call","sidebarTitle":"Quickstart","href":"/mcp/get-started/quickstart"},{"group":"Roll out to multiple users","root":{"title":"How an organization rollout of Zapier MCP works","sidebarTitle":"Roll out to multiple users","href":"/mcp/get-started/rollout/overview"},"pages":[{"title":"Roll out Zapier MCP to your Claude organization","sidebarTitle":"Claude","href":"/mcp/get-started/rollout/claude"},{"title":"Roll out Zapier MCP to your ChatGPT workspace","sidebarTitle":"ChatGPT","href":"/mcp/get-started/rollout/chatgpt"},{"title":"Roll out Zapier MCP to your Cursor team","sidebarTitle":"Cursor","href":"/mcp/get-started/rollout/cursor"},{"title":"Roll out Zapier MCP to your Slack workspace","sidebarTitle":"Slack","href":"/mcp/get-started/rollout/slack"}]},{"group":"Connect your MCP client","pages":[{"title":"Zapier MCP for Amazon Quick Suite: add an MCP server","sidebarTitle":"Amazon Quick Suite","href":"/mcp/get-started/connect/amazon-quick-suite"},{"title":"Zapier MCP for the Anthropic API: setup with a token","sidebarTitle":"Anthropic API","href":"/mcp/get-started/connect/anthropic-api"},{"title":"Zapier MCP for Antigravity: setup with the /mcp add command","sidebarTitle":"Antigravity","href":"/mcp/get-started/connect/antigravity"},{"title":"Zapier MCP for ChatGPT: setup with a workspace app or custom plugin","sidebarTitle":"ChatGPT","href":"/mcp/get-started/connect/chatgpt"},{"title":"Zapier MCP for Claude: setup with the Zapier connector","sidebarTitle":"Claude","href":"/mcp/get-started/connect/claude"},{"title":"Zapier MCP for Claude Code: setup with one CLI command","sidebarTitle":"Claude Code","href":"/mcp/get-started/connect/claude-code"},{"title":"Zapier MCP for Claude Cowork: add the Zapier connector","sidebarTitle":"Claude Cowork","href":"/mcp/get-started/connect/claude-cowork"},{"title":"Zapier MCP for Claude for Small Business: add the connector","sidebarTitle":"Claude for Small Business","href":"/mcp/get-started/connect/claude-small-business"},{"title":"Zapier MCP for Codex: setup with the mcp add command","sidebarTitle":"Codex","href":"/mcp/get-started/connect/codex"},{"title":"Zapier MCP for Cursor: setup with the team or marketplace plugin","sidebarTitle":"Cursor","href":"/mcp/get-started/connect/cursor"},{"title":"Zapier MCP for Figma Make: add the built-in connector","sidebarTitle":"Figma Make","href":"/mcp/get-started/connect/figma"},{"title":"Zapier MCP for Gemini Enterprise: setup with a data store","sidebarTitle":"Gemini Enterprise","href":"/mcp/get-started/connect/gemini-enterprise"},{"title":"Zapier MCP for Grok Bot: setup with a marketplace plugin","sidebarTitle":"Grok Bot","href":"/mcp/get-started/connect/grok-bot"},{"title":"Zapier MCP for Julius AI: add an MCP data connection","sidebarTitle":"Julius","href":"/mcp/get-started/connect/julius"},{"title":"Zapier MCP for Kiro: setup with your MCP config file","sidebarTitle":"Kiro","href":"/mcp/get-started/connect/kiro"},{"title":"Zapier MCP for Linear: add a custom MCP server URL","sidebarTitle":"Linear","href":"/mcp/get-started/connect/linear"},{"title":"Zapier MCP for Manus: setup with a connection token","sidebarTitle":"Manus","href":"/mcp/get-started/connect/manus"},{"title":"Zapier MCP for Microsoft Copilot Studio: add a tool","sidebarTitle":"Microsoft Copilot Studio","href":"/mcp/get-started/connect/microsoft-copilot-studio"},{"title":"Zapier MCP for Mistral Le Chat: add the Zapier connector","sidebarTitle":"Mistral","href":"/mcp/get-started/connect/mistral"},{"title":"Zapier MCP for Muse: setup from the Connectors settings","sidebarTitle":"Muse","href":"/mcp/get-started/connect/muse"},{"title":"Zapier MCP for OpenAI Agent Builder: setup with a token","sidebarTitle":"OpenAI Agent Builder","href":"/mcp/get-started/connect/openai-agent-builder"},{"title":"Zapier MCP for the OpenAI API: setup with a connection token","sidebarTitle":"OpenAI API","href":"/mcp/get-started/connect/openai-api"},{"title":"Zapier MCP for OpenClaw: setup with a pasted prompt","sidebarTitle":"OpenClaw","href":"/mcp/get-started/connect/openclaw"},{"title":"Zapier MCP for OpenCode: setup with the config file","sidebarTitle":"OpenCode","href":"/mcp/get-started/connect/opencode"},{"title":"Zapier MCP for Python: setup with a connection token","sidebarTitle":"Python","href":"/mcp/get-started/connect/python"},{"title":"Zapier MCP for Ravenala: setup with a connection token","sidebarTitle":"Ravenala","href":"/mcp/get-started/connect/ravenala"},{"title":"Zapier MCP for Replit Agent: add an MCP server endpoint","sidebarTitle":"Replit","href":"/mcp/get-started/connect/replit"},{"title":"Zapier MCP for Slack: setup in Slackbot with OAuth","sidebarTitle":"Slack","href":"/mcp/get-started/connect/slack"},{"title":"Zapier MCP for Superhuman Go: add the built-in connector","sidebarTitle":"Superhuman Go","href":"/mcp/get-started/connect/superhuman-go"},{"title":"Zapier MCP for Toolhouse: setup with a connection token","sidebarTitle":"Toolhouse","href":"/mcp/get-started/connect/toolhouse"},{"title":"Zapier MCP for TypeScript: setup with a connection token","sidebarTitle":"TypeScript","href":"/mcp/get-started/connect/typescript"},{"title":"Zapier MCP for v0: add an MCP connection over OAuth","sidebarTitle":"v0","href":"/mcp/get-started/connect/v0"},{"title":"Zapier MCP for Vapi: setup with a connection token","sidebarTitle":"Vapi","href":"/mcp/get-started/connect/vapi"},{"title":"Zapier MCP for VS Code: setup with the one-click install","sidebarTitle":"VS Code","href":"/mcp/get-started/connect/vscode"},{"title":"Zapier MCP for Warp: setup with the MCP settings menu","sidebarTitle":"Warp","href":"/mcp/get-started/connect/warp"},{"title":"Zapier MCP for Windsurf: setup with mcp_config.json","sidebarTitle":"Windsurf","href":"/mcp/get-started/connect/windsurf"},{"title":"Zapier MCP for Zed: setup with remote MCP server settings","sidebarTitle":"Zed","href":"/mcp/get-started/connect/zed"},{"title":"Zapier MCP for any MCP client: setup with a connection token","sidebarTitle":"Other","href":"/mcp/get-started/connect/other"}]},{"title":"Create your first Next Gen Zap with your MCP client","sidebarTitle":"Create a Next Gen Zap","href":"/mcp/get-started/build-a-workflow"},{"title":"Tool bundles","sidebarTitle":"Tool bundles","href":"/mcp/get-started/tool-bundles"}]},{"group":"Manage","pages":[{"title":"Add multiple MCP clients into one server","sidebarTitle":"Add multiple clients","href":"/mcp/manage/add-multiple-clients"},{"title":"Configure your actions","sidebarTitle":"Configure your actions","href":"/mcp/manage/configure-your-actions"},{"title":"Switch between agentic and managed mode","sidebarTitle":"Switch modes","href":"/mcp/manage/switch-modes"},{"title":"Create and manage Zapier MCP skills","sidebarTitle":"Skills","href":"/mcp/manage/skills"},{"title":"Share access to your MCP server","sidebarTitle":"Server access","href":"/mcp/manage/server-access"},{"title":"Zapier MCP security: SOC 2 access controls \u0026 compliance","sidebarTitle":"Security","href":"/mcp/manage/security"}]},{"group":"Embed","pages":[{"title":"Embed Zapier MCP: Governed access to 9,000+ apps for MCP clients","sidebarTitle":"Get started","href":"/mcp/embed/getting-started"},{"title":"Zapier MCP embed code: web component integration across frameworks","sidebarTitle":"Embed code","href":"/mcp/embed/getting-embed-code"},{"title":"Zapier MCP embed: SDK connection guide for TypeScript and Python","sidebarTitle":"SDK connection guide","href":"/mcp/embed/sdk-connection-guide"}]},{"group":"Troubleshoot","pages":[{"title":"McpAuthorizationError","sidebarTitle":"Auth error","href":"/mcp/troubleshoot/authorization-error"},{"title":"Sign-in completes in browser but MCP client does not connect","sidebarTitle":"Sign-in issue","href":"/mcp/troubleshoot/sign-in-not-completing"},{"title":"Zapier MCP server connection timeout: Diagnostic steps","sidebarTitle":"Connection timeout","href":"/mcp/troubleshoot/connection-times-out"},{"title":"MCP tools return \"not found\" (404) errors","sidebarTitle":"404 errors","href":"/mcp/troubleshoot/tools-return-404"},{"title":"Tools are missing in your MCP client","sidebarTitle":"Missing tools","href":"/mcp/troubleshoot/tools-missing-in-client"},{"title":"MCP tools work once but fail on the next try","sidebarTitle":"Tools fail","href":"/mcp/troubleshoot/tools-fail-after-first-call"},{"title":"A tool call fails without an error message","sidebarTitle":"No error message","href":"/mcp/troubleshoot/tool-call-no-error"},{"title":"A specific app is not working","sidebarTitle":"App not working","href":"/mcp/troubleshoot/app-connection-issue"}]}]},{"item":"Zapier SDK","description":"TypeScript for code projects, with OAuth and retries handled. Open beta.","groups":[{"group":"Getting Started","pages":[{"title":"Zapier SDK: TypeScript SDK for 9,000+ app integrations","sidebarTitle":"Zapier SDK","href":"/sdk"},{"title":"Zapier SDK quickstart: TypeScript setup for Node.js 20+","sidebarTitle":"Quickstart","href":"/sdk/quickstart"},{"title":"Zapier CLI: terminal interface for 9,000+ authenticated APIs","sidebarTitle":"Using the CLI","href":"/sdk/using-the-cli"},{"title":"Deploy","href":"/sdk/deploy"},{"title":"Using Triggers","href":"/sdk/using-triggers"},{"title":"Permissions","tag":"Experimental","href":"/sdk/permissions"}]},{"group":"Reference","pages":[{"title":"Zapier SDK API reference: methods, types, and authentication","sidebarTitle":"API reference","href":"/sdk/reference"},{"title":"CLI Reference","href":"/sdk/cli-reference"},{"title":"Changelog","href":"/sdk/changelog"}]}]},{"item":"Proxy API","description":"Make authenticated HTTP requests to any app API through Zapier.","groups":[{"group":" ","pages":[{"title":"What is the Proxy API?","sidebarTitle":"Proxy API","href":"/proxy-api/overview"}]}]},{"item":"Zapier Connectors","description":"Ready-made toolkits your agent can use, one per app. Prototype.","groups":[{"group":"Get started","pages":[{"title":"What is a Zapier connector?","sidebarTitle":"Overview","href":"/connectors/overview"}]}]}]},{"tab":"Build a Zapier integration","menu":[{"item":"Developer Platform","description":"Build a private integration for your own team, or a public one for the App Directory.","groups":[{"group":" ","pages":[{"title":"Zapier integration builder: developer documentation and guides","sidebarTitle":"Welcome","icon":"party-horn","href":"/integrations"},{"title":"Integration platform login","url":"https://zapier.com/platform/login","icon":"user","href":"/integrations/dev-platform-login"},{"title":"Platform News","icon":"rss","href":"/integrations/news"}]},{"group":"Quick start","pages":[{"title":"Zapier Developer Platform integration guide: build with UI or CLI","sidebarTitle":"Introduction","href":"/integrations/quickstart/build-integration"},{"group":"Developer tools","pages":[{"title":"Platform UI vs Platform CLI","href":"/integrations/quickstart/ui-vs-cli"},{"title":"Zapier Developer Platform UI quickstart tutorial","sidebarTitle":"Platform UI tutorial","href":"/integrations/quickstart/ui-tutorial"},{"title":"Zapier Platform CLI tutorial: authentication, triggers, deployment","sidebarTitle":"Platform CLI tutorial","href":"/integrations/quickstart/cli-tutorial"},{"title":"Get help with the Zapier Developer Platform","href":"/integrations/quickstart/get-help"}]},{"group":"Glossary","pages":[{"title":"Zapier Glossary","mode":"wide","href":"/integrations/quickstart/glossary"}]},{"group":"How it works","pages":[{"title":"How Zapier integrations work: authentication, triggers, actions","sidebarTitle":"How Zapier works","href":"/integrations/quickstart/how-zapier-works"},{"title":"Zapier Developer Platform: Integration structure reference","sidebarTitle":"Integration structure","href":"/integrations/quickstart/zapier-integration-structure"},{"title":"Zapier integration types: private vs public developer guide","sidebarTitle":"Private vs public integrations","href":"/integrations/quickstart/private-vs-public-integrations"}]},{"title":"Zapier integration triggers and actions reference guide","sidebarTitle":"Recommended triggers and actions","href":"/integrations/quickstart/recommended-triggers-and-actions"},{"title":"App Developer Services","href":"/integrations/quickstart/app-developer-services"}]},{"group":"Build with UI","pages":[{"title":"Zapier Developer Platform UI quickstart tutorial","sidebarTitle":"Platform UI tutorial","href":"/integrations/quickstart/ui-tutorial"},{"group":"Actions","pages":[{"title":"Zapier actions: Create, search, delete API implementation","sidebarTitle":"Action","href":"/integrations/build/action"},{"title":"Add a create action","href":"/integrations/build/create"},{"title":"Add a search action","href":"/integrations/build/search"},{"title":"Reorder or remove action","href":"/integrations/build/reorder-action"},{"title":"Add a search or create action","href":"/integrations/build/search-or-create"}]},{"group":"Advanced features","pages":[{"title":"Zapier environment variables: OAuth and API key management","sidebarTitle":"Use environment variables in your API call","href":"/integrations/build/env"},{"title":"Add error response handling","href":"/integrations/build/errors"},{"title":"Reference user-entered details with data bundles","href":"/integrations/build/bundle"},{"title":"Use Code Mode to refine your API call","href":"/integrations/build/code-mode"},{"title":"Static IP address configuration for Zapier integrations","sidebarTitle":"Enable static IP address connection for customers","href":"/integrations/build/static-ip"}]},{"group":"Authentication","pages":[{"title":"Zapier integration authentication: OAuth v2, API key, session auth","sidebarTitle":"Overview","href":"/integrations/build/auth"},{"title":"Zapier API key authentication: implementation guide","sidebarTitle":"Add authentication with API key","href":"/integrations/build/apikeyauth"},{"title":"Basic authentication configuration in Zapier visual builder","sidebarTitle":"Basic authentication","href":"/integrations/build/basicauth"},{"title":"Add authentication with Digest Authentication","href":"/integrations/build/digestauth"},{"title":"OAuth v2 authentication configuration: Zapier Platform UI guide","sidebarTitle":"Add authentication with OAuth v2","href":"/integrations/build/oauth"},{"title":"Session auth implementation guide for Zapier integrations","sidebarTitle":"Session authentication","href":"/integrations/build/sessionauth"},{"title":"Add a connection label","href":"/integrations/build/connection-label"},{"title":"Use computed fields in OAuth or Session Authentication","href":"/integrations/build/computed-fields"},{"title":"Compute a field from the data of the Test API call","href":"/integrations/build/computed-test-field"},{"title":"Add authentication fields to Request Template","href":"/integrations/build/requesttemplate"},{"title":"Validate domain and subdomain input fields during authentication","href":"/integrations/build/subdomain-validation"}]},{"group":"Input fields","pages":[{"title":"Zapier Developer Platform input field types and definitions","sidebarTitle":"Field types","href":"/integrations/build/field-definitions"},{"title":"Zapier Platform UI: add input fields to triggers and actions","sidebarTitle":"Add input fields to triggers and actions","href":"/integrations/build/add-fields"},{"title":"Dynamic fields: Fetch API fields in Zapier integrations","sidebarTitle":"Dynamic fields","href":"/integrations/build/dynamic-field"},{"title":"Line item groups in Zapier actions: Developer documentation","sidebarTitle":"Line item groups","href":"/integrations/build/line-items"}]},{"group":"Output fields","pages":[{"title":"Sample data and output fields in Zapier integration triggers","sidebarTitle":"Output data, defining sample data and output fields","href":"/integrations/build/sample-data"},{"title":"Response types Zapier expects","href":"/integrations/build/response-types"}]},{"group":"Testing","pages":[{"title":"Test authentication","href":"/integrations/build/test-auth"},{"title":"Test triggers and actions - Zapier integration builder docs","sidebarTitle":"Test triggers or actions","href":"/integrations/build/test-triggers-actions"},{"title":"Zapier CLI canary testing: integration version validation","sidebarTitle":"Testing tools","href":"/integrations/build/test-tools"},{"title":"Test and monitor Zapier integrations: Zapier Developer Platform UI","sidebarTitle":"Test and monitor","href":"/integrations/build/test-monitoring"}]},{"group":"Triggers","pages":[{"title":"Zapier integration triggers: polling and REST Hook implementation","sidebarTitle":"Trigger","href":"/integrations/build/trigger"},{"title":"Add a polling trigger","href":"/integrations/build/polling-trigger"},{"title":"REST Hook trigger implementation guide: Zapier Platform UI","sidebarTitle":"Add a REST Hook trigger","href":"/integrations/build/hook-trigger"},{"title":"Reorder or remove triggers","href":"/integrations/build/reorder-trigger"},{"title":"Zapier polling trigger deduplication: Implementation guide","sidebarTitle":"Deduplication","href":"/integrations/build/deduplication"},{"title":"Use pagination in triggers","href":"/integrations/build/pagination-trigger"},{"title":"REST hook triggers: Zapier CLI webhook subscription guide","sidebarTitle":"REST Hook triggers","href":"/integrations/build/cli-hook-trigger"}]},{"group":"Troubleshooting","pages":[{"title":"Zapier operating constraints","href":"/integrations/build/operating-constraints"},{"title":"Troubleshoot trigger timeouts","href":"/integrations/build/troubleshoot-trigger-timeouts"},{"title":"Troubleshoot trigger request or response payload sizes","href":"/integrations/build/troubleshoot-trigger-payload"},{"title":"Zapier action timeouts: handling the 30-second limit","sidebarTitle":"Troubleshoot action timeouts","href":"/integrations/build/troubleshoot-action-timeouts"},{"title":"Troubleshoot Zapier action payload: 20MB response, 6MB request","sidebarTitle":"Troubleshoot payload size","href":"/integrations/build/troubleshoot-action-payload"},{"title":"Troubleshoot custom fields","href":"/integrations/build/troubleshoot-custom-fields"},{"title":"Reduce requests to your API","href":"/integrations/build/reduce-api-requests"},{"title":"Zapier throttle types: API, webhook, and polling limits","sidebarTitle":"Troubleshoot throttles","href":"/integrations/build/troubleshoot-throttles"},{"title":"Hydration/dehydration limits","href":"/integrations/build/hydration-limits"},{"title":"Error: An array is expected","href":"/integrations/build/error-array-expected"},{"title":"Error: Got a non-object result, expected an object from create","href":"/integrations/build/error-non-object"},{"title":"Error: Got a non-object result in the array, expected only objects","href":"/integrations/build/error-non-object-array"},{"title":"Error: Cannot retrieve App******CLIAPI@*** app","href":"/integrations/build/error-cannot-retrieve-app"}]},{"title":"Use form mode to setup your API calls","href":"/integrations/build/form-mode"}]},{"group":"Build with CLI","pages":[{"title":"Zapier Platform CLI tutorial: authentication, triggers, deployment","sidebarTitle":"Platform CLI tutorial","href":"/integrations/quickstart/cli-tutorial"},{"title":"Zapier Platform CLI: Node.js integration development framework","sidebarTitle":"Overview","href":"/integrations/build-cli/overview"},{"group":"Input fields","pages":[{"title":"Zapier CLI field types: Input, dynamic, line items","sidebarTitle":"Configuration","href":"/integrations/build-cli/input-fields"},{"title":"Zapier Developer Platform input field types and definitions","sidebarTitle":"Field types","href":"/integrations/build/field-definitions"},{"title":"Dynamic dropdowns: Zapier CLI API integration implementation","sidebarTitle":"Dynamic dropdowns","href":"/integrations/build-cli/dynamic-dropdowns"}]},{"title":"Zapier CLI: making HTTP requests with z.request","sidebarTitle":"Making HTTP requests","href":"/integrations/build-cli/making-http-requests"},{"title":"Testing and debugging","href":"/integrations/build-cli/testing-and-debugging"},{"title":"Zapier CLI: Dehydration and hydration for API optimization","sidebarTitle":"Hydration","href":"/integrations/build-cli/hydration"},{"title":"Zapier CLI TypeScript integration development guide","sidebarTitle":"TypeScript integrations","href":"/integrations/build-cli/typescript-integrations"},{"group":"Advanced topics","pages":[{"title":"Download the source code of a CLI integration","href":"/integrations/build-cli/download-source-code"},{"title":"Empty values in input data","sidebarTitle":"Empty values in input data","href":"/integrations/build-cli/empty-values-in-input-data"}]},{"title":"Zapier CLI FAQs: Node.js, XML/SOAP, pagination, and more","sidebarTitle":"FAQs","href":"/integrations/build-cli/faqs"},{"title":"Zapier CLI core reference: z object and bundle object","sidebarTitle":"Core reference","href":"/integrations/build-cli/core"},{"title":"CLI command reference","url":"https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md","href":"/integrations/reference/cli"},{"title":"Schema reference","url":"https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md","href":"/integrations/reference/schema"}]},{"group":"Manage","pages":[{"group":"Account and team","pages":[{"title":"Zapier integration teams: admin and collaborator roles","sidebarTitle":"Add team members to integration","href":"/integrations/manage/add-team"}]},{"group":"Integration changes","pages":[{"title":"Planning and implementing integration changes","href":"/integrations/manage/planning-changes"},{"title":"Change OAuth scope","href":"/integrations/manage/auth-scope"},{"title":"Change authentication type","href":"/integrations/manage/auth-scheme"},{"title":"Add required authentication field","href":"/integrations/manage/auth-required"},{"title":"Change authentication field keys","href":"/integrations/manage/auth-keys"},{"title":"Change trigger or action key","href":"/integrations/manage/change-keys"},{"title":"Add new required input field","href":"/integrations/manage/required-input"},{"title":"Change input form field key","href":"/integrations/manage/input-key"},{"title":"Change output field key","href":"/integrations/manage/output-key"},{"title":"Change output data response","href":"/integrations/manage/output"},{"title":"Change trigger from polling to REST Hook","href":"/integrations/manage/change-trigger"},{"title":"Update perform method for polling trigger","href":"/integrations/manage/change-perform"},{"title":"Changes to your API can impact your integration","href":"/integrations/manage/change-api"},{"title":"Zapier Developer Platform: Export UI integration to CLI","sidebarTitle":"Export to CLI","href":"/integrations/manage/export-cli"},{"title":"Export integration to Platform UI","href":"/integrations/manage/export-ui"},{"title":"Essential tips for integrating quality health practices","href":"/integrations/manage/essential-tips-iq"}]},{"group":"Integration performance","pages":[{"title":"Zapier integration API outage error handling reference","sidebarTitle":"API outage","href":"/integrations/manage/api-outage"},{"title":"Embed insights definitions","href":"/integrations/manage/embed-insights"},{"title":"Zapier integration issue tracker and user feedback","sidebarTitle":"User feedback and bugs","href":"/integrations/manage/user-feedback"},{"title":"Zapier error handling: HTTP status codes \u0026 API responses","sidebarTitle":"Error response handling","href":"/integrations/manage/error-handling"},{"title":"Active users retention","href":"/integrations/manage/active-users"},{"title":"Integration insights definitions","href":"/integrations/manage/integration-insights"},{"title":"Zap activation rates","href":"/integrations/manage/zap-activation"},{"title":"Embed activation rates","href":"/integrations/manage/embed-activation"}]},{"group":"Sharing","pages":[{"title":"Zapier integration sharing: public links and email invites","sidebarTitle":"Share your integration","href":"/integrations/manage/sharing"}]},{"group":"Versions","pages":[{"title":"Zapier integration versioning: semantic versioning implementation","sidebarTitle":"Versions","href":"/integrations/manage/versions"},{"title":"Work with labeled versions","href":"/integrations/manage/labeled-versions"},{"title":"Clone a version","href":"/integrations/manage/clone"},{"title":"Zapier integration version promotion: UI and CLI","sidebarTitle":"Promote a version","href":"/integrations/manage/promote"},{"title":"Zapier Developer Platform: Integration version migration","sidebarTitle":"Migrate users","href":"/integrations/manage/migrate"},{"title":"Automatic migrations between versions","href":"/integrations/manage/automatic-migrations"},{"title":"Version lifecycle states","href":"/integrations/manage/version-lifecycle-states"},{"title":"Zapier integration version deprecation and deletion process","sidebarTitle":"Deprecate a version","href":"/integrations/manage/deprecate"},{"title":"Manage a legacy integration","href":"/integrations/manage/versions-legacy"},{"title":"Integration CI Pipelines using Changesets and Snapshot Versions","href":"/integrations/manage/changeset-workflow"}]},{"title":"Manage integration maintenance preferences","href":"/integrations/manage/manage-integration-maintenance-preference"}]},{"group":"Publish","pages":[{"group":"Branding","pages":[{"title":"Zapier integration branding guidelines: logo, naming, and directory","sidebarTitle":"Integration branding guidelines","href":"/integrations/publish/branding-guidelines"},{"title":"Zapier integration branding: UI and CLI configuration","sidebarTitle":"Integration branding","href":"/integrations/publish/add-or-modify-branding"},{"title":"Add integration branding in Platform CLI","href":"/integrations/publish/branding-cli"}]},{"group":"Launch process","pages":[{"title":"Zapier public integration publishing: Developer Platform guide","sidebarTitle":"Build your first public integration on Zapier","href":"/integrations/publish/public-integration"},{"title":"Zapier integration guidelines: OAuth, webhooks, REST APIs","sidebarTitle":"Build guidelines","href":"/integrations/publish/integration-build-guidelines"},{"title":"Zapier integration publishing requirements documentation","sidebarTitle":"Publishing requirements","href":"/integrations/publish/integration-publishing-requirements"},{"title":"Zap templates: developer documentation for publishing workflows","sidebarTitle":"Zap templates","href":"/integrations/publish/zap-templates"},{"title":"Create help documentation for your users","href":"/integrations/publish/user-help"},{"title":"Best practices for showcasing your integration","href":"/integrations/publish/best-practices"},{"title":"Zapier Partner Sandbox: free developer workspace","sidebarTitle":"Zapier Partner Sandbox","href":"/integrations/publish/zps"}]},{"group":"Partner program","pages":[{"title":"Zapier Partner Program: 4-tier system for integration partners","sidebarTitle":"Partner Program","href":"/integrations/publish/partner-program"},{"title":"Integration success strategies","href":"/integrations/publish/partner-faq"},{"title":"Zapier partner program benefits by tier level","sidebarTitle":"Partner program benefits","href":"/integrations/publish/benefits-guide"}]},{"group":"Validation checks","pages":[{"title":"Zapier integration validation checks: error code reference","sidebarTitle":"Integration check reference","href":"/integrations/publish/integration-checks-reference"}]}]},{"group":"Embed","pages":[{"title":"Powered by Zapier: Embed guide for published integrations","sidebarTitle":"Powered by Zapier","href":"/integrations/embed/powered-by-zapier"}]},{"group":"Reference","pages":[{"group":"Use cases","pages":[{"title":"Zapier integration structure for a forms app","href":"/integrations/reference/forms-app"},{"title":"Zapier integration structure for a CRM app","href":"/integrations/reference/crm-app"},{"title":"Zapier integration structure for a project management app","href":"/integrations/reference/project-app"},{"title":"Zapier integration structure for an AI app","href":"/integrations/reference/ai-app"}]},{"group":"Video tutorials","pages":[{"title":"Creating dynamic dropdown fields","href":"/integrations/reference/dynamic-dropdown-tutorial"},{"title":"Managing integration team members","href":"/integrations/reference/managing-team-tutorial"},{"title":"Cloning a version","href":"/integrations/reference/cloning-a-version-tutorial"},{"title":"Promoting a version","href":"/integrations/reference/promoting-a-version-tutorial"},{"title":"Zapier integration OAuth v2 authentication tutorial","sidebarTitle":"OAuth v2 tutorial","href":"/integrations/reference/implementing-oauth-tutorial"},{"title":"Zapier environment variables: OAuth credential management tutorial","sidebarTitle":"Using environment variables","href":"/integrations/reference/using-environment-variables-tutorial"},{"title":"Utilizing Request Template","href":"/integrations/reference/request-template-tutorial"},{"title":"Embedding the Zapier Workflow Element","href":"/integrations/reference/zapier-workflow-element-tutorial"},{"title":"Implementing REST Hook triggers","href":"/integrations/reference/rest-hook-trigger-tutorial"},{"title":"Utilizing the Monitoring Tool","href":"/integrations/reference/monitoring-tool-tutorial"},{"title":"Zapier integration error handling: API response control","sidebarTitle":"Error handling tutorial","href":"/integrations/reference/error-handling-tutorial"},{"title":"Using Dictionary Fields","href":"/integrations/reference/dictionary-fields-tutorial"}]},{"title":"Zapier Custom Actions and API requests: Support policy","sidebarTitle":"Custom Actions and API requests","href":"/integrations/reference/custom-actions-api-requests"},{"title":"Scripting in converted legacy Web Builder integrations","href":"/integrations/reference/legacy-scripting"},{"title":"CLI command reference","url":"https://github.com/zapier/zapier-platform/blob/main/packages/cli/docs/cli.md","href":"/integrations/reference/cli"},{"title":"Schema reference","url":"https://github.com/zapier/zapier-platform/blob/main/packages/schema/docs/build/schema.md","href":"/integrations/reference/schema"}]}]}]},{"tab":"Embed Zapier","menu":[{"item":"Powered by Zapier","description":"Embed Zapier. Users pay Zapier directly.","groups":[{"group":"Powered by Zapier","pages":[{"title":"Powered by Zapier: embed automation workflows via API and SDK","sidebarTitle":"Introduction","href":"/powered-by-zapier"}]},{"group":"API authentication","pages":[{"title":"Getting started","href":"/powered-by-zapier/authentication/getting-started"},{"group":"Authentication methods","pages":[{"title":"User access token authentication: OAuth 2.0 for Zapier API","sidebarTitle":"User access token","href":"/powered-by-zapier/authentication/methods/user-access-token"},{"title":"Zapier API: app access token via OAuth client credentials","sidebarTitle":"App access token","href":"/powered-by-zapier/authentication/methods/app-access-token"},{"title":"Client ID authentication for Zapier V1 API endpoints","sidebarTitle":"Client ID","href":"/powered-by-zapier/authentication/methods/client-id"}]}]},{"group":"Embedding Zapier","pages":[{"title":"Getting started","href":"/powered-by-zapier/embedding-zapier/getting-started"},{"title":"Workflow Element","href":"/powered-by-zapier/embedding-zapier/workflow-element"},{"title":"Zapier embed insights: analytics metrics for embedded integrations","sidebarTitle":"Embed insights","href":"/powered-by-zapier/embedding-zapier/embed-insights"},{"title":"Element security","href":"/powered-by-zapier/embedding-zapier/elements-security"},{"title":"Pre-filled Zap workflows","href":"/powered-by-zapier/embedding-zapier/pre-filled-zap-workflows"}]},{"group":"Zap creation","pages":[{"title":"Getting started","href":"/powered-by-zapier/zap-creation/getting-started"},{"title":"How to build a workflow","href":"/powered-by-zapier/zap-creation/how-to-build-a-workflow"},{"title":"Fields and fieldsets","href":"/powered-by-zapier/zap-creation/fields-and-fieldsets"},{"title":"Zapier Workflow API: retrieve Zap workflows for embedded apps","sidebarTitle":"Retrieve Zap workflows","href":"/powered-by-zapier/zap-creation/retrieving-a-list-of-zap-workflows"},{"title":"Retrieving apps","href":"/powered-by-zapier/zap-creation/retrieving-apps"},{"title":"Selecting an action","href":"/powered-by-zapier/zap-creation/selecting-an-action"},{"title":"Selecting an authentication","href":"/powered-by-zapier/zap-creation/selecting-an-authentication"},{"title":"Testing a workflow","href":"/powered-by-zapier/zap-creation/testing-a-workflow"},{"title":"Known limitations","href":"/powered-by-zapier/zap-creation/known-limitations"},{"title":"Zapier API: hardcoding actions with stable key fields vs ID fields","sidebarTitle":"Hardcoding an action","href":"/powered-by-zapier/zap-creation/hardcoding-an-action"},{"title":"Filter actions","href":"/powered-by-zapier/zap-creation/filter-actions"},{"title":"Zapier Workflow API: quick account creation via OAuth","sidebarTitle":"Quick account creation","href":"/powered-by-zapier/zap-creation/quick-account-creation"}]},{"group":"Running actions","pages":[{"title":"Getting started","href":"/powered-by-zapier/running-actions/getting-started"},{"title":"Using stored actions","href":"/powered-by-zapier/running-actions/stored-actions"},{"title":"Creating action runs","href":"/powered-by-zapier/running-actions/create-action-run"},{"title":"Retrieving action run results","href":"/powered-by-zapier/running-actions/retrieve-action-run"},{"title":"Receiving action run callbacks","tag":"New","href":"/powered-by-zapier/running-actions/action-run-callbacks"}]},{"group":"Sponsor user automation","pages":[{"title":"Getting started","href":"/powered-by-zapier/sponsor-user-automation/getting-started"},{"title":"User enrollment","href":"/powered-by-zapier/sponsor-user-automation/user-enrollment"}]},{"group":"Managing app authentications","pages":[{"title":"Getting started","href":"/powered-by-zapier/managing-app-authentication/getting-started"},{"title":"Adding app authentications","href":"/powered-by-zapier/managing-app-authentication/adding-app-authentications"},{"title":"Get authentications","href":"/powered-by-zapier/managing-app-authentication/get-authentications"}]},{"group":"Zap templates","pages":[{"title":"Getting started","href":"/powered-by-zapier/zap-templates/getting-started"},{"title":"Retrieving Zap templates","href":"/powered-by-zapier/zap-templates/retrieving-zap-templates"}]},{"group":"AI workflows","pages":[{"title":"Zap Guesser API: generate workflow suggestions from descriptions","sidebarTitle":"Zap Guesser","href":"/powered-by-zapier/ai-workflows/zap-guesser"}]},{"group":"API specification","pages":[{"title":"OAuth scopes","href":"/powered-by-zapier/api-reference/oauth-scopes"},{"group":"Accounts","pages":[{"openapi":"https://api.zapier.com/schema get /v2/authorize","mode":"wide","title":"Create Account","href":"/powered-by-zapier/api-reference/accounts/create-account"},{"openapi":"https://api.zapier.com/schema get /v1/profiles/me","title":"User Profile","href":"/powered-by-zapier/api-reference/accounts/user-profile"}]},{"group":"Actions","pages":[{"openapi":"https://api.zapier.com/schema get /v2/actions","title":"Get Actions","href":"/powered-by-zapier/api-reference/actions/get-actions"},{"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/inputs/{input_id}/choices","title":"Get Choices","href":"/powered-by-zapier/api-reference/actions/get-choices"},{"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/inputs","title":"Get Input Fields","href":"/powered-by-zapier/api-reference/actions/get-input-fields"},{"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/outputs","title":"Get Output Fields","href":"/powered-by-zapier/api-reference/actions/get-output-fields"},{"openapi":"https://api.zapier.com/schema post /v2/action-runs","title":"Create an Action Run","href":"/powered-by-zapier/api-reference/actions/create-an-action-run"},{"openapi":"https://api.zapier.com/schema get /v2/action-runs/{id}","title":"Retrieve Action Run","href":"/powered-by-zapier/api-reference/actions/retrieve-action-run"},{"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/test","title":"Step Test","href":"/powered-by-zapier/api-reference/actions/step-test"},{"group":"Stored Actions","pages":[{"openapi":"api-reference/specs/actions.yaml get /actions/v1/stored-actions","title":"List stored actions","href":"/powered-by-zapier/api-reference/actions/stored-actions/list-stored-actions"},{"openapi":"api-reference/specs/actions.yaml post /actions/v1/stored-actions","title":"Create a stored action","href":"/powered-by-zapier/api-reference/actions/stored-actions/create-a-stored-action"},{"openapi":"api-reference/specs/actions.yaml get /actions/v1/stored-actions/{stored_action_id}","title":"Get a stored action","href":"/powered-by-zapier/api-reference/actions/stored-actions/get-a-stored-action"},{"openapi":"api-reference/specs/actions.yaml delete /actions/v1/stored-actions/{stored_action_id}","title":"Delete a stored action","href":"/powered-by-zapier/api-reference/actions/stored-actions/delete-a-stored-action"},{"openapi":"api-reference/specs/actions.yaml patch /actions/v1/stored-actions/{stored_action_id}","title":"Update a stored action","href":"/powered-by-zapier/api-reference/actions/stored-actions/update-a-stored-action"},{"openapi":"api-reference/specs/actions.yaml post /actions/v1/stored-actions/{stored_action_id}/run","title":"Run a stored action","href":"/powered-by-zapier/api-reference/actions/stored-actions/run-a-stored-action"},{"openapi":"api-reference/specs/actions.yaml get /actions/v1/stored-actions/{stored_action_id}/runs/{run_id}","title":"Get stored action run results","href":"/powered-by-zapier/api-reference/actions/stored-actions/get-stored-action-run-results"}]}]},{"group":"Apps","pages":[{"openapi":"https://api.zapier.com/schema get /v1/apps","title":"Get Apps v1","href":"/powered-by-zapier/api-reference/apps/get-apps-v1"},{"openapi":"https://api.zapier.com/schema get /v2/apps","title":"Get Apps v2","href":"/powered-by-zapier/api-reference/apps/get-apps-v2"}]},{"group":"Authentications","pages":[{"openapi":"https://api.zapier.com/schema get /v2/authentications","title":"Get Authentications","href":"/powered-by-zapier/api-reference/authentications/get-authentications"},{"openapi":"https://api.zapier.com/schema post /v2/authentications","title":"Create Authentication","href":"/powered-by-zapier/api-reference/authentications/create-authentication"},{"openapi":"https://api.zapier.com/schema delete /v2/authentications/{authentication_id}","title":"Delete Authentication","href":"/powered-by-zapier/api-reference/authentications/delete-authentication"}]},{"group":"Categories","pages":[{"openapi":"https://api.zapier.com/schema get /v1/categories","title":"Get Categories","href":"/powered-by-zapier/api-reference/categories/get-categories"}]},{"group":"Promotions","pages":[{"title":"Create promotion enrollment","openapi":"powered-by-zapier/api-reference/promotions-openapi.yaml post /v2/promotions","href":"/powered-by-zapier/api-reference/promotions/create-enrollment"},{"title":"Get promotion enrollment","openapi":"powered-by-zapier/api-reference/promotions-openapi.yaml get /v2/promotions/{enrollment_id}","href":"/powered-by-zapier/api-reference/promotions/get-enrollment"},{"title":"Delete promotion enrollment","openapi":"powered-by-zapier/api-reference/promotions-openapi.yaml delete /v2/promotions/{enrollment_id}","href":"/powered-by-zapier/api-reference/promotions/delete-enrollment"}]},{"group":"Zap templates","pages":[{"openapi":"https://api.zapier.com/schema get /v1/zap-templates","title":"Get Zap Templates","href":"/powered-by-zapier/api-reference/zap-templates/get-zap-templates"}]},{"group":"Zaps","pages":[{"openapi":"https://api.zapier.com/schema post /v2/zaps","title":"Zapier API reference: POST /v2/zaps create a Zap","sidebarTitle":"Create a Zap","href":"/powered-by-zapier/api-reference/zaps/create-a-zap"},{"openapi":"https://api.zapier.com/schema patch /v2/zaps/{id}","title":"Edit a Zap","href":"/powered-by-zapier/api-reference/zaps/patch-a-zap"},{"openapi":"https://api.zapier.com/schema delete /v2/zaps/{id}","title":"Delete a Zap","href":"/powered-by-zapier/api-reference/zaps/delete-a-zap"},{"openapi":"https://api.zapier.com/schema post /v2/zaps/{id}/enable","title":"Enable a Zap","href":"/powered-by-zapier/api-reference/zaps/enable-a-zap"},{"openapi":"https://api.zapier.com/schema post /v2/zaps/{id}/disable","title":"Disable a Zap","href":"/powered-by-zapier/api-reference/zaps/disable-a-zap"},{"openapi":"https://api.zapier.com/schema post /v2/guess","title":"Guess a Zap","href":"/powered-by-zapier/api-reference/zaps/guess-a-zap"},{"openapi":"https://api.zapier.com/schema get /v2/zap-runs","title":"Get Zap Runs","href":"/powered-by-zapier/api-reference/zaps/get-zap-runs"},{"openapi":"https://api.zapier.com/schema get /v1/zaps","title":"Get Zaps v1","href":"/powered-by-zapier/api-reference/zaps/get-zaps-v1"},{"openapi":"https://api.zapier.com/schema get /v2/zaps","title":"Get Zaps v2","href":"/powered-by-zapier/api-reference/zaps/get-zaps-v2"}]},{"group":"Experimental","pages":[{"openapi":"https://api.zapier.com/schema get /v2/whitelabel/apps","title":"Get Whitelabel Apps v2","href":"/powered-by-zapier/api-reference/experimental/get-whitelabel-apps"}]},{"group":"Schemas","pages":[{"group":"Common Types","pages":[{"title":null,"description":null,"href":"/powered-by-zapier/api-reference/common-types/action"},{"title":null,"href":"/powered-by-zapier/api-reference/common-types/app"},{"title":null,"description":null,"href":"/powered-by-zapier/api-reference/common-types/authentication"},{"title":null,"href":"/powered-by-zapier/api-reference/common-types/choice"},{"title":null,"href":"/powered-by-zapier/api-reference/common-types/fieldset"},{"title":null,"href":"/powered-by-zapier/api-reference/common-types/infoField"},{"title":null,"href":"/powered-by-zapier/api-reference/common-types/inputField"},{"title":null,"href":"/powered-by-zapier/api-reference/common-types/outputField"},{"title":null,"href":"/powered-by-zapier/api-reference/common-types/zap"},{"title":"Errors","href":"/powered-by-zapier/api-reference/common-types/errors"},{"title":"Requests","href":"/powered-by-zapier/api-reference/common-types/requests"},{"title":"Responses","href":"/powered-by-zapier/api-reference/common-types/responses"}]}]},{"title":"Rate limiting","href":"/powered-by-zapier/api-reference/rate-limiting"}]}]},{"item":"White Label","description":"Native automation. No user Zapier account; your product pays Zapier.","groups":[{"group":" ","pages":[{"title":"Zapier White Label: embed 9,000+ app integrations via API","sidebarTitle":"Getting started","href":"/white-label/getting-started"}]},{"group":"Use cases","pages":[{"title":"Embedded triggers","href":"/white-label/use-cases/embedded-triggers"},{"title":"Embedded actions","href":"/white-label/use-cases/embedded-actions"},{"title":"AI agent connections \u0026 automations","href":"/white-label/use-cases/ai-agent-connections"},{"title":"Zapier Workflow API: embedded automation implementation guide","sidebarTitle":"Embedded workflows","href":"/white-label/use-cases/embedded-workflows"}]},{"group":"Implementation","pages":[{"title":"Partner onboarding","href":"/white-label/implementation/partner-onboarding"},{"title":"Token exchange","href":"/white-label/implementation/token-exchange"},{"title":"Connection flow","href":"/white-label/implementation/connection-flow"},{"title":"Error handling","href":"/white-label/implementation/error-handling"}]},{"group":"Trigger Inbox","pages":[{"title":"What is the Trigger Inbox API?","sidebarTitle":"What is the Trigger Inbox API?","href":"/white-label/trigger-inbox/what-is-trigger-inbox-api"},{"title":"Trigger Inbox quickstart","sidebarTitle":"Quickstart","href":"/white-label/trigger-inbox/trigger-inbox-quickstart"},{"title":"Create a trigger inbox for an app","sidebarTitle":"Create a trigger inbox","href":"/white-label/trigger-inbox/create-trigger-inbox"},{"title":"Consuming messages","sidebarTitle":"Consuming messages","href":"/white-label/trigger-inbox/consuming-messages"},{"title":"Manage your inbox","sidebarTitle":"Manage your inbox","href":"/white-label/trigger-inbox/manage-your-inbox"},{"title":"Trigger Inbox errors","sidebarTitle":"Errors","href":"/white-label/trigger-inbox/errors"}]},{"group":"Connection webhooks","pages":[{"title":"What are connection webhooks?","sidebarTitle":"What are connection webhooks?","href":"/white-label/connection-webhooks/what-is-connection-webhooks"},{"title":"Connection webhooks quickstart","sidebarTitle":"Quickstart","href":"/white-label/connection-webhooks/connection-webhooks-quickstart"},{"title":"Verify signatures","sidebarTitle":"Verify signatures","href":"/white-label/connection-webhooks/verify-signatures"},{"title":"Event payload reference","sidebarTitle":"Event payload","href":"/white-label/connection-webhooks/payload-reference"},{"title":"Connection webhooks error handling","sidebarTitle":"Error handling","href":"/white-label/connection-webhooks/error-handling"}]}]}]},{"tab":"API reference","groups":[{"group":" ","pages":[{"title":"Zapier API reference: OpenAPI specs, endpoints, and schemas","sidebarTitle":"Overview","href":"/api-reference/overview"}]},{"group":"Trigger Inbox API","pages":[{"group":"Inboxes","pages":[{"title":"List all inboxes","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml get /trigger-inbox/v1/inboxes","href":"/api-reference/trigger-inbox/inboxes/list-all-inboxes"},{"title":"Ensure an inbox exists","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml put /trigger-inbox/v1/inboxes","href":"/api-reference/trigger-inbox/inboxes/ensure-an-inbox-exists"},{"title":"Create an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes","href":"/api-reference/trigger-inbox/inboxes/create-an-inbox"},{"title":"Get inbox details","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml get /trigger-inbox/v1/inboxes/{id}","href":"/api-reference/trigger-inbox/inboxes/get-inbox-details"},{"title":"Mark an inbox for deletion","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml delete /trigger-inbox/v1/inboxes/{id}","href":"/api-reference/trigger-inbox/inboxes/mark-an-inbox-for-deletion"},{"title":"Update inbox settings","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml patch /trigger-inbox/v1/inboxes/{id}","href":"/api-reference/trigger-inbox/inboxes/update-inbox-settings"},{"title":"Pause an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{id}/pause","href":"/api-reference/trigger-inbox/inboxes/pause-an-inbox"},{"title":"Resume an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{id}/resume","href":"/api-reference/trigger-inbox/inboxes/resume-an-inbox"},{"title":"Subscribe to inbox notifications over SSE","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml get /trigger-inbox/v1/inboxes/{inbox_id}/events","href":"/api-reference/trigger-inbox/inboxes/subscribe-to-inbox-notifications-over-sse"}]},{"group":"Inbox Messages","pages":[{"title":"List messages from an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml get /trigger-inbox/v1/inboxes/{inbox_id}/messages","href":"/api-reference/trigger-inbox/inbox-messages/list-messages-from-an-inbox"},{"title":"Lease messages from an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{inbox_id}/messages/lease","href":"/api-reference/trigger-inbox/inbox-messages/lease-messages-from-an-inbox"},{"title":"Acknowledge messages from an inbox","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{inbox_id}/messages/ack","href":"/api-reference/trigger-inbox/inbox-messages/acknowledge-messages-from-an-inbox"},{"title":"Release leased messages without acknowledging","deprecated":null,"version":null,"openapi":"/api-reference/specs/trigger-inbox.yaml post /trigger-inbox/v1/inboxes/{inbox_id}/messages/release","href":"/api-reference/trigger-inbox/inbox-messages/release-leased-messages-without-acknowledging"}]},{"group":"API Reference","pages":[{"title":"Message availability notification","version":null,"deprecated":null,"openapi":"/api-reference/specs/trigger-inbox.yaml webhook messageAvailable","href":"/api-reference/trigger-inbox/message-availability-notification"}]}]},{"group":"Actions API","pages":[{"group":"Stored Actions","pages":[{"title":"List stored actions","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml get /actions/v1/stored-actions","href":"/api-reference/actions/stored-actions/list-stored-actions"},{"title":"Create a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml post /actions/v1/stored-actions","href":"/api-reference/actions/stored-actions/create-a-stored-action"},{"title":"Get a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml get /actions/v1/stored-actions/{stored_action_id}","href":"/api-reference/actions/stored-actions/get-a-stored-action"},{"title":"Delete a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml delete /actions/v1/stored-actions/{stored_action_id}","href":"/api-reference/actions/stored-actions/delete-a-stored-action"},{"title":"Update a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml patch /actions/v1/stored-actions/{stored_action_id}","href":"/api-reference/actions/stored-actions/update-a-stored-action"},{"title":"Run a stored action","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml post /actions/v1/stored-actions/{stored_action_id}/run","href":"/api-reference/actions/stored-actions/run-a-stored-action"},{"title":"Get stored action run results","deprecated":null,"version":null,"openapi":"/api-reference/specs/actions.yaml get /actions/v1/stored-actions/{stored_action_id}/runs/{run_id}","href":"/api-reference/actions/stored-actions/get-stored-action-run-results"}]}]},{"group":"Workflow API","pages":[{"group":"Apps","pages":[{"title":"Get Apps v1","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/apps","href":"/api-reference/workflow/apps/get-apps-v1"},{"title":"Get Apps v2","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/apps","href":"/api-reference/workflow/apps/get-apps-v2"},{"title":"Get Whitelabel Apps v2","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/whitelabel/apps","href":"/api-reference/workflow/apps/get-whitelabel-apps-v2"}]},{"group":"Categories","pages":[{"title":"Get Categories","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/categories","href":"/api-reference/workflow/categories/get-categories"}]},{"group":"Accounts","pages":[{"title":"User Profile","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/profiles/me","href":"/api-reference/workflow/accounts/user-profile"},{"title":"Create Account","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/authorize","href":"/api-reference/workflow/accounts/create-account"}]},{"group":"Zap Templates","pages":[{"title":"Get Zap Templates","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/zap-templates","href":"/api-reference/workflow/zap-templates/get-zap-templates"}]},{"group":"Zaps","pages":[{"title":"Get Zaps v1","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v1/zaps","href":"/api-reference/workflow/zaps/get-zaps-v1"},{"title":"Guess a Zap Beta","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/guess","href":"/api-reference/workflow/zaps/guess-a-zap-beta"},{"title":"Get Zaps v2","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/zaps","href":"/api-reference/workflow/zaps/get-zaps-v2"},{"title":"Create a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/zaps","href":"/api-reference/workflow/zaps/create-a-zap"},{"title":"Delete a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema delete /v2/zaps/{id}","href":"/api-reference/workflow/zaps/delete-a-zap"},{"title":"Edit a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema patch /v2/zaps/{id}","href":"/api-reference/workflow/zaps/edit-a-zap"},{"title":"Disable a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/zaps/{id}/disable","href":"/api-reference/workflow/zaps/disable-a-zap"},{"title":"Enable a Zap","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/zaps/{id}/enable","href":"/api-reference/workflow/zaps/enable-a-zap"}]},{"group":"Actions","pages":[{"title":"Create an Action Run","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/action-runs","href":"/api-reference/workflow/actions/create-an-action-run"},{"title":"Retrieve Action Run","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/action-runs/{id}","href":"/api-reference/workflow/actions/retrieve-action-run"},{"title":"Get Actions","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/actions","href":"/api-reference/workflow/actions/get-actions"},{"title":"Get Input Fields","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/inputs","href":"/api-reference/workflow/actions/get-input-fields"},{"title":"Get Choices","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/inputs/{input_id}/choices","href":"/api-reference/workflow/actions/get-choices"},{"title":"Get Output Fields","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/outputs","href":"/api-reference/workflow/actions/get-output-fields"},{"title":"Step Test","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/actions/{action_id}/test","href":"/api-reference/workflow/actions/step-test"}]},{"group":"Authentications","pages":[{"title":"Get Authentications","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/authentications","href":"/api-reference/workflow/authentications/get-authentications"},{"title":"Create Authentication","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema post /v2/authentications","href":"/api-reference/workflow/authentications/create-authentication"},{"title":"Delete Authentication","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema delete /v2/authentications/{authentication_id}","href":"/api-reference/workflow/authentications/delete-authentication"}]},{"group":"Experimental","pages":[{"title":"Get Zap Runs","deprecated":null,"version":null,"openapi":"https://api.zapier.com/schema get /v2/zap-runs","href":"/api-reference/workflow/experimental/get-zap-runs"}]}]},{"group":"Connections API","pages":[{"group":"Connection Webhooks","pages":[{"title":"List connection webhooks","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml get /connections/v1/webhooks","href":"/api-reference/connections/connection-webhooks/list-connection-webhooks"},{"title":"Create a connection webhook","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml post /connections/v1/webhooks","href":"/api-reference/connections/connection-webhooks/create-a-connection-webhook"},{"title":"Retrieve a connection webhook","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml get /connections/v1/webhooks/{id}","href":"/api-reference/connections/connection-webhooks/retrieve-a-connection-webhook"},{"title":"Delete a connection webhook","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml delete /connections/v1/webhooks/{id}","href":"/api-reference/connections/connection-webhooks/delete-a-connection-webhook"},{"title":"Update a connection webhook","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml patch /connections/v1/webhooks/{id}","href":"/api-reference/connections/connection-webhooks/update-a-connection-webhook"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api-reference/specs/connections.yaml post /connections/v1/webhooks/{id}/test","href":"/api-reference/connections/connection-webhooks/send-a-test-delivery"}]}]},{"group":"Agentic Management","pages":[{"group":"Automations","pages":[{"title":"Enable Agentic Management for a workflow","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml post /agentic-management/v0/","href":"/api-reference/agentic-management/automations/enable-agentic-management-for-a-workflow"},{"title":"Get Agentic Management config for a workflow","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml get /agentic-management/v0/{workflow_id}","href":"/api-reference/agentic-management/automations/get-agentic-management-config-for-a-workflow"},{"title":"Disable Agentic Management for a workflow","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml delete /agentic-management/v0/{workflow_id}","href":"/api-reference/agentic-management/automations/disable-agentic-management-for-a-workflow"},{"title":"Update Agentic Management config for a workflow","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml patch /agentic-management/v0/{workflow_id}","href":"/api-reference/agentic-management/automations/update-agentic-management-config-for-a-workflow"},{"title":"Get the declared intent for a workflow version","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml get /agentic-management/v0/{workflow_id}/intent","href":"/api-reference/agentic-management/automations/get-the-declared-intent-for-a-workflow-version"},{"title":"Create or update the declared intent for a workflow version","deprecated":null,"version":null,"openapi":"/api-reference/specs/agentic-management.yaml put /agentic-management/v0/{workflow_id}/intent","href":"/api-reference/agentic-management/automations/create-or-update-the-declared-intent-for-a-workflow-version"}]}]}]}]},"basePath":"","title":"App - Zapier","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}