Allows for metadata fields to be set on a CAD Incident.
It is expected that CAD systems only accepts data for fields they support, but still return a “200 OK” response
even if they don’t accept some (or even all) of the fields sent.
POST
/
cad-integration-handler
/
fields
Allows for metadata fields to be set on a CAD Incident.
Field values that Assist is expecting to set in the CAD for the given Incident.
Assist does not send the optional cadFieldName. CAD systems must map to the most appropriate field.
INCIDENT_TYPE - The type of Incident, Incident Code, or Chief Complaint. Typically a code or short-hand value, like ABVEH (Abandoned Vehicle). If the CAD sends this value, and it matches an Assist Guide Card, then Assist will pre-populate the Guide Card instead of attempting to detect the most relevant Guide Card on its own.
INCIDENT_DESCRIPTION - Description of Incident as entered by Call Taker. If no INCIDENT_TYPE is provided, this may be used by Assist to select an initial Guide Card.
INCIDENT_PRIORITY - Priority of the incident as determined by Assist.
CALL_SUMMARY - A summary of the call up until the current point in time. Assist will send this periodically during an active Call.
If Assist sends fields that the CAD does not support or recognize, do not set them, and just return a "200 OK" response.
Show child attributes
Response
Indicates the fields have been set as expected.
⌘I
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"GovWorx API Documentation","colors":{"primary":"#339af0","light":"#339af0","dark":"#339af0"},"logo":{"light":"https://mintcdn.com/govworx/0FFQLB-2pFQKMa2M/logo/GovWorx-Logo_light.png?fit=max\u0026auto=format\u0026n=0FFQLB-2pFQKMa2M\u0026q=85\u0026s=6f689d9f51a89e59482167234491c4ee","dark":"https://mintcdn.com/govworx/0FFQLB-2pFQKMa2M/logo/GovWorx-Logo-dark.png?fit=max\u0026auto=format\u0026n=0FFQLB-2pFQKMa2M\u0026q=85\u0026s=c21ce7ceeeaf3286e2d7153637741578"},"favicon":"https://mintcdn.com/govworx/qDX7OjQnRmbzD40w/images/gw_favicon.png?fit=max\u0026auto=format\u0026n=qDX7OjQnRmbzD40w\u0026q=85\u0026s=2bd89f34a56a030007368242536a11e4","navbar":{"links":[{"href":"https://support.govworx.net","label":"Support"}],"primary":{"type":"button","label":"Application Dashboard","href":"https://app.govworx.net"}},"footer":{},"banner":{"content":"Welcome to the GovWorx Beta API Documentation! Please reach out to support if you are interested in gaining access to the GovWorx API.","dismissible":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"About GovWorx","icon":"book-open-cover","href":"https://www.govworx.ai"},{"anchor":"Trust Center","icon":"lock","href":"https://security.govworx.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"govworx","hasAudioNarration":false,"actualSubdomain":"govworx","customDomains":["developers.govworx.ai"],"gitSource":{"type":"github","owner":"psco-tech","repo":"gw-api-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae2b7aeb7812a2f5f9bc0df","collectionId":"fa2f4a63-0021-4d48-841b-419314e96c4e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae2b7aeb7812a2f5f9bc0df"},"entitlements":{},"buildId":"6ae2b7aeb7812a2f5f9bc0df","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API reference","count":53},{"language":"default","tag":"API Reference","count":31},{"language":"default","tag":"Connections Platform","count":22},{"language":"default","tag":"Realtime API Reference","count":21},{"language":"default","tag":"MCP Resources","count":10},{"language":"default","tag":"CAD integration","count":9},{"language":"default","tag":"Testing","count":8},{"language":"default","tag":"Test Calls","count":8},{"language":"default","tag":"Realtime Calls","count":7},{"language":"default","tag":"capture-radio-controller","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"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},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident","slug":"/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident","pageMetadata":{"title":"Allows for metadata fields to be set on a CAD Incident.\n","description":"It is expected that CAD systems only accepts data for fields they support, but still return a \"200 OK\" response\neven if they don't accept some (or even all) of the fields sent.\n","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /cad-integration-handler/fields","href":"/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident","autogeneratedByOpenApi":true},"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: \"It is expected that CAD systems only accepts data for fields they support, but still return a “200 OK” response\\neven if they don’t accept some (or even all) of the fields sent.\"\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}=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":{"title":"Allows for metadata fields to be set on a CAD Incident.\n","description":"It is expected that CAD systems only accepts data for fields they support, but still return a \"200 OK\" response\neven if they don't accept some (or even all) of the fields sent.\n","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /cad-integration-handler/fields","href":"/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["CAD Integration Handler"],"summary":"Allows for metadata fields to be set on a CAD Incident.\n","description":"It is expected that CAD systems only accepts data for fields they support, but still return a \"200 OK\" response\neven if they don't accept some (or even all) of the fields sent.\n","operationId":"cadFields","requestBody":"9ba86f76-3eeb-47e7-92e1-2090c6d2b250","responses":{"200":"e3498c1b-6b9d-41a5-ab0f-e52f0d3f55a6","default":"dd31344a-0aae-4ca7-bf81-8046c4dfdea5"},"method":"post","type":"path","servers":["8ef9e645-0193-49eb-9689-fa698aec7235"],"security":[],"path":"/cad-integration-handler/fields","baseUrlOptions":["https://realtime.govworx.net"],"title":"Allows for metadata fields to be set on a CAD Incident.\n","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Allows for setting the values of CAD Incident Fields.","properties":{"callId":{"type":"string","description":"Unique Assist Call ID.","uniqueKey":"callId","typeLabel":"string"},"incidentId":{"type":"string","description":"Unique CAD Incident ID.","uniqueKey":"incidentId","typeLabel":"string"},"fields":{"type":"array","description":"Field values that Assist is expecting to set in the CAD for the given Incident.\n\nAssist does not send the optional `cadFieldName`. CAD systems must map to the most appropriate field.\n\nINCIDENT_TYPE - The type of Incident, Incident Code, or Chief Complaint. Typically a code or short-hand value, like ABVEH (Abandoned Vehicle). If the CAD sends this value, and it matches an Assist Guide Card, then Assist will pre-populate the Guide Card instead of attempting to detect the most relevant Guide Card on its own.\n\nINCIDENT_DESCRIPTION - Description of Incident as entered by Call Taker. If no INCIDENT_TYPE is provided, this may be used by Assist to select an initial Guide Card.\n\nINCIDENT_PRIORITY - Priority of the incident as determined by Assist.\n\nCALL_SUMMARY - A summary of the call up until the current point in time. Assist will send this periodically during an active Call.\n\nIf Assist sends fields that the CAD does not support or recognize, do not set them, and just return a \"200 OK\" response.\n","items":{"type":"object","description":"Data field exchanged between Assist and a CAD system.","properties":{"name":{"type":"string","description":"Name of the field as expected by Assist.","uniqueKey":"fields.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"Value currently set for the field in CAD.","uniqueKey":"fields.items.[INDEX].value","typeLabel":"string"},"cad_field_name":{"type":"string","description":"Optional. Name of the field in the original CAD system.","uniqueKey":"fields.items.[INDEX].cad_field_name","typeLabel":"string"}},"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"callId":"\u003cstring>","incidentId":"\u003cstring>","fields":[{"name":"\u003cstring>","value":"\u003cstring>","cad_field_name":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e3498c1b-6b9d-41a5-ab0f-e52f0d3f55a6":{"description":"Indicates the fields have been set as expected.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"dd31344a-0aae-4ca7-bf81-8046c4dfdea5":{"description":"All other response codes will trigger a retry up to the maximum number of retries.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"8ef9e645-0193-49eb-9689-fa698aec7235":{"url":"https://realtime.govworx.net"}}},"originalFileLocation":"https://realtime.govworx.net/u/api-docs"},"subdomain":"govworx","siteName":"GovWorx API Documentation","title":"Allows for metadata fields to be set on a CAD Incident.\n - GovWorx API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T22:41:52.110Z","originalFileLocation":"api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident.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=\"It is expected that CAD systems only accepts data for fields they support, but still return a \u0026quot;200 OK\u0026quot; response even if they don\u0026#x27;t accept some (or even all) of the fields sent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"GovWorx 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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_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/govworx/LV4nt-UNetYIjxXN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Allows for metadata fields to be set on a CAD Incident.\n - GovWorx API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"It is expected that CAD systems only accepts data for fields they support, but still return a \u0026quot;200 OK\u0026quot; response even if they don\u0026#x27;t accept some (or even all) of the fields sent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GovWorx API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://govworx.mintlify.app/_mintlify/api/og/v2?division=CAD+Integration+Handler\u0026amp;title=Allows+for+metadata+fields+to+be+set+on+a+CAD+Incident.%0A\u0026amp;description=It+is+expected+that+CAD+systems+only+accepts+data+for+fields+they+support%2C+but+still+return+a+%22200+OK%22+response%0Aeven+if+they+don%27t+accept+some+%28or+even+all%29+of+\u0026amp;theme=9ed98ad7a71cea6ade40e8a5\u0026amp;signature=b0a101ab9c99c0015231cc7028eae369538c624b55cdadceacfdee7a3a364513\">\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=\"Allows for metadata fields to be set on a CAD Incident.\n - GovWorx API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"It is expected that CAD systems only accepts data for fields they support, but still return a \u0026quot;200 OK\u0026quot; response even if they don\u0026#x27;t accept some (or even all) of the fields sent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://govworx.mintlify.app/_mintlify/api/og/v2?division=CAD+Integration+Handler\u0026amp;title=Allows+for+metadata+fields+to+be+set+on+a+CAD+Incident.%0A\u0026amp;description=It+is+expected+that+CAD+systems+only+accepts+data+for+fields+they+support%2C+but+still+return+a+%22200+OK%22+response%0Aeven+if+they+don%27t+accept+some+%28or+even+all%29+of+\u0026amp;theme=9ed98ad7a71cea6ade40e8a5\u0026amp;signature=b0a101ab9c99c0015231cc7028eae369538c624b55cdadceacfdee7a3a364513\">\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/govworx/LV4nt-UNetYIjxXN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GovWorx API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#339af0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.govworx.ai/#organization\",\"name\":\"GovWorx API Documentation\",\"url\":\"https://developers.govworx.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/govworx/0FFQLB-2pFQKMa2M/logo/GovWorx-Logo_light.png?fit=max\u0026auto=format\u0026n=0FFQLB-2pFQKMa2M\u0026q=85\u0026s=6f689d9f51a89e59482167234491c4ee\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.govworx.ai#website\",\"name\":\"GovWorx API Documentation\",\"url\":\"https://developers.govworx.ai\",\"publisher\":{\"@id\":\"https://developers.govworx.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident#webpage\",\"url\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident\",\"name\":\"Allows for metadata fields to be set on a CAD Incident.\\n\",\"description\":\"It is expected that CAD systems only accepts data for fields they support, but still return a \\\"200 OK\\\" response even if they don't accept some (or even all) of the fields sent.\",\"dateModified\":\"2026-08-25T22:41:52.110Z\",\"isPartOf\":{\"@id\":\"https://developers.govworx.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Realtime API Reference\",\"item\":\"https://developers.govworx.ai/api-reference/realtime-introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"CAD Integration Handler\",\"item\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-assist-to-set-the-active-response-plan-for-an-incident\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Allows for metadata fields to be set on a CAD Incident.\\n\",\"item\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident#apireference\",\"headline\":\"Allows for metadata fields to be set on a CAD Incident.\\n\",\"name\":\"Allows for metadata fields to be set on a CAD Incident.\\n\",\"description\":\"It is expected that CAD systems only accepts data for fields they support, but still return a \\\"200 OK\\\" response even if they don't accept some (or even all) of the fields sent.\",\"url\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident\",\"mainEntityOfPage\":{\"@id\":\"https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident#webpage\"},\"dateModified\":\"2026-08-25T22:41:52.110Z\",\"publisher\":{\"@id\":\"https://developers.govworx.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.govworx.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GovWorx API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"GovWorx API Documentation","nav":{"global":{"anchors":[{"anchor":"About GovWorx","icon":"book-open-cover","href":"https://www.govworx.ai"},{"anchor":"Trust Center","icon":"lock","href":"https://security.govworx.ai"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Connections Platform","pages":[{"title":"Connections Platform","href":"/connections-platform/overview"}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"API Reference","pages":[{"group":"capture-radio-controller","pages":[{"title":"Put apiv1internalcapture radioclaims audio","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs put /api/v1/internal/capture-radio/claims/{childId}/audio","href":"/api-reference/capture-radio-controller/put-apiv1internalcapture-radioclaims-audio"},{"title":"Post apiv1internalcapture radioclaims","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs post /api/v1/internal/capture-radio/claims","href":"/api-reference/capture-radio-controller/post-apiv1internalcapture-radioclaims"},{"title":"Post apiv1internalcapture radioclaims finalize","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs post /api/v1/internal/capture-radio/claims/{childId}/finalize","href":"/api-reference/capture-radio-controller/post-apiv1internalcapture-radioclaims-finalize"},{"title":"Get apiv1internalcapture radioclaims","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/internal/capture-radio/claims/{childId}","href":"/api-reference/capture-radio-controller/get-apiv1internalcapture-radioclaims"},{"title":"Get apiv1internalcapture radiocapability","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/internal/capture-radio/capability","href":"/api-reference/capture-radio-controller/get-apiv1internalcapture-radiocapability"}]},{"group":"Incident","pages":[{"title":"Upload Incident","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs put /api/v1/external/incident","href":"/api-reference/incident/upload-incident"}]},{"group":"Media Ingest","pages":[{"title":"Ingest SRT radio media","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs post /api/v1/external/media","href":"/api-reference/media-ingest/ingest-srt-radio-media"}]},{"group":"Knowledge","pages":[{"title":"List Knowledge entries","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/knowledge","href":"/api-reference/knowledge/list-knowledge-entries"},{"title":"Create Knowledge entry","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs post /api/v1/external/knowledge","href":"/api-reference/knowledge/create-knowledge-entry"},{"title":"Append Knowledge version","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs post /api/v1/external/knowledge/{knowledgeId}/versions","href":"/api-reference/knowledge/append-knowledge-version"},{"title":"Get Knowledge entry","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/knowledge/{knowledgeId}","href":"/api-reference/knowledge/get-knowledge-entry"},{"title":"Look up Knowledge by externalId","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/knowledge/by-external-id","href":"/api-reference/knowledge/look-up-knowledge-by-externalid"}]},{"group":"Users","pages":[{"title":"List Users","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/user","href":"/api-reference/users/list-users"},{"title":"Lookup User","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/user/single","href":"/api-reference/users/lookup-user"}]},{"group":"TRAIN","pages":[{"title":"List Training Observation Reports","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/train/user/{userId}/reports","href":"/api-reference/train/list-training-observation-reports"},{"title":"List User Phase Enrollments","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/train/user/{userId}/enrollments","href":"/api-reference/train/list-user-phase-enrollments"},{"title":"List Phases","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/train/phases","href":"/api-reference/train/list-phases"}]},{"group":"Research Access","pages":[{"title":"List eligible Research recipients","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/research-access/recipients","href":"/api-reference/research-access/list-eligible-research-recipients"}]},{"group":"Quality Assurance","pages":[{"title":"List Feedback Reports","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/qa/user/{userId}/reports","href":"/api-reference/quality-assurance/list-feedback-reports"},{"title":"List Evaluations","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/qa/user/{userId}/evaluations","href":"/api-reference/quality-assurance/list-evaluations"}]},{"group":"MCP Resources","pages":[{"title":"Search the Resource Center","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/resource-center/search","href":"/api-reference/mcp-resources/search-the-resource-center"},{"title":"Get Media by ID","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/media/{mediaId}","href":"/api-reference/mcp-resources/get-media-by-id"},{"title":"Get a knowledge item's current card","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/knowledge/{knowledgeId}/card","href":"/api-reference/mcp-resources/get-a-knowledge-items-current-card"},{"title":"Get a knowledge version's source document","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/knowledge-versions/{versionId}/source","href":"/api-reference/mcp-resources/get-a-knowledge-versions-source-document"},{"title":"Get the version before a knowledge version","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/knowledge-versions/{versionId}/previous","href":"/api-reference/mcp-resources/get-the-version-before-a-knowledge-version"},{"title":"Get Incident by ID","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/incidents/{incidentId}","href":"/api-reference/mcp-resources/get-incident-by-id"},{"title":"List configured geo areas","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/geo-areas","href":"/api-reference/mcp-resources/list-configured-geo-areas"},{"title":"Get Event by ID","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/events/{eventId}","href":"/api-reference/mcp-resources/get-event-by-id"},{"title":"Get ePCRs by Event ID","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/epcrs/{eventId}","href":"/api-reference/mcp-resources/get-epcrs-by-event-id"},{"title":"List ePCR attachments by Event ID","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/mcp/resources/epcr-attachments/{eventId}","href":"/api-reference/mcp-resources/list-epcr-attachments-by-event-id"}]},{"group":"Audit Log Export","pages":[{"title":"Export Audit Log Records","deprecated":null,"version":null,"openapi":"https://app.govworx.net/u/api-docs get /api/v1/external/logs","href":"/api-reference/audit-log-export/export-audit-log-records"}]}]},{"group":"Realtime API Reference","pages":[{"title":"Introduction","href":"/api-reference/realtime-introduction"},{"title":"CAD Vendor Guide","href":"/api-reference/realtime-cad-integration"},{"group":"Webhook Handlers","pages":[{"title":"Call Events","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /webhookhandler/call","href":"/api-reference/webhook-handlers/call-events"},{"title":"CAD Integration Events","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /webhookhandler/cad","href":"/api-reference/webhook-handlers/cad-integration-events"},{"title":"Assistant Events","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /webhookhandler/assistant","href":"/api-reference/webhook-handlers/assistant-events"}]},{"group":"Webhook Registration","pages":[{"title":"Call Events Registration","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /realtime/v1/webhook/call","href":"/api-reference/webhook-registration/call-events-registration"},{"title":"Delete Call Events Registration","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs delete /realtime/v1/webhook/call/{id}","href":"/api-reference/webhook-registration/delete-call-events-registration"},{"title":"Update Call Events Registration","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs patch /realtime/v1/webhook/call/{id}","href":"/api-reference/webhook-registration/update-call-events-registration"}]},{"group":"Realtime Calls","pages":[{"title":"Stream Call Audio","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /realtime/v1/call/{id}/audio/stream","href":"/api-reference/realtime-calls/stream-call-audio"},{"title":"Seek Live Audio Stream","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /realtime/v1/call/{id}/audio/stream/{streamId}/seek","href":"/api-reference/realtime-calls/seek-live-audio-stream"},{"title":"Pause/Unpause Audio Stream","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /realtime/v1/call/{id}/audio/stream/{streamId}/pause","href":"/api-reference/realtime-calls/pauseunpause-audio-stream"},{"title":"Get Calls","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs get /realtime/v1/call","href":"/api-reference/realtime-calls/get-calls"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs get /realtime/v1/call/{id}","href":"/api-reference/realtime-calls/get-call"},{"title":"Get Call Transcript Segments","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs get /realtime/v1/call/{id}/transcript","href":"/api-reference/realtime-calls/get-call-transcript-segments"},{"title":"Retrieve Call Events Registration","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs get /realtime/v1/call/webhooks","href":"/api-reference/realtime-calls/retrieve-call-events-registration"}]},{"group":"CAD Integration","pages":[{"title":"Link Incident","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /realtime/v1/cad/incident","href":"/api-reference/cad-integration/link-incident"},{"title":"Incident Notes","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs get /realtime/v1/cad/incident/{callId}/notes","href":"/api-reference/cad-integration/incident-notes"}]},{"group":"Authentication","pages":[{"title":"Generate token","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /realtime/v1/auth/token","href":"/api-reference/authentication/generate-token"}]},{"group":"CAD Integration Handler","pages":[{"title":"Allows Assist to set the active response plan for an Incident.\n","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /cad-integration-handler/response-plan","href":"/api-reference/cad-integration-handler/allows-assist-to-set-the-active-response-plan-for-an-incident"},{"title":"Allows for sending CAD Incident Notes/Remarks.","description":"Assist will send Notes it generates so that they can be included as part of the Incident.\n\nNOTE: This endpoint is similar to the CAD Webhook, but CAD vendors should implement this endpoint instead of\nusing the webhook. The endpoint provides a simpler path because you do not need to worry about webhook registration.\n","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /cad-integration-handler/notes","href":"/api-reference/cad-integration-handler/allows-for-sending-cad-incident-notesremarks"},{"title":"Allows for metadata fields to be set on a CAD Incident.\n","deprecated":null,"version":null,"openapi":"https://realtime.govworx.net/u/api-docs post /cad-integration-handler/fields","href":"/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident"}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp-tools"}]}]},"basePath":"","title":"Allows for metadata fields to be set on a CAD Incident.\n - GovWorx API Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}