Webhooks allow you to receive real-time updates about results from the Ready Health API. When you are getting set up, you will specify a URL where you wish to receive the requests.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ready Health - API Documentation","colors":{"primary":"#06BCC1","light":"#E9FF00","dark":"#12263A"},"logo":{"light":"https://mintcdn.com/readyhealth/ObZ5CoLssn0sEFqa/logo/light.svg?fit=max\u0026auto=format\u0026n=ObZ5CoLssn0sEFqa\u0026q=85\u0026s=749b867eabd17d032ddd22083d916fd9","dark":"https://mintcdn.com/readyhealth/ObZ5CoLssn0sEFqa/logo/dark.svg?fit=max\u0026auto=format\u0026n=ObZ5CoLssn0sEFqa\u0026q=85\u0026s=23b39027bb6e662cb9a4a4d579d39f4a"},"favicon":"https://mintcdn.com/readyhealth/ObZ5CoLssn0sEFqa/favicon.svg?fit=max\u0026auto=format\u0026n=ObZ5CoLssn0sEFqa\u0026q=85\u0026s=61d0c8c6b46beae1ed884598c927cdba","api":{"playground":{"display":"interactive"}},"navbar":{"links":[]},"footer":{},"icons":{"library":"fontawesome"},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"readyhealth","hasAudioNarration":false,"actualSubdomain":"readyhealth","customDomains":["docs.readyhealth.com"],"gitSource":{"type":"github","owner":"ready-health","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6abac7e4ba0ca9fe8961ee63","clientVersion":"0.0.4128","searchFilterCounts":[{"language":"default","tag":"API Reference","count":21},{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Intakes","count":4},{"language":"default","tag":"Placements","count":4},{"language":"default","tag":"Document Processing","count":4},{"language":"default","tag":"Jobs","count":3},{"language":"default","tag":"Scans","count":3},{"language":"default","tag":"Statements","count":3},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Requirement Lifecycle","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/webhooks","slug":"/api-reference/endpoint/webhooks","pageMetadata":{"title":"Webhooks","description":null,"href":"/api-reference/endpoint/webhooks"},"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`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Webhooks allow you to receive real-time updates about results from the Ready Health API. When you are getting set up, you will specify a URL where you wish to receive the requests.`}),`\n`,_jsx(Heading,{level:`2`,id:`webhook-payloads`,children:`Webhook Payloads`}),`\n`,_jsx(_components.p,{children:`The payload of a webhook will look like so:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`\u003cevent_type>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"documentId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`\u003cstring>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`\u003cstatus>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`event-types`,children:`Event types`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Event type`}),_jsx(_components.th,{children:`Data.Status`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`SCAN_SUCCESS`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`SUCCESS`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`SCAN_FAILED`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FAILED`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`VALIDATION_SUCCESS`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`VALID`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`VALIDATION_FAILED`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INVALID`})})]})]})]})]})}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","description":null,"href":"/api-reference/endpoint/webhooks"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Webhook Payloads","slug":"webhook-payloads","depth":2,"children":[]},{"title":"Event types","slug":"event-types","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"readyhealth","siteName":"Ready Health - API Documentation","title":"Webhooks - Ready Health - API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T19:57:06.984Z","originalFileLocation":"api-reference/endpoint/webhooks.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=\"Ready Health - API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/readyhealth/yQI6IlQaZrhtTpAp/_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/readyhealth/yQI6IlQaZrhtTpAp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/readyhealth/yQI6IlQaZrhtTpAp/_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/readyhealth/yQI6IlQaZrhtTpAp/_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/readyhealth/yQI6IlQaZrhtTpAp/_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/readyhealth/yQI6IlQaZrhtTpAp/_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/readyhealth/yQI6IlQaZrhtTpAp/_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/readyhealth/yQI6IlQaZrhtTpAp/_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/readyhealth/yQI6IlQaZrhtTpAp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Webhooks - Ready Health - API Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ready Health - API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.readyhealth.com/api-reference/endpoint/webhooks\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://readyhealth.mintlify.site/_mintlify/api/og/v2?division=Utilities\u0026amp;title=Webhooks\u0026amp;theme=c8f5019d017c009a070ec7d3\u0026amp;signature=32ea132fa730b20f13f711998903bdce267322e778224b88bbf480a867adede8\">\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 - Ready Health - API Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://readyhealth.mintlify.site/_mintlify/api/og/v2?division=Utilities\u0026amp;title=Webhooks\u0026amp;theme=c8f5019d017c009a070ec7d3\u0026amp;signature=32ea132fa730b20f13f711998903bdce267322e778224b88bbf480a867adede8\">\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/readyhealth/yQI6IlQaZrhtTpAp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ready Health - API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#06BCC1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.readyhealth.com/api-reference/endpoint/webhooks\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/webhooks.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.readyhealth.com/#organization\",\"name\":\"Ready Health - API Documentation\",\"url\":\"https://docs.readyhealth.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/readyhealth/ObZ5CoLssn0sEFqa/logo/light.svg?fit=max\u0026auto=format\u0026n=ObZ5CoLssn0sEFqa\u0026q=85\u0026s=749b867eabd17d032ddd22083d916fd9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.readyhealth.com#website\",\"name\":\"Ready Health - API Documentation\",\"url\":\"https://docs.readyhealth.com\",\"publisher\":{\"@id\":\"https://docs.readyhealth.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.readyhealth.com/api-reference/endpoint/webhooks#webpage\",\"url\":\"https://docs.readyhealth.com/api-reference/endpoint/webhooks\",\"name\":\"Webhooks\",\"dateModified\":\"2026-09-28T19:57:06.984Z\",\"isPartOf\":{\"@id\":\"https://docs.readyhealth.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.readyhealth.com/api-reference/endpoint/webhooks#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.readyhealth.com/api-reference/endpoint/webhooks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ready Health - API Documentation\",\"item\":\"https://docs.readyhealth.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhooks\",\"item\":\"https://docs.readyhealth.com/api-reference/endpoint/webhooks\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.readyhealth.com/api-reference/endpoint/webhooks#article\",\"headline\":\"Webhooks\",\"name\":\"Webhooks\",\"url\":\"https://docs.readyhealth.com/api-reference/endpoint/webhooks\",\"mainEntityOfPage\":{\"@id\":\"https://docs.readyhealth.com/api-reference/endpoint/webhooks#webpage\"},\"dateModified\":\"2026-09-28T19:57:06.984Z\",\"publisher\":{\"@id\":\"https://docs.readyhealth.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.readyhealth.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ready Health - API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ready Health - API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/webhooks.md","siteName":"Ready Health - API Documentation","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Intakes","pages":[{"title":"Create an Intake","openapi":"POST /v2/intakes/scan/async","href":"/api-reference/endpoint/create-intake"},{"title":"Get an Intake","openapi":"GET /v2/intakes/{id}","href":"/api-reference/endpoint/get-intake"},{"title":"Delete an Intake","openapi":"DELETE /v2/intakes/{id}","href":"/api-reference/endpoint/delete-intake"},{"title":"Get a Segment","openapi":"GET /v2/intakes/{id}/segments/{sid}","href":"/api-reference/endpoint/get-segment"}]},{"group":"Scans","pages":[{"title":"Create a Document Scan","openapi":"POST /document/scan/async","href":"/api-reference/endpoint/create-scan"},{"title":"Get a Document Scan","openapi":"GET /document/{id}","href":"/api-reference/endpoint/get-scan"},{"title":"Delete a Scan","openapi":"DELETE /document/{id}","href":"/api-reference/endpoint/delete-scan"}]},{"group":"Searches","pages":[{"title":"Create a Search","openapi":"POST /registry-check","href":"/api-reference/endpoint/create-search"}]},{"group":"Statements","pages":[{"title":"Create a Statement","openapi":"POST /statement","href":"/api-reference/endpoint/create-statement"},{"title":"Get a Statement","openapi":"GET /statement/{id}","href":"/api-reference/endpoint/get-statement"}]},{"group":"Jobs","pages":[{"title":"Create or Update a Job","openapi":"POST /job","href":"/api-reference/endpoint/create-job"},{"title":"List Jobs","openapi":"GET /job","href":"/api-reference/endpoint/list-jobs"},{"title":"Get a Job","openapi":"GET /job/{id}","href":"/api-reference/endpoint/get-job"}]},{"group":"Placements","pages":[{"title":"Create a Placement","openapi":"POST /placement","href":"/api-reference/endpoint/create-placement"},{"title":"List Placements","openapi":"GET /placement","href":"/api-reference/endpoint/list-placements"},{"title":"Get a Placement","openapi":"GET /placement/{id}","href":"/api-reference/endpoint/get-placement"},{"title":"Get Package Status","openapi":"GET /placement/{id}/package-status","href":"/api-reference/endpoint/get-package-status"}]},{"group":"VMS","pages":[{"title":"Upload Packet to VMS","openapi":"POST /vms/upload-packet","href":"/api-reference/endpoint/upload-packet"}]},{"group":"Fraud Detection","pages":[{"title":"Get Fraud Check Settings","openapi":"GET /fraud-detection/settings","href":"/api-reference/endpoint/get-fraud-settings"},{"title":"Update Fraud Check Settings","openapi":"PATCH /fraud-detection/settings","description":null,"href":"/api-reference/endpoint/update-fraud-settings"}]},{"group":"Utilities","pages":[{"title":"Webhooks","href":"/api-reference/endpoint/webhooks"}]}]}]},"basePath":"","title":"Webhooks - Ready Health - API Documentation","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":[],"chunks":[]}
