Triggered when an order’s status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows.
Status Transitions
Orders follow this lifecycle:
PLACED → APPROVED (payment confirmed)
APPROVED → SHIPPED (order dispatched)
SHIPPED → DELIVERED (order completed)
Any status → CANCELLED (order cancelled)
Webhook Security
All webhooks include a signature header (X-Webhook-Signature) for verification. See our webhook security guide for implementation details.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Modern PetstoreAPI Docs","colors":{"primary":"#9333EA","light":"#C084FC","dark":"#7C3AED"},"logo":{"light":"https://assets.apidog.com/app/project-icon/custom/20251217/66161baa-c10c-4c41-9146-fbaddf93bd86.png","dark":"https://assets.apidog.com/app/project-icon/custom/20251217/66161baa-c10c-4c41-9146-fbaddf93bd86.png"},"favicon":"https://assets.apidog.com/app/project-icon/custom/20251217/66161baa-c10c-4c41-9146-fbaddf93bd86.png","navbar":{"links":[{"label":"Support","href":"mailto:hi@mintlify.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Home","icon":"book-open-cover","href":"https://petstoreapi.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"anakinlabs","hasAudioNarration":false,"actualSubdomain":"anakinlabs","customDomains":["docs2.petstoreapi.com"],"gitSource":{"type":"github","owner":"petstoreapi","repo":"petstoreapi-docs-mintilify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9456100312e79e6151590:success","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"Modern PetstoreAPI","count":19},{"language":"default","tag":"Classic PetstoreAPI","count":19},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"Protocol Guides","count":12},{"language":"default","tag":"pet","count":8},{"language":"default","tag":"user","count":7},{"language":"default","tag":"Pet","count":6},{"language":"default","tag":"Store","count":5},{"language":"default","tag":"store","count":4},{"language":"default","tag":"User","count":4}]},"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":"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/webhooks/order-status-changed-event","slug":"/api-reference/webhooks/order-status-changed-event","pageMetadata":{"title":"Order status changed event","description":"Triggered when an order's status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows.\n\n## Status Transitions\n\nOrders follow this lifecycle:\n- `PLACED` → `APPROVED` (payment confirmed)\n- `APPROVED` → `SHIPPED` (order dispatched)\n- `SHIPPED` → `DELIVERED` (order completed)\n- Any status → `CANCELLED` (order cancelled)\n\n## Webhook Security\n\nAll webhooks include a signature header (`X-Webhook-Signature`) for verification. See our [webhook security guide](https://petstoreapi.com/docs/webhooks/security) for implementation details.","version":null,"deprecated":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json webhook orderStatusChanged","href":"/api-reference/webhooks/order-status-changed-event","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n h2: \"h2\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Triggered when an order’s status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Status Transitions\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Orders follow this lifecycle:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"PLACED\"\n }), \" → \", _jsx(_components.code, {\n children: \"APPROVED\"\n }), \" (payment confirmed)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"APPROVED\"\n }), \" → \", _jsx(_components.code, {\n children: \"SHIPPED\"\n }), \" (order dispatched)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"SHIPPED\"\n }), \" → \", _jsx(_components.code, {\n children: \"DELIVERED\"\n }), \" (order completed)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Any status → \", _jsx(_components.code, {\n children: \"CANCELLED\"\n }), \" (order cancelled)\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Webhook Security\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"All webhooks include a signature header (\", _jsx(_components.code, {\n children: \"X-Webhook-Signature\"\n }), \") for verification. See our \", _jsx(_components.a, {\n href: \"https://petstoreapi.com/docs/webhooks/security\",\n children: \"webhook security guide\"\n }), \" for implementation details.\"]\n })]\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":"Order status changed event","description":"Triggered when an order's status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows.\n\n## Status Transitions\n\nOrders follow this lifecycle:\n- `PLACED` → `APPROVED` (payment confirmed)\n- `APPROVED` → `SHIPPED` (order dispatched)\n- `SHIPPED` → `DELIVERED` (order completed)\n- Any status → `CANCELLED` (order cancelled)\n\n## Webhook Security\n\nAll webhooks include a signature header (`X-Webhook-Signature`) for verification. See our [webhook security guide](https://petstoreapi.com/docs/webhooks/security) for implementation details.","version":null,"deprecated":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json webhook orderStatusChanged","href":"/api-reference/webhooks/order-status-changed-event","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Order Status Changed Event","description":"Triggered when an order's status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows.\n\n## Status Transitions\n\nOrders follow this lifecycle:\n- `PLACED` → `APPROVED` (payment confirmed)\n- `APPROVED` → `SHIPPED` (order dispatched)\n- `SHIPPED` → `DELIVERED` (order completed)\n- Any status → `CANCELLED` (order cancelled)\n\n## Webhook Security\n\nAll webhooks include a signature header (`X-Webhook-Signature`) for verification. See our [webhook security guide](https://petstoreapi.com/docs/webhooks/security) for implementation details.","operationId":"orderStatusChangedWebhook","tags":["Webhooks"],"externalDocs":{"description":"Webhook Integration Guide","url":"https://petstoreapi.com/docs/webhooks/integration-guide"},"requestBody":"d9c01919-bb25-42d8-956a-ccdeac181c85","responses":{"200":"32917247-f3c5-46b8-b1e2-5f30967697e3","401":"63911312-4f52-46c3-a775-520e4f9cce65"},"method":"post","type":"webhook","servers":["24cc1bfc-2570-42c6-9ff0-a085d7467e2a"],"security":["ace18255-ff41-4322-a5c0-a142dce6a8be","77a215da-8ff3-42bb-afbb-137d30571d07"],"path":"orderStatusChanged","baseUrlOptions":["https://api.petstoreapi.com/v1"],"title":"Order Status Changed Event","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"order-approved","code":"{\n \"eventId\": \"evt_9f4a8b3c-2d5e-6f7g-8h9i-0j1k2l3m4n5o\",\n \"eventType\": \"order.statusChanged\",\n \"timestamp\": \"2024-12-16T10:30:00Z\",\n \"data\": {\n \"order\": {\n \"id\": \"019b4139-1234-7abc-8def-123456789abc\",\n \"petId\": \"019b4132-70aa-764f-b315-e2803d882a24\",\n \"userId\": \"019b4138-e0af-70b9-8f0c-6ea97d495dfa\",\n \"status\": \"APPROVED\",\n \"totalAmount\": \"125.50\",\n \"currency\": \"USD\",\n \"createdAt\": \"2024-12-16T09:00:00Z\",\n \"updatedAt\": \"2024-12-16T10:30:00Z\"\n },\n \"previousStatus\": \"PLACED\",\n \"newStatus\": \"APPROVED\",\n \"changedAt\": \"2024-12-16T10:30:00Z\",\n \"changedBy\": \"system\"\n }\n}"},{"language":"json","filename":"order-shipped","code":"{\n \"eventId\": \"evt_1a2b3c4d-5e6f-7g8h-9i0j-k1l2m3n4o5p6\",\n \"eventType\": \"order.statusChanged\",\n \"timestamp\": \"2024-12-17T14:00:00Z\",\n \"data\": {\n \"order\": {\n \"id\": \"019b4139-1234-7abc-8def-123456789abc\",\n \"petId\": \"019b4132-70aa-764f-b315-e2803d882a24\",\n \"userId\": \"019b4138-e0af-70b9-8f0c-6ea97d495dfa\",\n \"status\": \"SHIPPED\",\n \"totalAmount\": \"125.50\",\n \"currency\": \"USD\",\n \"createdAt\": \"2024-12-16T09:00:00Z\",\n \"updatedAt\": \"2024-12-17T14:00:00Z\"\n },\n \"previousStatus\": \"APPROVED\",\n \"newStatus\": \"SHIPPED\",\n \"changedAt\": \"2024-12-17T14:00:00Z\",\n \"changedBy\": \"staff_user_123\"\n }\n}"},{"language":"json","filename":"order-cancelled","code":"{\n \"eventId\": \"evt_2b3c4d5e-6f7g-8h9i-0j1k-l2m3n4o5p6q7\",\n \"eventType\": \"order.statusChanged\",\n \"timestamp\": \"2024-12-16T11:15:00Z\",\n \"data\": {\n \"order\": {\n \"id\": \"019b4139-5678-7def-9012-345678901234\",\n \"petId\": \"019b4127-54d5-76d9-b626-0d4c7bfce5b6\",\n \"userId\": \"019b4128-6a6b-777c-9ae8-335e962c68d8\",\n \"status\": \"CANCELLED\",\n \"totalAmount\": \"75.00\",\n \"currency\": \"USD\",\n \"createdAt\": \"2024-12-16T08:00:00Z\",\n \"updatedAt\": \"2024-12-16T11:15:00Z\"\n },\n \"previousStatus\": \"PLACED\",\n \"newStatus\": \"CANCELLED\",\n \"changedAt\": \"2024-12-16T11:15:00Z\",\n \"changedBy\": \"usr_019b4128-6a6b-777c-9ae8-335e962c68d8\"\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["eventId","eventType","timestamp","data"],"properties":{"eventId":{"type":"string","format":"uuid","description":"Unique identifier for this webhook event","examples":["evt_9f4a8b3c-2d5e-6f7g-8h9i-0j1k2l3m4n5o"],"isRequired":true,"uniqueKey":"eventId","typeLabel":"string\u003cuuid>"},"eventType":{"type":"string","const":"order.statusChanged","description":"Type of event","isRequired":true,"uniqueKey":"eventType","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"When the event occurred (RFC 3339)","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"data":{"type":"object","required":["order","previousStatus","newStatus"],"properties":{"order":{"type":"object","description":"Pet store order details","required":["id","petId","userId","status","totalAmount","currency","createdAt","updatedAt"],"properties":{"petId":{"type":"string","format":"uuid","description":"ID of the pet being ordered","examples":["019b4132-70aa-764f-b315-e2803d882a24","019b4127-54d5-76d9-b626-0d4c7bfce5b6"],"isRequired":true,"uniqueKey":"data.order.petId","typeLabel":"string\u003cuuid>"},"userId":{"type":"string","format":"uuid","description":"ID of the user placing the order","examples":["019b4138-e0af-70b9-8f0c-6ea97d495dfa","019b4128-6a6b-777c-9ae8-335e962c68d8"],"isRequired":true,"uniqueKey":"data.order.userId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Order status","enum":["PLACED","APPROVED","SHIPPED","DELIVERED","CANCELLED"],"examples":["PLACED","APPROVED"],"isRequired":true,"uniqueKey":"data.order.status","typeLabel":"enum\u003cstring>"},"totalAmount":{"type":"string","description":"Total order amount","examples":["125.50","75.00","200.99"],"isRequired":true,"uniqueKey":"data.order.totalAmount","typeLabel":"string"},"currency":{"type":"string","description":"Currency code for the order amount (ISO 4217)","default":"USD","pattern":"^[A-Z]{3}$","examples":["USD","EUR","GBP"],"isRequired":true,"uniqueKey":"data.order.currency","typeLabel":"string"}},"unevaluatedProperties":false,"isRequired":true,"uniqueKey":"data.order","typeLabel":"object"},"previousStatus":{"type":"string","enum":["PLACED","APPROVED","SHIPPED","DELIVERED","CANCELLED"],"description":"The order status before this change","isRequired":true,"uniqueKey":"data.previousStatus","typeLabel":"enum\u003cstring>"},"newStatus":{"type":"string","enum":["PLACED","APPROVED","SHIPPED","DELIVERED","CANCELLED"],"description":"The new order status after this change","isRequired":true,"uniqueKey":"data.newStatus","typeLabel":"enum\u003cstring>"},"changedAt":{"type":"string","format":"date-time","description":"When the status change occurred","uniqueKey":"data.changedAt","typeLabel":"string\u003cdate-time>"},"changedBy":{"type":"string","description":"Identifier of who/what triggered the change (user ID or system)","uniqueKey":"data.changedBy","typeLabel":"string"}},"unevaluatedProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"unevaluatedProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"order-approved":{"title":"order-approved","value":{"eventId":"evt_9f4a8b3c-2d5e-6f7g-8h9i-0j1k2l3m4n5o","eventType":"order.statusChanged","timestamp":"2024-12-16T10:30:00Z","data":{"order":{"id":"019b4139-1234-7abc-8def-123456789abc","petId":"019b4132-70aa-764f-b315-e2803d882a24","userId":"019b4138-e0af-70b9-8f0c-6ea97d495dfa","status":"APPROVED","totalAmount":"125.50","currency":"USD","createdAt":"2024-12-16T09:00:00Z","updatedAt":"2024-12-16T10:30:00Z"},"previousStatus":"PLACED","newStatus":"APPROVED","changedAt":"2024-12-16T10:30:00Z","changedBy":"system"}}},"order-shipped":{"title":"order-shipped","value":{"eventId":"evt_1a2b3c4d-5e6f-7g8h-9i0j-k1l2m3n4o5p6","eventType":"order.statusChanged","timestamp":"2024-12-17T14:00:00Z","data":{"order":{"id":"019b4139-1234-7abc-8def-123456789abc","petId":"019b4132-70aa-764f-b315-e2803d882a24","userId":"019b4138-e0af-70b9-8f0c-6ea97d495dfa","status":"SHIPPED","totalAmount":"125.50","currency":"USD","createdAt":"2024-12-16T09:00:00Z","updatedAt":"2024-12-17T14:00:00Z"},"previousStatus":"APPROVED","newStatus":"SHIPPED","changedAt":"2024-12-17T14:00:00Z","changedBy":"staff_user_123"}}},"order-cancelled":{"title":"order-cancelled","value":{"eventId":"evt_2b3c4d5e-6f7g-8h9i-0j1k-l2m3n4o5p6q7","eventType":"order.statusChanged","timestamp":"2024-12-16T11:15:00Z","data":{"order":{"id":"019b4139-5678-7def-9012-345678901234","petId":"019b4127-54d5-76d9-b626-0d4c7bfce5b6","userId":"019b4128-6a6b-777c-9ae8-335e962c68d8","status":"CANCELLED","totalAmount":"75.00","currency":"USD","createdAt":"2024-12-16T08:00:00Z","updatedAt":"2024-12-16T11:15:00Z"},"previousStatus":"PLACED","newStatus":"CANCELLED","changedAt":"2024-12-16T11:15:00Z","changedBy":"usr_019b4128-6a6b-777c-9ae8-335e962c68d8"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"32917247-f3c5-46b8-b1e2-5f30967697e3":{"description":"Webhook received successfully","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"63911312-4f52-46c3-a775-520e4f9cce65":{"description":"Invalid webhook signature","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"ace18255-ff41-4322-a5c0-a142dce6a8be":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication using JWT (JSON Web Token). Include the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`","scopes":[]}},"77a215da-8ff3-42bb-afbb-137d30571d07":{"oauth2":{"type":"oauth2","description":"OAuth 2.0 authorization with multiple flows including device authorization for IoT devices and smart TVs","flows":{"authorizationCode":{"authorizationUrl":"https://auth.petstoreapi.com/authorize","tokenUrl":"https://auth.petstoreapi.com/token","refreshUrl":"https://auth.petstoreapi.com/refresh","scopes":{"read:pets":"Read pet information","write:pets":"Create and update pets","read:orders":"Read order information","write:orders":"Create and manage orders","read:user":"Read user profile","write:user":"Update user profile","chat:write":"Access AI chat completions"}}},"scopes":[]}}},"servers":{"24cc1bfc-2570-42c6-9ff0-a085d7467e2a":{"url":"https://api.petstoreapi.com/v1","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication using JWT (JSON Web Token). Include the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication using JWT (JSON Web Token). Include the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 authorization with multiple flows including device authorization for IoT devices and smart TVs","flows":{"authorizationCode":{"authorizationUrl":"https://auth.petstoreapi.com/authorize","tokenUrl":"https://auth.petstoreapi.com/token","refreshUrl":"https://auth.petstoreapi.com/refresh","scopes":{"read:pets":"Read pet information","write:pets":"Create and update pets","read:orders":"Read order information","write:orders":"Create and manage orders","read:user":"Read user profile","write:user":"Update user profile","chat:write":"Access AI chat completions"}}},"scopes":[]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 authorization with multiple flows including device authorization for IoT devices and smart TVs","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"api-reference/modern-petstore-3.1.openapi.json"},"subdomain":"anakinlabs","siteName":"Modern PetstoreAPI Docs","title":"Order status changed event - Modern PetstoreAPI Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T09:42:09.792Z","originalFileLocation":"api-reference/webhooks/order-status-changed-event.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=\"Triggered when an order\u0026#x27;s status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows. ## Status Transitions Orders follow this lifecycle: - PLACED → APPROVED (payment confirmed) - APPROVED → SHIPPED (order dispatched) - SHIPPED → DELIVERED (order completed) - Any status → CANCELLED (order cancelled) ## Webhook Security All webhooks include a signature header (X-Webhook-Signature) for verification. See our webhook security guide for implementation details.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Modern PetstoreAPI Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://assets.apidog.com/app/project-icon/custom/20251217/66161baa-c10c-4c41-9146-fbaddf93bd86.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://assets.apidog.com/app/project-icon/custom/20251217/66161baa-c10c-4c41-9146-fbaddf93bd86.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://assets.apidog.com/app/project-icon/custom/20251217/66161baa-c10c-4c41-9146-fbaddf93bd86.png\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://assets.apidog.com/app/project-icon/custom/20251217/66161baa-c10c-4c41-9146-fbaddf93bd86.png\">\u003cmeta data-mint-head property=\"og:title\" content=\"Order status changed event - Modern PetstoreAPI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Triggered when an order\u0026#x27;s status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows. ## Status Transitions Orders follow this lifecycle: - PLACED → APPROVED (payment confirmed) - APPROVED → SHIPPED (order dispatched) - SHIPPED → DELIVERED (order completed) - Any status → CANCELLED (order cancelled) ## Webhook Security All webhooks include a signature header (X-Webhook-Signature) for verification. See our webhook security guide for implementation details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Modern PetstoreAPI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://anakinlabs.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Order+status+changed+event\u0026amp;description=Triggered+when+an+order%27s+status+changes.+This+webhook+notifies+your+system+of+order+lifecycle+events%2C+enabling+real-time+updates+for+order+tracking%2C+notificati\u0026amp;theme=04240fbb63cd3deb54f01e13\u0026amp;signature=29f9e921bf550dd66b062da7be4cc0112476107001ba4ba69a5e2f5aa4c39767\">\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=\"Order status changed event - Modern PetstoreAPI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Triggered when an order\u0026#x27;s status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows. ## Status Transitions Orders follow this lifecycle: - PLACED → APPROVED (payment confirmed) - APPROVED → SHIPPED (order dispatched) - SHIPPED → DELIVERED (order completed) - Any status → CANCELLED (order cancelled) ## Webhook Security All webhooks include a signature header (X-Webhook-Signature) for verification. See our webhook security guide for implementation details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://anakinlabs.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Order+status+changed+event\u0026amp;description=Triggered+when+an+order%27s+status+changes.+This+webhook+notifies+your+system+of+order+lifecycle+events%2C+enabling+real-time+updates+for+order+tracking%2C+notificati\u0026amp;theme=04240fbb63cd3deb54f01e13\u0026amp;signature=29f9e921bf550dd66b062da7be4cc0112476107001ba4ba69a5e2f5aa4c39767\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/anakinlabs/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Modern PetstoreAPI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9333EA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/order-status-changed-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs2.petstoreapi.com/#organization\",\"name\":\"Modern PetstoreAPI Docs\",\"url\":\"https://docs2.petstoreapi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://assets.apidog.com/app/project-icon/custom/20251217/66161baa-c10c-4c41-9146-fbaddf93bd86.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs2.petstoreapi.com#website\",\"name\":\"Modern PetstoreAPI Docs\",\"url\":\"https://docs2.petstoreapi.com\",\"publisher\":{\"@id\":\"https://docs2.petstoreapi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event#webpage\",\"url\":\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event\",\"name\":\"Order status changed event\",\"description\":\"Triggered when an order's status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows. ## Status Transitions Orders follow this lifecycle: - PLACED → APPROVED (payment confirmed) - APPROVED → SHIPPED (order dispatched) - SHIPPED → DELIVERED (order completed) - Any status → CANCELLED (order cancelled) ## Webhook Security All webhooks include a signature header (X-Webhook-Signature) for verification. See our webhook security guide for implementation details.\",\"dateModified\":\"2026-01-06T09:42:09.792Z\",\"isPartOf\":{\"@id\":\"https://docs2.petstoreapi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Modern PetstoreAPI Docs\",\"item\":\"https://docs2.petstoreapi.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Order status changed event\",\"item\":\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event#apireference\",\"headline\":\"Order status changed event\",\"name\":\"Order status changed event\",\"description\":\"Triggered when an order's status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows. ## Status Transitions Orders follow this lifecycle: - PLACED → APPROVED (payment confirmed) - APPROVED → SHIPPED (order dispatched) - SHIPPED → DELIVERED (order completed) - Any status → CANCELLED (order cancelled) ## Webhook Security All webhooks include a signature header (X-Webhook-Signature) for verification. See our webhook security guide for implementation details.\",\"url\":\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event\",\"mainEntityOfPage\":{\"@id\":\"https://docs2.petstoreapi.com/api-reference/webhooks/order-status-changed-event#webpage\"},\"dateModified\":\"2026-01-06T09:42:09.792Z\",\"publisher\":{\"@id\":\"https://docs2.petstoreapi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs2.petstoreapi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Modern PetstoreAPI Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Modern PetstoreAPI Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/webhooks/order-status-changed-event.md","siteName":"Modern PetstoreAPI Docs","nav":{"global":{"anchors":[{"anchor":"Home","icon":"book-open-cover","href":"https://petstoreapi.com/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Modern PetstoreAPI","groups":[{"group":"Pet","pages":[{"title":"Get Pet","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json get /pets/{id}","href":"/api-reference/pet/get-pet"},{"title":"Update Pet","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json put /pets/{id}","href":"/api-reference/pet/update-pet"},{"title":"Delete Pet","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json delete /pets/{id}","href":"/api-reference/pet/delete-pet"},{"title":"List Pets","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json get /pets","href":"/api-reference/pet/list-pets"},{"title":"Create Pet","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json post /pets","href":"/api-reference/pet/create-pet"},{"title":"Upload Pet Image","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json post /pets/{id}/images","href":"/api-reference/pet/upload-pet-image"}]},{"group":"Chat","pages":[{"title":"Create Chat Completion","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json post /chat/completions","href":"/api-reference/chat/create-chat-completion"}]},{"group":"Payments","pages":[{"title":"Pay Order","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json post /orders/{id}/payment","href":"/api-reference/payments/pay-order"}]},{"group":"Store","pages":[{"title":"List Inventory","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json get /inventories","href":"/api-reference/store/list-inventory"},{"title":"Create Order","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json post /orders","href":"/api-reference/store/create-order"},{"title":"Get Order","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json get /orders/{id}","href":"/api-reference/store/get-order"},{"title":"Callback Example","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json post /orders/{id}","href":"/api-reference/store/callback-example"},{"title":"Delete Order","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json delete /orders/{id}","href":"/api-reference/store/delete-order"}]},{"group":"User","pages":[{"title":"Create user.","deprecated":null,"version":null,"openapi":"api-reference/classic-petstore-3.0.openapi.json post /user","href":"/api-reference/user/create-user"},{"title":"Get User","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json get /users/{id}","href":"/api-reference/user/get-user"},{"title":"Update User","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json put /users/{id}","href":"/api-reference/user/update-user"},{"title":"Delete User","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json delete /users/{id}","href":"/api-reference/user/delete-user"},{"title":"Create Token (Login)","description":"Authenticate user and obtain an access token.","deprecated":false,"version":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json post /auth/tokens","href":"/api-reference/user/create-token-login"}]},{"group":"Webhooks","pages":[{"title":"Order status changed event","version":null,"deprecated":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json webhook orderStatusChanged","href":"/api-reference/webhooks/order-status-changed-event"},{"title":"Payment succeeded event","description":"Triggered when a payment is successfully processed and confirmed. This webhook notifies your system of successful payment transactions, enabling real-time updates for order fulfillment, customer notifications, and accounting workflows.\n\n## Payment Processing\n\nWhen a payment succeeds:\n- Payment status changes to `SUCCEEDED`\n- Order status typically updates to `APPROVED`\n- Payment receipt is generated\n- Funds are confirmed and captured\n\n## Webhook Security\n\nAll webhooks include a signature header (`X-Webhook-Signature`) for verification. See our [webhook security guide](https://petstoreapi.com/docs/webhooks/security) for implementation details.","version":null,"deprecated":null,"openapi":"api-reference/modern-petstore-3.1.openapi.json webhook paymentSucceeded","href":"/api-reference/webhooks/payment-succeeded-event"}]}]},{"tab":"Classic PetstoreAPI","pages":[{"title":"Classic PetstoreAPI","href":"/api-reference/pet/update-an-existing-pet"}]}]},"basePath":"","title":"Order status changed event - Modern PetstoreAPI Docs","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}