Behind the Curtain: Publishable URL Sharing Requests
Have you ever wondered what goes on behind the scenes when you submit an app to the ?
There are two main submission processes that you can use when creating an app, a Publishable URL sharing request and an App Publishing Request.
In this article, I’ll cover Publishable URL sharing requests, which allows an unpublished app to be distributed to a limited number Zoom users outside your account. App Publishing Requests, covered in this article, allows an app to be distributed and authorized by all Zoom users through the Marketplace, or through the developer’s domain.
As you are developing your app and diving into the Zoom Platform, you want to make sure the same care and attention is going into your app once you hand it off to the Zoom App Marketplace team. What does a good submission look like in comparison to one we would reject? How do we handle the app during the review process? When will your Publishable URL be available so you can finish testing your app and share what you have so far?
When we receive a Publishable URL sharing request we look for the following criteria:
- Whether or not you intend to eventually publish your app on the Marketplace.
- The number of customers with whom you are planning to install this app. Note that the maximum number of Pub URL authorizations allowed for an account level application is 20 and the maximum number of Pub URL authorizations allowed for a private user level application is 200.
- The type of customers with whom you are planning to install this app.
- The expected duration of time for which this URL should be active. Note that, if approved, a Publishable URL is permitted to be shared for a maximum duration of 4 weeks. You may request up to 2 extensions after expiry if necessary
- Complete all fields of the ‘Technical Design’ section of your app and fill out all required information accurately. The Techncial Design section consists of security and privacy-related questions pertaining to your application.
We evaluate each app on an individual basis and closely examine reasons why an app would require publishable URL sharing. Providing more detail in your submission gives a greater likelihood of approval.
Here is an example submission:
In this submission we can see that although we have some preliminary information about the App, all criteria is lacking.
1. App is never intended to be published, and does not provide a valid ‘Private App’ use case
2. Unreasonable subscriber limit, also exceeds maximum
3. App Name, Icon, and Descriptions lack detail or integrity
4. Reason for request does not match number of authorizations requested
5. No Duration specified, or TDD provided
In this case we would quickly reject the request with a link to our Developer Documentation on Sharing Private Apps, and prompt the developer to submit the TDD and Security Attestation via the build flow
Let’s evaluate a second submission of an app, in which they addressed each of the reasons for rejection with quality app information
1. App is intending to be published, but requires some testing first
2. Number of customers is reasonable, and fits reason provided
3. App Name, Icon and Descriptions match and provide information on use case
4. Reason for request indicates duration and reasonably matches subscriber limit
5. Duration specified, and both TDD and security evidence provided
How do we handle the app during the review process?
During the review process, your app will appear on our queue:
From here, we open your app information (see previous examples) and review criteria as well as confirm we have the TDD and Security Evidence. If your app passes, we will Approve the request, you will receive an email confirmation and you can then access your Publishable URL from your App page in Zoom Marketplace > Manage > Build Apps > Your App > Submit > Publishable URL.
If your app does NOT pass, we will send you an email explaining why we rejected, as well as notes accessible directly within the marketplace developer portal. Please review these notes, make adjustments to your app, and re-request.
What are the acceptable use cases for requesting a Publishable URL Sharing request?
- Developers who want to conduct a closed beta with live customers before submitting their app to be published for all Zoom customers to install.
- Enterprise accounts with separate accounts specifically for engineering teams to develop apps within sandbox environments.
- Zoom customers who employ contractors to develop apps specifically for their private needs.
For more detail please see the following documentation:
When will my Publishable URL be available so I can finish testing my app and share what I have made so far?
We work through these requests in the order we receive them and maintain a 72 hour first response time on all our requests. Because we review these requests based off of specific criteria, Publishable URL sharing requests are quickly processed. You should expect a quick and actionable response.
My Publishable URL Sharing Request was approved, can I share this app with all my customers?
You can share the Publishable URL with a limited set of beta users to receive feedback and confirm the app works as expected.
After receiving an approved Publishable URL Sharing Request, you are strictly prohibited from:
- Making any information about your app public.
- Publicly using any Zoom brands, trademarks, or copyrighted materials to represent your app
- Publicizing the app as a Zoom app / integration and linking or associating your brand or company with Zoom.
You are exclusively permitted to distribute and promote your app in relation to Zoom once it is approved and published on the Zoom App Marketplace.
If you would like any further information regarding Publishable URL sharing requests or the App Submission process, please see these Documentation articles we have written for you:
