Webhooks notify your application when an Amplify resource changes. Each request contains the event type, occurrence time, and event-specific resource data.
Create a webhook
Configure and test a webhook from the Amplify dashboard.
Your endpoint should:
Accept HTTPS POST requests with JSON bodies.
Return a successful 2xx response after accepting an event.
Process events asynchronously when work may take time.
Store event_id values to prevent duplicate processing.
Amplify v1 does not currently provide webhook signatures. Use a private, difficult-to-guess HTTPS endpoint and apply network controls where possible.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Amplify API","colors":{"primary":"#9432FD","light":"#f0e9e9","dark":"#0f0f0f"},"logo":{"light":"https://mintcdn.com/amplify-developer/M_2-61fyoYKpwEEF/images/132.svg?fit=max\u0026auto=format\u0026n=M_2-61fyoYKpwEEF\u0026q=85\u0026s=d7587656c3dcdd060ed285b4bdf999f7","dark":"https://mintcdn.com/amplify-developer/M_2-61fyoYKpwEEF/images/Layer_2.svg?fit=max\u0026auto=format\u0026n=M_2-61fyoYKpwEEF\u0026q=85\u0026s=80252b3b83b6b9d859db26a6ce565f62","href":"https://amplify.xyz"},"favicon":{"light":"https://mintcdn.com/amplify-developer/M_2-61fyoYKpwEEF/images/Light.png?fit=max\u0026auto=format\u0026n=M_2-61fyoYKpwEEF\u0026q=85\u0026s=fa56bce305a672b362d9e94dc5994114","dark":"https://mintcdn.com/amplify-developer/M_2-61fyoYKpwEEF/images/FAV.png?fit=max\u0026auto=format\u0026n=M_2-61fyoYKpwEEF\u0026q=85\u0026s=2d71b900003a5f1910dadb9263a84c59"},"api":{"openapi":"openapi/customer-api.yaml","mdx":{"server":"https://api.amplify.xyz"}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"links":[{"href":"https://support.amplify.xyz/","label":"Support"}],"primary":{"type":"button","label":"API reference","href":"/api-reference/introduction"}},"fonts":{"family":"Inter"},"icons":{"library":"fontawesome"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Amplify","icon":"house","href":"https://amplify.xyz"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"amplify-developer","hasAudioNarration":false,"actualSubdomain":"amplify-developer","customDomains":["developer.amplify.xyz"],"gitSource":{"type":"github","owner":"rollieamplify","repo":"amplify-api","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6a9fdec386a420e4f71ce321","collectionId":"bbe2fd57-d7e5-4b7b-85d7-1bff7ad18037","liveDeploymentHistoryId":"6a9fdec386a420e4f71ce321","schemaVersion":"v3"},"entitlements":{},"buildId":"6aa82a6d15aedfc1153b429e","clientVersion":"0.0.3933","searchFilterCounts":[{"language":"default","tag":"Documents","count":28},{"language":"default","tag":"Templates","count":26},{"language":"default","tag":"Faxes","count":21},{"language":"default","tag":"Fields","count":14},{"language":"default","tag":"Contacts","count":14},{"language":"default","tag":"Numbers","count":12},{"language":"default","tag":"Variables","count":10},{"language":"default","tag":"Manage faxes","count":9},{"language":"default","tag":"Field rules","count":8},{"language":"default","tag":"Theme","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"vite-origin","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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"webhooks/overview","slug":"/webhooks/overview","pageMetadata":{"title":"Webhooks overview","description":"Receive asynchronous Amplify resource updates.","href":"/webhooks/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Receive asynchronous Amplify resource updates.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,ol:`ol`,p:`p`,..._provideComponents(),...props.components},{Card,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Webhooks notify your application when an Amplify resource changes. Each request contains the event type, occurrence time, and event-specific resource data.`}),`\n`,_jsx(Card,{title:`Create a webhook`,icon:`plus`,href:`/webhooks/create-webhook`,children:_jsx(_components.p,{children:`Configure and test a webhook from the Amplify dashboard.`})}),`\n`,_jsx(_components.p,{children:`Your endpoint should:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Accept HTTPS `,_jsx(_components.code,{children:`POST`}),` requests with JSON bodies.`]}),`\n`,_jsxs(_components.li,{children:[`Return a successful `,_jsx(_components.code,{children:`2xx`}),` response after accepting an event.`]}),`\n`,_jsx(_components.li,{children:`Process events asynchronously when work may take time.`}),`\n`,_jsxs(_components.li,{children:[`Store `,_jsx(_components.code,{children:`event_id`}),` values to prevent duplicate processing.`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Amplify v1 does not currently provide webhook signatures. Use a private, difficult-to-guess HTTPS endpoint and apply network controls where possible.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Webhooks overview","description":"Receive asynchronous Amplify resource updates.","href":"/webhooks/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"amplify-developer","siteName":"Amplify API","title":"Webhooks overview - Amplify API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-07T08:35:32.207Z","originalFileLocation":"webhooks/overview.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=\"description\" content=\"Receive asynchronous Amplify resource updates.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Amplify API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/amplify-developer/sHtwoP59Jr24uO4j/_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/amplify-developer/sHtwoP59Jr24uO4j/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/amplify-developer/sHtwoP59Jr24uO4j/_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/amplify-developer/sHtwoP59Jr24uO4j/_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/amplify-developer/sHtwoP59Jr24uO4j/_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/amplify-developer/sHtwoP59Jr24uO4j/_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/amplify-developer/sHtwoP59Jr24uO4j/_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/amplify-developer/sHtwoP59Jr24uO4j/_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/amplify-developer/sHtwoP59Jr24uO4j/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Webhooks overview - Amplify API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Receive asynchronous Amplify resource updates.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Amplify API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.amplify.xyz/webhooks/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://amplify-developer.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Webhooks+overview\u0026amp;description=Receive+asynchronous+Amplify+resource+updates.\u0026amp;theme=af2fed4cf2cdf589d9a63575\u0026amp;signature=dfe7c30b4de234c9fe386452eb21cc1466f95d624d91662a2e41d7d2696977f8\">\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=\"Webhooks overview - Amplify API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Receive asynchronous Amplify resource updates.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://amplify-developer.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Webhooks+overview\u0026amp;description=Receive+asynchronous+Amplify+resource+updates.\u0026amp;theme=af2fed4cf2cdf589d9a63575\u0026amp;signature=dfe7c30b4de234c9fe386452eb21cc1466f95d624d91662a2e41d7d2696977f8\">\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/amplify-developer/sHtwoP59Jr24uO4j/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Amplify API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9432FD\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.amplify.xyz/webhooks/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/webhooks/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.amplify.xyz/#organization\",\"name\":\"Amplify API\",\"url\":\"https://developer.amplify.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/amplify-developer/M_2-61fyoYKpwEEF/images/132.svg?fit=max\u0026auto=format\u0026n=M_2-61fyoYKpwEEF\u0026q=85\u0026s=d7587656c3dcdd060ed285b4bdf999f7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.amplify.xyz#website\",\"name\":\"Amplify API\",\"url\":\"https://developer.amplify.xyz\",\"publisher\":{\"@id\":\"https://developer.amplify.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.amplify.xyz/webhooks/overview#webpage\",\"url\":\"https://developer.amplify.xyz/webhooks/overview\",\"name\":\"Webhooks overview\",\"description\":\"Receive asynchronous Amplify resource updates.\",\"dateModified\":\"2026-09-07T08:35:32.207Z\",\"isPartOf\":{\"@id\":\"https://developer.amplify.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://developer.amplify.xyz/webhooks/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.amplify.xyz/webhooks/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Amplify API\",\"item\":\"https://developer.amplify.xyz\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhooks overview\",\"item\":\"https://developer.amplify.xyz/webhooks/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developer.amplify.xyz/webhooks/overview#article\",\"headline\":\"Webhooks overview\",\"name\":\"Webhooks overview\",\"description\":\"Receive asynchronous Amplify resource updates.\",\"url\":\"https://developer.amplify.xyz/webhooks/overview\",\"mainEntityOfPage\":{\"@id\":\"https://developer.amplify.xyz/webhooks/overview#webpage\"},\"dateModified\":\"2026-09-07T08:35:32.207Z\",\"publisher\":{\"@id\":\"https://developer.amplify.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.amplify.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Amplify API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Amplify API","nav":{"global":{"anchors":[{"anchor":"Amplify","icon":"house","href":"https://amplify.xyz"}]},"pages":[{"group":"Introduction","pages":[{"title":"Amplify API","href":"/index"},{"title":"Quickstart","href":"/quickstart"}]},{"group":"Guides","pages":[{"title":"Authentication","href":"/guides/authentication"},{"title":"API conventions","href":"/guides/api-conventions"},{"title":"Data formats","href":"/guides/data-formats"},{"title":"OCR and NLP response formats","href":"/guides/ocr-nlp-response-formats"},{"title":"Requests and responses","href":"/guides/requests-and-responses"},{"title":"Pagination","href":"/guides/pagination"},{"title":"Errors","href":"/guides/errors"},{"title":"Rate limits","description":"Monitor limits and recover from rate-limited requests.","href":"/guides/rate-limits"}]},{"group":"Webhooks","pages":[{"title":"Webhooks overview","href":"/webhooks/overview"},{"title":"Create a webhook","description":"Configure and test a webhook from the Amplify dashboard.","href":"/webhooks/create-webhook"},{"title":"Webhook events","href":"/webhooks/events"},{"title":"Verifying webhooks","href":"/webhooks/verifying-webhooks"},{"title":"Webhook retry behavior","href":"/webhooks/retry-behavior"}]},{"group":"Authentication","pages":[{"title":"Generate an access token","openapi":"POST /v1/auth","href":"/api-reference/authentication/generate-access-token"}]},{"group":"Faxes","pages":[{"group":"Send faxes","pages":[{"title":"Send a fax","openapi":"POST /v1/faxes/send","href":"/api-reference/fax/post-fax-send"},{"title":"Forward a fax","openapi":"POST /v1/faxes/forward","href":"/api-reference/fax/post-fax-forward"},{"title":"Resend a fax","openapi":"POST /v1/faxes/resend","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-resend.mdx"},{"title":"List sent faxes","openapi":"POST /v1/faxes/lists","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-lists.mdx"},{"title":"Get fax status","openapi":"POST /v1/faxes/status","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-status.mdx"},{"title":"List scheduled faxes","openapi":"GET /v1/faxes/schedule","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/get-faxes-schedule.mdx"},{"title":"Cancel a scheduled fax","openapi":"POST /v1/faxes/cancel-schedule","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-cancel-schedule.mdx"},{"title":"Cancel a fax","openapi":"POST /v1/faxes/cancel","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-cancel.mdx"}]},{"group":"Receive faxes","pages":[{"title":"List received faxes","openapi":"POST /v1/faxes/received","href":"/api-reference/customer-v1/fax-receive-faxes/post-faxes-received.mdx"},{"title":"List all received faxes","openapi":"GET /v1/faxes/all/received","href":"/api-reference/customer-v1/fax-receive-faxes/get-faxes-all-received.mdx"}]},{"group":"Manage faxes","pages":[{"title":"Assign a fax to a user","openapi":"POST /v1/faxes/assign","href":"/api-reference/customer-v1/fax-receive-faxes/post-faxes-assign.mdx"},{"title":"Unassign a fax from a user","openapi":"POST /v1/faxes/unassign","href":"/api-reference/customer-v1/fax-receive-faxes/post-faxes-unassign.mdx"},{"title":"Download a fax","openapi":"POST /v1/faxes/download","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-download.mdx"},{"title":"Get a fax transmission receipt","openapi":"POST /v1/faxes/transmission-receipt","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-transmission-receipt.mdx"},{"title":"List pending fax approvals","openapi":"POST /v1/faxes/pending-approval","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-pending-approval.mdx"},{"title":"Approve or reject a fax","openapi":"POST /v1/faxes/approval","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-approval.mdx"},{"title":"Mark a fax as done","openapi":"POST /v1/faxes/mark-as-done","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-mark-as-done.mdx"},{"title":"Mark a fax as not done","openapi":"POST /v1/faxes/mark-as-not-done","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/post-faxes-mark-as-not-done.mdx"},{"title":"Delete a fax","openapi":"DELETE /v1/faxes/delete","href":"/api-reference/customer-v1/fax-send-and-manage-faxes/delete-faxes-delete.mdx"}]},{"group":"OCR and NLP","pages":[{"title":"Request OCR and NLP processing","openapi":"POST /v1/ai/process","href":"/api-reference/customer-v1/fax-ocr-and-nlp/post-ai-process.mdx"},{"title":"Extract OCR and NLP data","openapi":"POST /v1/ai/extract","href":"/api-reference/customer-v1/fax-ocr-and-nlp/post-ai-extract.mdx"}]}]},{"group":"Workspace","pages":[{"group":"Labels","pages":[{"title":"List labels","openapi":"GET /v1/labels/list","href":"/api-reference/customer-v1/fax-labels/get-labels-list.mdx"},{"title":"Assign a label to a fax","openapi":"POST /v1/labels/assign","href":"/api-reference/customer-v1/fax-labels/post-labels-assign.mdx"},{"title":"Remove a label from a fax","openapi":"POST /v1/labels/remove","href":"/api-reference/customer-v1/fax-labels/post-labels-remove.mdx"}]},{"group":"Custom fields","pages":[{"title":"List fax custom fields","openapi":"POST /v1/custom/field/list","href":"/api-reference/customer-v1/fax-custom-fields/post-custom-field-list.mdx"},{"title":"Create or update a fax custom field","openapi":"POST /v1/custom/field/save","href":"/api-reference/customer-v1/fax-custom-fields/post-custom-field-save.mdx"},{"title":"Remove a fax custom field","openapi":"POST /v1/custom/field/remove","href":"/api-reference/customer-v1/fax-custom-fields/post-custom-field-remove.mdx"}]}]},{"group":"Numbers","pages":[{"title":"List available countries","openapi":"GET /v1/numbers/country-list","href":"/api-reference/customer-v1/numbers/get-numbers-country-list.mdx"},{"title":"List available areas","openapi":"POST /v1/numbers/area-list","href":"/api-reference/customer-v1/numbers/post-numbers-area-list.mdx"},{"title":"List available numbers","openapi":"POST /v1/numbers/available-list","href":"/api-reference/customer-v1/numbers/post-numbers-available-list.mdx"},{"title":"Search available numbers","openapi":"POST /v1/numbers/search","href":"/api-reference/customer-v1/numbers/post-numbers-search.mdx"},{"title":"List filled requirements","openapi":"POST /v1/numbers/filled_requirements","href":"/api-reference/customer-v1/numbers/post-numbers-filled-requirements.mdx"},{"title":"Purchase a number","openapi":"POST /v1/numbers/purchase","href":"/api-reference/customer-v1/numbers/post-numbers-purchase.mdx"},{"title":"Purchase a number with requirements","openapi":"POST /v1/numbers/purchase_with_requirements","href":"/api-reference/customer-v1/numbers/post-numbers-purchase-with-requirements.mdx"},{"title":"List owned numbers","openapi":"GET /v1/numbers/list","href":"/api-reference/customer-v1/numbers/get-numbers-list.mdx"},{"title":"Delete a number","openapi":"POST /v1/numbers/delete","href":"/api-reference/customer-v1/numbers/post-numbers-delete.mdx"},{"group":"Verification","pages":[{"title":"Create Address","openapi":"POST /v1/numbers/verification/create_address","href":"/api-reference/customer-v1/numbers-verification/post-numbers-verification-create-address.mdx"},{"title":"Upload Document","openapi":"POST /v1/numbers/verification/upload_document","href":"/api-reference/customer-v1/numbers-verification/post-numbers-verification-upload-document.mdx"},{"title":"Upload Did Requirements","openapi":"POST /v1/numbers/verification/upload_did_requirements","href":"/api-reference/customer-v1/numbers-verification/post-numbers-verification-upload-did-requirements.mdx"}]}]},{"group":"Contacts","pages":[{"title":"Create a contact","openapi":"POST /v1/contacts/create","href":"/api-reference/customer-v1/contacts/post-contacts-create.mdx"},{"title":"Upload patient doc","openapi":"POST /v1/contacts/upload-patient-doc","href":"/api-reference/customer-v1/contacts/post-contacts-upload-patient-doc.mdx"},{"title":"List contacts","openapi":"POST /v1/contacts/list","href":"/api-reference/customer-v1/contacts/post-contacts-list.mdx"},{"title":"Details","openapi":"POST /v1/contacts/details","href":"/api-reference/customer-v1/contacts/post-contacts-details.mdx"},{"title":"Update a contact","openapi":"POST /v1/contacts/update","href":"/api-reference/customer-v1/contacts/post-contacts-update.mdx"},{"title":"Delete a contact","openapi":"POST /v1/contacts/delete","href":"/api-reference/customer-v1/contacts/post-contacts-delete.mdx"},{"group":"Groups","pages":[{"title":"List contact groups","openapi":"GET /v1/contacts/group-list","href":"/api-reference/customer-v1/contacts-groups/get-contacts-group-list.mdx"},{"title":"Create a contact group","openapi":"POST /v1/contacts/group-create","href":"/api-reference/customer-v1/contacts-groups/post-contacts-group-create.mdx"},{"title":"Update a contact group","openapi":"POST /v1/contacts/group-update","href":"/api-reference/customer-v1/contacts-groups/post-contacts-group-update.mdx"},{"title":"Delete a contact group","openapi":"POST /v1/contacts/group-delete","href":"/api-reference/customer-v1/contacts-groups/post-contacts-group-delete.mdx"}]},{"group":"Custom Fields","pages":[{"title":"List contact custom fields","openapi":"GET /v1/contacts/custom-field/list","href":"/api-reference/customer-v1/contacts-custom-fields/get-contacts-custom-field-list.mdx"},{"title":"Create a contact custom field","openapi":"POST /v1/contacts/custom-field/create","href":"/api-reference/customer-v1/contacts-custom-fields/post-contacts-custom-field-create.mdx"},{"title":"Update a contact custom field","openapi":"POST /v1/contacts/custom-field/update","href":"/api-reference/customer-v1/contacts-custom-fields/post-contacts-custom-field-update.mdx"},{"title":"Delete a contact custom field","openapi":"POST /v1/contacts/custom-field/delete","href":"/api-reference/customer-v1/contacts-custom-fields/post-contacts-custom-field-delete.mdx"}]}]},{"group":"Documents","pages":[{"group":"Variables","pages":[{"title":"Create Variable","openapi":"POST /v1/esign_documents/{documentId}/variables","href":"/api-reference/customer-v1/collect-documents-document-variables/post-esign-documents-documentid-variables.mdx"},{"title":"List Variables","openapi":"GET /v1/esign_documents/{documentId}/variables","href":"/api-reference/customer-v1/collect-documents-document-variables/get-esign-documents-documentid-variables.mdx"},{"title":"Get Variable","openapi":"GET /v1/esign_documents/{documentId}/variables/{variableId}","href":"/api-reference/customer-v1/collect-documents-document-variables/get-esign-documents-documentid-variables-variableid.mdx"},{"title":"Update Variable","openapi":"PATCH /v1/esign_documents/{documentId}/variables/{variableId}","href":"/api-reference/customer-v1/collect-documents-document-variables/patch-esign-documents-documentid-variables-variableid.mdx"},{"title":"Delete Variable","openapi":"DELETE /v1/esign_documents/{documentId}/variables/{variableId}","href":"/api-reference/customer-v1/collect-documents-document-variables/delete-esign-documents-documentid-variables-variableid.mdx"}]},{"group":"Fields","pages":[{"title":"Create Fields","openapi":"POST /v1/esign_documents/{documentId}/fields","href":"/api-reference/customer-v1/collect-documents-document-fields/post-esign-documents-documentid-fields.mdx"},{"title":"List Fields","openapi":"GET /v1/esign_documents/{documentId}/fields","href":"/api-reference/customer-v1/collect-documents-document-fields/get-esign-documents-documentid-fields.mdx"},{"title":"Get Field","openapi":"GET /v1/esign_documents/{documentId}/fields/{fieldId}","href":"/api-reference/customer-v1/collect-documents-document-fields/get-esign-documents-documentid-fields-fieldid.mdx"},{"title":"Update Fields (Bulk)","openapi":"PATCH /v1/esign_documents/{documentId}/fields","href":"/api-reference/customer-v1/collect-documents-document-fields/patch-esign-documents-documentid-fields.mdx"},{"title":"Update Field (Single Route)","openapi":"PATCH /v1/esign_documents/{documentId}/fields/{fieldId}","href":"/api-reference/customer-v1/collect-documents-document-fields/patch-esign-documents-documentid-fields-fieldid.mdx"},{"title":"Delete Field","openapi":"DELETE /v1/esign_documents/{documentId}/fields/{fieldId}","href":"/api-reference/customer-v1/collect-documents-document-fields/delete-esign-documents-documentid-fields-fieldid.mdx"},{"title":"Delete Multiple Fields","openapi":"POST /v1/esign_documents/{documentId}/fields/delete","href":"/api-reference/customer-v1/collect-documents-document-fields/post-esign-documents-documentid-fields-delete.mdx"}]},{"group":"Theme","pages":[{"title":"Create document theme","openapi":"POST /v1/esign_documents/{documentId}/theme","href":"/api-reference/customer-v1/collect-documents-document-theme/post-esign-documents-documentid-theme.mdx"},{"title":"Get Theme","openapi":"GET /v1/esign_documents/{documentId}/theme","href":"/api-reference/customer-v1/collect-documents-document-theme/get-esign-documents-documentid-theme.mdx"},{"title":"Update document theme","openapi":"PATCH /v1/esign_documents/{documentId}/theme","href":"/api-reference/customer-v1/collect-documents-document-theme/patch-esign-documents-documentid-theme.mdx"},{"title":"Delete Theme","openapi":"DELETE /v1/esign_documents/{documentId}/theme","href":"/api-reference/customer-v1/collect-documents-document-theme/delete-esign-documents-documentid-theme.mdx"}]},{"group":"Field rules","pages":[{"title":"Create Field Rule","openapi":"POST /v1/esign_documents/{documentId}/field_rule","href":"/api-reference/customer-v1/collect-documents-document-field-rules/post-esign-documents-documentid-field-rule.mdx"},{"title":"List Field Rules","openapi":"GET /v1/esign_documents/{documentId}/field_rule","href":"/api-reference/customer-v1/collect-documents-document-field-rules/get-esign-documents-documentid-field-rule.mdx"},{"title":"Update Field Rule","openapi":"PATCH /v1/esign_documents/{documentId}/field_rule/{fieldRuleId}","href":"/api-reference/customer-v1/collect-documents-document-field-rules/patch-esign-documents-documentid-field-rule-fieldruleid.mdx"},{"title":"Delete Field Rule","openapi":"DELETE /v1/esign_documents/{documentId}/field_rule/{fieldRuleId}","href":"/api-reference/customer-v1/collect-documents-document-field-rules/delete-esign-documents-documentid-field-rule-fieldruleid.mdx"}]},{"group":"Document operations","pages":[{"title":"List Documents","openapi":"GET /v1/esign_documents","href":"/api-reference/customer-v1/collect-documents/get-esign-documents.mdx"},{"title":"Create Document","openapi":"POST /v1/esign_documents","href":"/api-reference/customer-v1/collect-documents/post-esign-documents.mdx"},{"title":"Get document status","openapi":"GET /v1/esign_documents/{documentId}","href":"/api-reference/customer-v1/collect-documents/get-esign-documents-documentid.mdx"},{"title":"Update Document","openapi":"PATCH /v1/esign_documents/{documentId}","href":"/api-reference/customer-v1/collect-documents/patch-esign-documents-documentid.mdx"},{"title":"Send Document","openapi":"POST /v1/esign_documents/{documentId}/send","href":"/api-reference/customer-v1/collect-documents/post-esign-documents-documentid-send.mdx"},{"title":"Download Document","openapi":"GET /v1/esign_documents/{documentId}/download","href":"/api-reference/customer-v1/collect-documents/get-esign-documents-documentid-download.mdx"},{"title":"Delete Document","openapi":"DELETE /v1/esign_documents/{documentId}","href":"/api-reference/customer-v1/collect-documents/delete-esign-documents-documentid.mdx"},{"title":"Delete Document Page","openapi":"DELETE /v1/esign_documents/{documentId}/pages/{pageNumber}","href":"/api-reference/customer-v1/collect-documents/delete-esign-documents-documentid-pages-pagenumber.mdx"}]}]},{"group":"Templates","pages":[{"group":"Variables","pages":[{"title":"Create Template Variable","openapi":"POST /v1/esign_templates/{templateId}/variables","href":"/api-reference/customer-v1/collect-templates-template-variables/post-esign-templates-templateid-variables.mdx"},{"title":"List Template Variables","openapi":"GET /v1/esign_templates/{templateId}/variables","href":"/api-reference/customer-v1/collect-templates-template-variables/get-esign-templates-templateid-variables.mdx"},{"title":"Get Template Variable","openapi":"GET /v1/esign_templates/{templateId}/variables/{templateVariableId}","href":"/api-reference/customer-v1/collect-templates-template-variables/get-esign-templates-templateid-variables-templatevariableid.mdx"},{"title":"Update Template Variable","openapi":"PATCH /v1/esign_templates/{templateId}/variables/{templateVariableId}","href":"/api-reference/customer-v1/collect-templates-template-variables/patch-esign-templates-templateid-variables-templatevariableid.mdx"},{"title":"Delete Template Variable","openapi":"DELETE /v1/esign_templates/{templateId}/variables/{templateVariableId}","href":"/api-reference/customer-v1/collect-templates-template-variables/delete-esign-templates-templateid-variables-templatevariableid.mdx"}]},{"group":"Theme","pages":[{"title":"Create template theme","openapi":"POST /v1/esign_templates/{templateId}/theme","href":"/api-reference/customer-v1/collect-templates-template-theme/post-esign-templates-templateid-theme.mdx"},{"title":"Get Template Theme","openapi":"GET /v1/esign_templates/{templateId}/theme","href":"/api-reference/customer-v1/collect-templates-template-theme/get-esign-templates-templateid-theme.mdx"},{"title":"Update template theme","openapi":"PATCH /v1/esign_templates/{templateId}/theme","href":"/api-reference/customer-v1/collect-templates-template-theme/patch-esign-templates-templateid-theme.mdx"},{"title":"Delete Template Theme","openapi":"DELETE /v1/esign_templates/{templateId}/theme","href":"/api-reference/customer-v1/collect-templates-template-theme/delete-esign-templates-templateid-theme.mdx"}]},{"group":"Fields","pages":[{"title":"Create Template Fields","openapi":"POST /v1/esign_templates/{templateId}/fields","href":"/api-reference/customer-v1/collect-templates-template-fields/post-esign-templates-templateid-fields.mdx"},{"title":"List Template Fields","openapi":"GET /v1/esign_templates/{templateId}/fields","href":"/api-reference/customer-v1/collect-templates-template-fields/get-esign-templates-templateid-fields.mdx"},{"title":"Get Template Field","openapi":"GET /v1/esign_templates/{templateId}/fields/{fieldTemplateId}","href":"/api-reference/customer-v1/collect-templates-template-fields/get-esign-templates-templateid-fields-fieldtemplateid.mdx"},{"title":"Update Template Fields (Bulk)","openapi":"PATCH /v1/esign_templates/{templateId}/fields","href":"/api-reference/customer-v1/collect-templates-template-fields/patch-esign-templates-templateid-fields.mdx"},{"title":"Update Template Field (Single Route)","openapi":"PATCH /v1/esign_templates/{templateId}/fields/{fieldTemplateId}","href":"/api-reference/customer-v1/collect-templates-template-fields/patch-esign-templates-templateid-fields-fieldtemplateid.mdx"},{"title":"Delete Template Field","openapi":"DELETE /v1/esign_templates/{templateId}/fields/{fieldTemplateId}","href":"/api-reference/customer-v1/collect-templates-template-fields/delete-esign-templates-templateid-fields-fieldtemplateid.mdx"},{"title":"Delete Multiple Template Fields","openapi":"POST /v1/esign_templates/{templateId}/fields/delete","href":"/api-reference/customer-v1/collect-templates-template-fields/post-esign-templates-templateid-fields-delete.mdx"}]},{"group":"Field rules","pages":[{"title":"Create Template Field Rule","openapi":"POST /v1/esign_templates/{templateId}/field_rule","href":"/api-reference/customer-v1/collect-templates-template-field-rules/post-esign-templates-templateid-field-rule.mdx"},{"title":"List Template Field Rules","openapi":"GET /v1/esign_templates/{templateId}/field_rule","href":"/api-reference/customer-v1/collect-templates-template-field-rules/get-esign-templates-templateid-field-rule.mdx"},{"title":"Update Template Field Rule","openapi":"PATCH /v1/esign_templates/{templateId}/field_rule/{templateFieldRuleId}","href":"/api-reference/customer-v1/collect-templates-template-field-rules/patch-esign-templates-templateid-field-rule-templatefieldruleid.mdx"},{"title":"Delete Template Field Rule","openapi":"DELETE /v1/esign_templates/{templateId}/field_rule/{templateFieldRuleId}","href":"/api-reference/customer-v1/collect-templates-template-field-rules/delete-esign-templates-templateid-field-rule-templatefieldruleid.mdx"}]},{"group":"Template operations","pages":[{"title":"List Templates","openapi":"GET /v1/esign_templates","href":"/api-reference/customer-v1/collect-templates/get-esign-templates.mdx"},{"title":"Create Template","openapi":"POST /v1/esign_templates","href":"/api-reference/customer-v1/collect-templates/post-esign-templates.mdx"},{"title":"Get template details","openapi":"GET /v1/esign_templates/{templateId}","href":"/api-reference/customer-v1/collect-templates/get-esign-templates-templateid.mdx"},{"title":"Update Template","openapi":"PATCH /v1/esign_templates/{templateId}","href":"/api-reference/customer-v1/collect-templates/patch-esign-templates-templateid.mdx"},{"title":"Delete Template","openapi":"DELETE /v1/esign_templates/{templateId}","href":"/api-reference/customer-v1/collect-templates/delete-esign-templates-templateid.mdx"},{"title":"Delete Template Page","openapi":"DELETE /v1/esign_templates/{templateId}/pages/{pageNumber}","href":"/api-reference/customer-v1/collect-templates/delete-esign-templates-templateid-pages-pagenumber.mdx"}]}]}]},"title":"Webhooks overview - Amplify API","buildId":"dpl_GnxaU9nEer7XK27kw3dpfPrs9geh","deploymentId":"dpl_GnxaU9nEer7XK27kw3dpfPrs9geh","dynamics":[],"chunks":[]}