App review prerequisites
When you want to make your custom app public and share it with all Make users, your app has to conform to Make standards. Following Make app development standards is a prerequisite to get an app review. Make app standards encompass:
Custom app functionality.
Custom app code best practices.
Testing your custom app with test scenarios.
Check out the following sections to learn more about each prerequisite.
Check your app's functionality
In Make, we develop apps to provide value to our users. Your custom app should use a service that Make doesn't integrate yet. All apps in Make require from the user only credentials that are necessary to create a connection to the service API. If you want to make your custom app public, your app functionality has to follow the same principles:
Your custom app uses a web service that is not already available in Make.
Your custom app and it's modules have to connect to a web service API. Avoid duplicating the same functionality as iterators, aggregators or other tools in Make.
Avoid using APIs that have strong dependencies on other APIs, or APIs that function as redirects to other APIs.
Avoid using APIs that don't have their own domain, or have their domain associated with service platforms like Heroku or AWS.
Your custom app has to use only credentials that the service requires to create a connection. Don't request any additional credentials from the user.
Check your app's code
When developing a custom app in Make, you should first go through our Best Practices guide and apply them to your code. By following our best practices, you will ensure that the review and publication process of your app is as smooth as possible.
pageBest practicesBefore sending an app for review, check that:
The base and connection have sanitization of sensitive data, e. g. API key or token.
The base and connection have error handling.
The base and connection use an endpoint in the app's API.
Connection is using a correct URL. If the user uses incorrect credentials, they get an error.
Modules have correct labels and descriptions.
The app has a universal module.
All modules have the correct interface depending on the output from the module.
All dates are formatted or parsed in the mappable parameters and interface.
Search modules, trigger modules and RPCs have the pagination, if it's supported in the service API.
The items above are mandatory for each app.
Create test scenarios
After you check the code of your custom app, you have to create test scenarios to show that the custom app works. Use each module of the custom app in at least one testing scenario.
Make sure that the testing scenarios and their execution logs don't contain personal or sensitive data.
Best practices for test scenarios
In order to help us with a review of your app, please, follow the best practices.
Do not use scenarios with another app's webhook.
It is best to have all modules in one scenario and run them all without an error. You can group your modules via the entity or create scenarios of the way, the endpoints work together, e.g.
Create a Task > Create a Subtask(in order to create a subtask, the task has to be created first).Try to put all app's modules in one scenario and run the scenario without errors. Connect the app modules based on the object the modules work with or the action the modules do. For example, Create a Task > Create a Subtask (in order to create a subtask, the task has to be created first).
Put the search and list modules at the end of separate scenario routes to avoid multiple runs of the subsequent modules.
Run your search and list modules to have logs with pagination. If you don't know how to test pagination, follow the steps here.
Create a separate scenario that produces an error message. Run the scenario to get an error:
Run the test scenarios right before you request the custom app review and every time you fix issues. The scenario execution logs have a data retention limit and the reviewer won't be able to access old logs.
Last updated
