Every app that calls the Triple Whale API on behalf of merchants is reviewed before it receives OAuth credentials. You submit the app once. Approval creates its client_id. You then generate the client secret yourself.
Before You Start
Have these ready:
- The app's public name, company name, and a support email merchants can contact
https://URLs for the app and its privacy policy (terms of service is optional)- A logo (PNG or SVG, up to 2 MB) that merchants will see on the consent screen
- The exact redirect URI or URIs your OAuth callback listens on
- The OAuth scopes you need, and a reason for any write scope
Submitting the Form
- In the portal, open Your apps and click Submit a new app.
- Fill in the form. Fields marked * are required.
| Field | Required | Rules |
|---|---|---|
| App name | Yes | Must contain at least one letter or number. Your provider id is derived from it and cannot be changed after approval. |
| Company | Yes | |
| Support email | Yes | A valid email. Shown to merchants who install your app. |
| App URL | Yes | An https:// URL. |
| Privacy policy URL | Yes | An https:// URL. |
| Terms of service URL | No | An https:// URL if you provide one. |
| Launch URL | No | An https:// URL. Where merchants land if Triple Whale links to your app later. |
| App logo | Yes | PNG or SVG, up to 2 MB. Shown on the consent screen. |
| Redirect URIs | Yes, at least one | Exact https:// URIs. No fragment (#) and no wildcards. http://localhost is allowed for development. http://127.0.0.1 is rejected. Use Add another redirect URI for more. |
| Scopes | Yes, at least one | Select each scope you need. The wording under each scope is what merchants read on the consent screen. |
| What does your app do? | Yes | Describe the integration and how merchants use it. |
| Write scope justification | Yes, if any :write scope is selected | What data you will push to Triple Whale, and where it comes from. |
| I accept the Triple Whale developer terms | Yes | The terms are linked next to the checkbox. |
- Click Submit for review. Invalid fields are highlighted, and the form shows Please fix the highlighted fields until they are corrected.
- On success you see App submitted for review. The app appears in Your apps with the status Pending review.
Your Draft Is SavedThe portal keeps the form as a local draft in this browser, so you can leave and come back. You have to tick the terms checkbox again. The draft is cleared once the app is submitted.
Your Provider Id
Under App name, the form shows Your provider id will be <id>. It is the app name in lowercase, with spaces turned into hyphens and other punctuation removed. My Wholesome App becomes my-wholesome-app.
The provider id is how data your app writes is attributed in Triple Whale. It cannot be changed after approval.
Choose the App Name CarefullyThe app name and the provider id cannot be changed after approval. If the name has to change, submit a new app.
What Happens Next
- Triple Whale emails you a confirmation that the submission is with the team.
- The app page shows Waiting for review: The Triple Whale team is reviewing your submission. You will get your client_id and be able to generate a client secret as soon as it is approved. Until then the page only shows the details you submitted.
- Apps that request a write scope get a closer look, because they push data into merchants' accounts.
- Each outcome is described in App Review and Statuses.
Best Practices
- Request only the scopes you need today. You can request more later with a change request. See Editing an Approved App.
- Register a localhost redirect URI next to the production one so you can test without a second app.
- Write What does your app do? for a reviewer who has never heard of your product.