{"openapi":"3.0.0","info":{"title":"Commerce Webhooks","description":"","version":"1.0.0"},"paths":{"commerce.account_status_changed":{"post":{"tags":["Account Management"],"summary":"commerce.account_status_changed","description":"\nThe **Account status changed** event is triggered whenever an account’s status is updated in Zoom Commerce (for example, when an account is activated, suspended, or canceled).\n\n## Prerequisites\n\nTo receive this event, ensure the following configurations are in place for your [Marketplace app](https://marketplace.zoom.us/user/build).\n\n* **Event Subscriptions** are enabled.\n* A valid **Event Notification Endpoint URL** is specified.\n* The **Commerce Account status changed** event subscription is enabled under the **commerce** event category.","operationId":"Commerce.account_status_changedWebhook","requestBody":{"description":"Webhook payload for the `commerce.account_status_changed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commerce.account_status_changedEvent"},"examples":{"default":{"summary":"Example commerce.account_status_changed event","value":{"event":"account_management.status_changed","event_ts":1626230691572,"payload":{"account_id":"fhedy84r34rh3bs8n9","account":{"crm_account_number":"A-3442434","create_reference_id":"ACC-23423423","status":"success"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"commerce.quote_status_changed":{"post":{"tags":["Quote"],"summary":"commerce.quote_status_changed","description":"The **Quote status changed** event is triggered every time a quote's status is updated in Zoom Commerce (for example, when a quote is submitted, approved, or canceled).\n\n## Prerequisites\n\nTo receive this event, ensure the following configurations are in place for your [Marketplace app](https://marketplace.zoom.us/user/build).\n\n* **Event Subscriptions** are enabled.\n* A valid **Event Notification Endpoint URL** is specified.\n* The **Quote status changed** event subscription is enabled under the **commerce** event category.","operationId":"Commerce.quote_status_changedWebhook","requestBody":{"description":"Webhook payload for the `commerce.quote_status_changed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commerce.quote_status_changedEvent"},"examples":{"default":{"summary":"Example commerce.quote_status_changed event","value":{"event":"commerce.order_status_changed","event_ts":1626230691572,"event_id":"fhewu234fhuf2394e78","payload":{"account_id":"r8489rjfhdsbj7623_er7r","quote":{"quote_reference_id":"Q-23423423","status":"approved"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"commerce.deal_registration_status_changed":{"post":{"tags":["Deal Registration"],"summary":"commerce.deal_registration_status_changed","description":"The **Deal Registration status changed** event is triggered whenever a deal registration’s status is updated in Zoom Commerce (for example, when a deal registration is submitted, approved, or rejected).\n\n## Prerequisites\n\nTo receive this event, ensure the following configurations are in place for your [Marketplace app](https://marketplace.zoom.us/user/build).\n\n* **Event Subscriptions** are enabled.\n* A valid **Event Notification Endpoint URL** is specified.\n* The **Deal Registration status changed** event subscription is enabled under the **commerce** event category.","operationId":"Commerce.deal_registration_status_changedWebhook","requestBody":{"description":"Webhook payload for the `commerce.deal_registration_status_changed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commerce.deal_registration_status_changedEvent"},"examples":{"default":{"summary":"Example commerce.deal_registration_status_changed event","value":{"event":"commerce.deal_registration_status_changed","event_ts":1626230691572,"event_id":"fhewu234fhuf2394e78","payload":{"account_id":"r8489rjfhdsbj7623_er7r","deal_registration":{"deal_reg_number":"DR-135621","create_reference_id":"DRR-23423423","status":"approved"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"commerce.order_status_changed":{"post":{"tags":["Order"],"summary":"commerce.order_status_changed","description":"The **Order Status Changed** event is triggered whenever an order’s status is updated in Zoom Commerce (for example, when an order is placed, processed, or canceled).\n\n## Prerequisites\n\nTo receive this event, ensure the following configurations are in place for your [Marketplace app](https://marketplace.zoom.us/user/build).\n\n* **Event Subscriptions** are enabled.\n* A valid **Event Notification Endpoint URL** is specified.\n* The **Order status changed** event subscription is enabled under the **commerce** event category.","operationId":"Commerce.order_status_changedWebhook","requestBody":{"description":"Webhook payload for the `commerce.order_status_changed` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Commerce.order_status_changedEvent"},"examples":{"default":{"summary":"Example commerce.order_status_changed event","value":{"event":"commerce.order_status_changed","event_ts":1626230691572,"event_id":"fhewu234fhuf2394e78","payload":{"account_id":"r8489rjfhdsbj7623_er7r","order":{"order_reference_id":"O-23423423","status":"completed"}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Commerce.account_status_changedEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp at which the event occurred.","format":"int64"},"event_id":{"type":"string","description":"A unique identifier for the event.","format":"UUID"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The ID of the account that triggered the webhook."},"account":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The unique ID for the account in the Zoom CRM system."},"create_reference_id":{"type":"string","description":"The unique reference ID for this account if created through the Zoom Commerce API."},"status":{"type":"string","description":"The account's latest status: success, partial success, submitted, in review, or failure.","enum":["success","partial success","failure","submitted","in review"]}},"description":"The account details."}}}}},"Commerce.quote_status_changedEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"event_id":{"type":"string","description":"A unique identifier for the event.","format":"UUID"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The ID of the account that triggered the webhook."},"quote":{"type":"object","properties":{"quote_reference_id":{"type":"string","description":"The reference ID for a quote.","example":"Q-3248714941"},"status":{"type":"string","description":"The status of the quote.","example":"approved","enum":["failedToSubmit","completed","canceled","submitted","failed","approved","rejected","returned","provisioning","draft","recalled"]}},"description":"The quote details."}}}}},"Commerce.deal_registration_status_changedEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp at which the event occurred.","format":"int64"},"event_id":{"type":"string","description":"A unique identifier for the event.","format":"UUID"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The ID of the account that triggered the webhook."},"deal_registration":{"type":"object","properties":{"deal_reg_number":{"maxLength":15,"type":"string","description":"The deal registration number.","example":"DR-135621"},"create_reference_id":{"type":"string","description":"The unique reference ID for this deal registration if created using the Deal Registration API.","example":"DRR-4834729"},"status":{"type":"string","description":"The deal registration's status.","example":"approved","enum":["pending review","denied","returned","approved","expired","revoked","closed-lost","closed-won","failure","pending sales review","draft","submitted","submit failed"]}},"description":"The deal registration details."}}}}},"Commerce.order_status_changedEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp at which the event occurred.","format":"int64"},"event_id":{"type":"string","description":"A unique identifier for the event.","format":"UUID"},"payload":{"type":"object","properties":{"account_id":{"type":"string","description":"The ID of the account that triggered the webhook."},"order":{"type":"object","properties":{"order_reference_id":{"type":"string","description":"The reference ID for the order.","example":"O-3248714941"},"status":{"type":"string","description":"The order's status.","example":"completed","enum":["draft","failedToSubmit","completed","canceled","failed","submitted"]}},"description":"The order details."}}}}}}},"tags":[{"name":"Account Management"},{"name":"Quote"},{"name":"Deal Registration"},{"name":"Order"}],"servers":[{"url":"https://{your-endpoint-url}"}]}