{"openapi":"3.0.0","info":{"title":"Apps Webhooks","description":"The Marketplace webhooks allow developers to receive events related to their app in the marketplace. ","version":"1.0.0"},"paths":{"app.authorization_request_declined":{"post":{"tags":["webhook"],"summary":"app.authorization_request_declined","description":"\nZoom triggers the **App Request Declined** event when an administrator declines a user's request to install an app.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **App Request Declined** subscription enabled under the **Marketplace** event.","operationId":"App.authorization_request_declinedWebhook","requestBody":{"description":"Webhook payload for the `app.authorization_request_declined` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App.authorization_request_declinedEvent"},"examples":{"default":{"summary":"Example app.authorization_request_declined event","value":{"event":"app.authorization_request_declined","event_ts":1641884378841,"payload":{"request_id":"wEVg-VQOTgGVCWWhuJRxCg","app_id":"wFhhvfBnSP6EtmebqXZCPQ","app_name":"My Test App","app_type":"SDK OAuth App","app_status":"published","app_description":"This is a test app.","scope":"specific_users","reviewer_name":"Admin User","reviewer_email":"admin@example.com","reviewed_requests":[{"requester_name":"Jill Chill","requester_email":"jill.chill@example.com"},{"requester_name":"Alex Morgan","requester_email":"alex.morgan@example.com"}]}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"app_deauthorized":{"post":{"tags":["webhook"],"summary":"app_deauthorized","description":"\nA user or an account admin who installed your app can uninstall it at any time. The **App Deauthorization** event is triggered every time a user uninstalls or deauthorizes your app.\n\n## Prerequisites\n\n* You have configured a valid deauthorization notification URL for your app. The field is located at the bottom of the **Information** tab of the [app configuration page](https://marketplace.zoom.us/develop/create). For more information, see [Deauthorization URLs](https://marketplace.zoom.us/docs/guides/auth/deauthorization/)\n\nSee <a href=\"https://developers.zoom.us/docs/api/rest/webhook-reference/#verify-webhook-events\">Webhook verification</a> for securing your webhook endpoint.\n\n","operationId":"App_deauthorizedWebhook","requestBody":{"description":"Webhook payload for the `app_deauthorized` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App_deauthorizedEvent"},"examples":{"default":{"summary":"Example app_deauthorized event","value":{"event":"app_deauthorized","payload":{"account_id":"AAAAAABBBB","user_id":"abcD3ojfdbjfg","signature":"827edc3452044f0bc86bdd5684afb7d1e6becfa1a767f24df1b287853cf73000","deauthorization_time":"2020-06-17T13:52:28.632Z","client_id":"ABCDEFGHIJKLMNOPQRST!V","event_ts":"2024-09-08 15:58:40"}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"app.authorization_request_created":{"post":{"tags":["webhook"],"summary":"app.authorization_request_created","description":"\nThe **App Request Approval** event is triggered any time a user requests to install an app.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **App Request Approval** subscription enabled under the **Marketplace** event.\n\n","operationId":"App.authorization_request_createdWebhook","requestBody":{"description":"Webhook payload for the `app.authorization_request_created` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App.authorization_request_createdEvent"},"examples":{"default":{"summary":"Example app.authorization_request_created event","value":{"event":"app.authorization_request_created","event_ts":"1641884378841","payload":{"app_name":"DevSlackBot","app_type":"SDK OAuth App","app_status":"published","app_description":"This is DevSlackBot.","app_link":{"developer_documentation":"https://devslackbot.example.com/docs","developer_privacy_policy":"https://devslackbot.example.com/policy","developer_support":"https://devslackbot.example.com/support","developer_terms_of_use":"https://devslackbot.example.com/toc"},"app_permissions":{"View":["Product Usage"],"Manage":["Registration & Scheduling","Content","Participants"]},"install_requirements":{"min_client":"5.7.3","user_role":"Any User","account_eligibility":{"premium_events":["Meeting Participant QoS","Webinar Participant QoS","Meeting Participant Advanced Data","Webinar Participant Advanced Data","Meeting Participant QoS Summary","Webinar Participant QoS Summary"],"account_types":["On Prem","Education","Pro","VIP"]}},"app_scopes":["meeting:write"],"requester_name":"Jill Chill","requester_department":"Development","requester_user_groups":["preappoval"],"request_reason":"I need to install this app."}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"app.authorization_request_approved":{"post":{"tags":["webhook"],"summary":"app.authorization_request_approved","description":"\nZoom triggers the **App Request Approved** event when an administrator approves a user's request to install an app.\n\n## Prerequisites\n\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **App Request Approved** subscription enabled under the **Marketplace** event.","operationId":"App.authorization_request_approvedWebhook","requestBody":{"description":"Webhook payload for the `app.authorization_request_approved` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App.authorization_request_approvedEvent"},"examples":{"default":{"summary":"Example app.authorization_request_approved event","value":{"event":"app.authorization_request_approved","event_ts":1641884378841,"payload":{"request_id":"wEVg-VQOTgGVCWWhuJRxCg","app_id":"wFhhvfBnSP6EtmebqXZCPQ","app_name":"My Test App","app_type":"SDK OAuth App","app_status":"published","app_description":"This is a test app.","scope":"specific_users","reviewer_name":"Admin User","reviewer_email":"admin@example.com","reviewed_requests":[{"requester_name":"Jill Chill","requester_email":"jill.chill@example.com"},{"requester_name":"Alex Morgan","requester_email":"alex.morgan@example.com"}]}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"App.authorization_request_declinedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["app_id","app_name","app_status","app_type","request_id","reviewer_email","reviewer_name","scope"],"type":"object","properties":{"request_id":{"type":"string","description":"The unique ID for this app installation request."},"app_id":{"type":"string","description":"The unique identifier for the app."},"app_name":{"type":"string","description":"The app's name."},"app_type":{"type":"string","description":"The app's type."},"app_status":{"type":"string","description":"The app's status: \n* `published` \n* `unpublished`","enum":["published","unpublished"]},"app_description":{"type":"string","description":"The app's description."},"scope":{"type":"string","description":"The scope of the admin's review action: \n* `all_users_on_account` — The admin declined the request for all users on the account. \n* `specific_users` — The admin declined the request for specific selected users.","enum":["all_users_on_account","specific_users"]},"reviewer_name":{"type":"string","description":"The display name of the administrator who declined the request."},"reviewer_email":{"type":"string","description":"The email address of the administrator who declined the request.","format":"email"},"reviewed_requests":{"type":"array","description":"A list of user requests that were declined. When `scope` is `all_users_on_account`, this might be absent. When `scope` is `specific_users`, this includes the declined users.","items":{"required":["requester_email","requester_name"],"type":"object","properties":{"requester_name":{"type":"string","description":"The name of the user who requested to install the app."},"requester_email":{"type":"string","description":"The email of the user who requested to install the app.","format":"email"}}}}}}}},"App_deauthorizedEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"payload":{"type":"object","properties":{"user_id":{"type":"string","description":"The user's ID."},"account_id":{"type":"string","description":"The user's account ID."},"client_id":{"type":"string","description":"The app's client ID."},"deauthorization_time":{"type":"string","description":"The date and time at which the user uninstalled the app.","format":"date-time"},"signature":{"type":"string","description":"A unique ID for each instance of app deauthorization and uninstallation by the user."},"event_ts":{"type":"number","description":"The timestamp of the webhook event."}}}}},"App.authorization_request_createdEvent":{"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"type":"object","properties":{"app_name":{"type":"string","description":"The app's name."},"app_type":{"type":"string","description":"The app's type."},"app_status":{"type":"string","description":"The app's status: \n* `published` \n* `development`","enum":["published","development"]},"app_description":{"type":"string","description":"The app's description."},"app_link":{"type":"object","properties":{"developer_documentation":{"type":"string","description":"The app's documentation URL.","format":"url"},"developer_privacy_policy":{"type":"string","description":"The app's privacy policy URL.","format":"url"},"developer_support":{"type":"string","description":"The app's support URL.","format":"url"},"developer_terms_of_use":{"type":"string","description":"The app's Terms of Use URL.","format":"url"}},"description":"Information about the app's developer documentation URLs."}}}}},"App.authorization_request_approvedEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["app_id","app_name","app_status","app_type","request_id","reviewer_email","reviewer_name","scope"],"type":"object","properties":{"request_id":{"type":"string","description":"The unique ID for this app installation request."},"app_id":{"type":"string","description":"The unique identifier for the app."},"app_name":{"type":"string","description":"The app's name."},"app_type":{"type":"string","description":"The app's type."},"app_status":{"type":"string","description":"The app's status: \n* `published` \n* `unpublished`","enum":["published","unpublished"]},"app_description":{"type":"string","description":"The app's description."},"scope":{"type":"string","description":"The scope of the admin's review action: \n* `all_users_on_account` — The admin approved the request for all users on the account. \n* `specific_users` — The admin approved the request for specific selected users.","enum":["all_users_on_account","specific_users"]},"reviewer_name":{"type":"string","description":"The display name of the administrator who approved the request."},"reviewer_email":{"type":"string","description":"The email address of the administrator who approved the request.","format":"email"},"reviewed_requests":{"type":"array","description":"A list of user requests that were approved. When `scope` is `all_users_on_account`, this might be absent. When `scope` is `specific_users`, this includes the approved users.","items":{"required":["requester_email","requester_name"],"type":"object","properties":{"requester_name":{"type":"string","description":"The name of the user who requested to install the app."},"requester_email":{"type":"string","description":"The email of the user who requested to install the app.","format":"email"}}}}}}}}}},"tags":[{"name":"webhook"}],"servers":[{"url":"https://{your-endpoint-url}"}]}