You must be an OrderProtection customer to gain access to webhooks. If you’re
looking to integrate as a Partner integration please reach out to
partners@orderprotection.com
Webhooks include an x-webhook-secret header, which serves as a security measure to verify that the request originates from Order Protection. This secret should be used to authenticate and validate incoming webhook requests.
x-webhook-secret: <webhook secret>
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OrderProtection","colors":{"primary":"#5B1FD3","light":"#9B9BFD","dark":"#5B1FD3"},"logo":{"light":"https://mintcdn.com/orderprotectioncom/hWJXW3CDmk7aH415/logo/logo-light.png?fit=max\u0026auto=format\u0026n=hWJXW3CDmk7aH415\u0026q=85\u0026s=b559329f3e265ed3e989d25c28a8e911","dark":"https://mintcdn.com/orderprotectioncom/hWJXW3CDmk7aH415/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=hWJXW3CDmk7aH415\u0026q=85\u0026s=19d85b7fcf7ed0ed226b65098a13712b"},"favicon":"https://mintcdn.com/orderprotectioncom/hWJXW3CDmk7aH415/favicon.png?fit=max\u0026auto=format\u0026n=hWJXW3CDmk7aH415\u0026q=85\u0026s=922a5bd784abc0a76e3bea26c2d077db","api":{"openapi":["openapi.yaml","openapi-claims.yaml","openapi-tests.yaml","openapi-metadata.yaml"]},"background":{"color":{"light":"#FFFFFF","dark":"#1B1F27"}},"navbar":{"links":[{"href":"https://discord.gg/4YQeEghMTP","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.orderprotection.com"}},"footer":{"socials":{"github":"https://github.com/orderprotection","linkedin":"https://www.linkedin.com/company/orderprotection"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/4YQeEghMTP"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orderprotectioncom","hasAudioNarration":false,"actualSubdomain":"orderprotectioncom","customDomains":["docs.orderprotection.com"],"gitSource":{"type":"github","owner":"orderprotection","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad9aa326f446bbc9726dca8","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Documentation","count":60},{"language":"default","tag":"API Reference","count":29},{"language":"default","tag":"Education Basecamp","count":26},{"language":"default","tag":"Integrations","count":19},{"language":"default","tag":"Developer Platform","count":15},{"language":"default","tag":"Claims","count":14},{"language":"default","tag":"Platforms","count":9},{"language":"default","tag":"Products","count":8},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Getting Started","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"webhooks/introduction","slug":"/webhooks/introduction","pageMetadata":{"title":"Introduction","description":"Webhooks with OrderProtection.com","href":"/webhooks/introduction"},"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: \"Webhooks with OrderProtection.com\"\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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[`You must be an OrderProtection customer to gain access to webhooks. If you’re\nlooking to integrate as a Partner integration please reach out to\n`,_jsx(_components.a,{href:`mailto:partners@orderprotection.com`,children:`partners@orderprotection.com`})]})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`Webhooks include an x-webhook-secret header, which serves as a security measure to verify that the request originates from Order Protection. This secret should be used to authenticate and validate incoming webhook requests.`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`x-webhook-secret: \u003cwebhook secret>`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}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":"Introduction","description":"Webhooks with OrderProtection.com","href":"/webhooks/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"orderprotectioncom","siteName":"OrderProtection","title":"Introduction - OrderProtection","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T17:47:31.645Z","originalFileLocation":"webhooks/introduction.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=\"Webhooks with OrderProtection.com\">\u003cmeta data-mint-head name=\"application-name\" content=\"OrderProtection\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orderprotectioncom/fpSHGzgH5R5IA_DO/_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/orderprotectioncom/fpSHGzgH5R5IA_DO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orderprotectioncom/fpSHGzgH5R5IA_DO/_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/orderprotectioncom/fpSHGzgH5R5IA_DO/_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/orderprotectioncom/fpSHGzgH5R5IA_DO/_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/orderprotectioncom/fpSHGzgH5R5IA_DO/_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/orderprotectioncom/fpSHGzgH5R5IA_DO/_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/orderprotectioncom/fpSHGzgH5R5IA_DO/_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/orderprotectioncom/fpSHGzgH5R5IA_DO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - OrderProtection\">\u003cmeta data-mint-head property=\"og:description\" content=\"Webhooks with OrderProtection.com\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OrderProtection\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orderprotection.com/webhooks/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orderprotectioncom.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Introduction\u0026amp;description=Webhooks+with+OrderProtection.com\u0026amp;theme=bd0c6e7956fa37ab428f35d0\u0026amp;signature=be6b07a3f548311974fb3a0a0409061292be2cc7d0477e7630700ce48c1b07e5\">\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=\"Introduction - OrderProtection\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Webhooks with OrderProtection.com\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orderprotectioncom.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Introduction\u0026amp;description=Webhooks+with+OrderProtection.com\u0026amp;theme=bd0c6e7956fa37ab428f35d0\u0026amp;signature=be6b07a3f548311974fb3a0a0409061292be2cc7d0477e7630700ce48c1b07e5\">\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/orderprotectioncom/fpSHGzgH5R5IA_DO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OrderProtection\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B1FD3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orderprotection.com/webhooks/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/webhooks/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orderprotection.com/#organization\",\"name\":\"OrderProtection\",\"url\":\"https://docs.orderprotection.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orderprotectioncom/hWJXW3CDmk7aH415/logo/logo-light.png?fit=max\u0026auto=format\u0026n=hWJXW3CDmk7aH415\u0026q=85\u0026s=b559329f3e265ed3e989d25c28a8e911\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orderprotection.com#website\",\"name\":\"OrderProtection\",\"url\":\"https://docs.orderprotection.com\",\"publisher\":{\"@id\":\"https://docs.orderprotection.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orderprotection.com/webhooks/introduction#webpage\",\"url\":\"https://docs.orderprotection.com/webhooks/introduction\",\"name\":\"Introduction\",\"description\":\"Webhooks with OrderProtection.com\",\"dateModified\":\"2026-01-27T17:47:31.645Z\",\"isPartOf\":{\"@id\":\"https://docs.orderprotection.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orderprotection.com/webhooks/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orderprotection.com/webhooks/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"OrderProtection\",\"item\":\"https://docs.orderprotection.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.orderprotection.com/webhooks/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.orderprotection.com/webhooks/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Webhooks with OrderProtection.com\",\"url\":\"https://docs.orderprotection.com/webhooks/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orderprotection.com/webhooks/introduction#webpage\"},\"dateModified\":\"2026-01-27T17:47:31.645Z\",\"publisher\":{\"@id\":\"https://docs.orderprotection.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orderprotection.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OrderProtection\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"OrderProtection\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/webhooks/introduction.md","siteName":"OrderProtection","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.gg/4YQeEghMTP"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"Webhooks","groups":[{"group":"Webhooks","pages":[{"title":"Introduction","href":"/webhooks/introduction"}]},{"group":"Claims","pages":[{"title":"claim.approved","description":null,"href":"/webhooks/claims/claim-approved"},{"title":"claim.created","href":"/webhooks/claims/claim-created"},{"title":"claim.denied","href":"/webhooks/claims/claim-denied"}]},{"group":"Message","pages":[{"title":"message.created","href":"/webhooks/message/message-created"}]},{"group":"Protection","pages":[{"title":"protection.added","href":"/webhooks/protection/protection-added"},{"title":"protection.removed","href":"/webhooks/protection/protection-removed"}]}]},{"tab":"Developer Platform","pages":[{"title":"Developer Platform","href":"/developer/introduction"}]}]},"basePath":"","title":"Introduction - OrderProtection","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":[],"chunks":[]}
