Validate the app before publish

We run your integration through a set of automated checks to ensure it’s working properly and giving our clients the best possible experience. There is a list of checks that need to be run to ensure your App is working properly

Before you start

You should have a configured app.

How it works

Each validation code is given a unique ID, consisting of a capital letter and three digits eg: D001.

Area	Description
APP	This must be defined for the APP without extension.
Marketing	Public-facing information, such as the app title, description, and logo. The intent of these rules is to give Eshopbox users a consistent style among texts and images across all public integrations. They’re more likely to block you from going public.
APP with Extension	This must define the APP with extension validations.

DEVELOPMENT CHECKLIST

• A001 (Asks for API Key in ): API key and the secret key must be present.

• E003(All URLs Should Be HTTPS): When handling customer data it’s strongly encouraged that all communication takes securely. Using SSL is a big part of that, so ensure your URLs have HTTPS as their protocol.

• E006(IST Date/Time Format in Static Sample): To ensure APP can correctly parse dates and times, you should always use IST format to represent dates or times. Timezone info should also be present if it contains time.

• E007(Developer Terms of Service): You must agree to the Developer Terms of Service in order to proceed.

If you are building an app extension for Automation:

• E001(A Connected Auth Account Exists): To ensure you’ve tested auth, we require you to set up at least one connected account.

• E002(REST Hook Trigger Needs a Polling URL): When users are setting up a hook-based (aka instant) Trigger, it’s important to have a polling fallback. It’s very important that the structure of an object from a webhook and from a poll is identical. Typically, this means modifying a poll result so that it looks like a hook. If a poll has fields that a hook doesn’t, the user may map them to a later step and when the Automation is run for real, the value will be blank.

• E004(Static Sample Is Required): When a user sets up a trigger, they need sample data to be returned in order to have fields available to map in the subsequent steps. If testing the trigger returns no live results, we use static sample data as a fallback.

• E005( Description Requirements): descriptions must be required. Lastly, this section should have 1 - 3 sentences or at least 40 characters.

• E008(Provide Link in Help Text for Auth Fields): It’s often not obvious where a user can find their API credentials for a service. If you use a pasted API key as an authentication method, it’s strongly encouraged that you link the user to the page (or relevant help doc) that has their key.

• E009(Connection Label Should Be Set): Connection Labels help customers understand and remember which account they connected for a given Connected Account. These should be short and something easily identifiable.

• E010(Requires at Least One Search Field): When making a search step, it’s important to have a field to search on! Common examples for searching for a user are by name, email, and username.

• E011(Trigger Description Requirements): Trigger descriptions must start with Triggers when and end with a ..

• E012(Creates Should Try to Have Static Input Fields): When making Automation Templates, it’s helpful to have input fields that are common for all users. Without any, it’s hard to create templates.

• E013(Static Sample Respects Output Field Definition): If you define output fields for a trigger/action/search, they should be consistent with the static sample data. The specific checks are:

  • “required” fields must be in the sample

  • field values in the sample match their field type

• E014(Version Is Deprecated): You can’t promote a deprecated version.

• E015(Integration Is Pending): This could happen if you’re repeatedly submitting an integration that is already pending for review.

• E016(Version Is Already Production): This could happen if you’re promoting a version that is already in production.

• E017(3 Users with a live Automation): To verify user demand, there should be at least 3 users who have live Automation using this integration. “Live” means at least one successful task in recent history.

• E018(One Live Automation for Each Trigger/Search/Action): To ensure any show-stopping bugs are worked out, every visible trigger/search/action of your integration should have a live Automation that demonstrates it works.

• E019: If your app is a public Sales channel app. Then Extension must be compulsory.

MARKETING CHECKLIST

• M001(Invalid Logo): Your app’s logo will be used all over the site in square containers and in various sizes. To ensure it looks good at all sizes, the logo image must be:

  • a square PNG image

  • at least 256px by 256px in size

  • in RGBA mode so it can have a transparent background.

• M002(Homepage URL Must Be Present): Each app must have a homepage URL.