What app settings are
App settings let a merchant configure your app inside Dodo Payments. You describe the fields in a JSON manifest. Dodo Payments shows a Configure tab for each installation of your app, checks the values, and stores them for that installation. Your app does not need its own settings screen. It reads the saved values with its installation token and gets a webhook after each change.App settings are part of the App Marketplace. They are available to businesses that have the
app_marketplace feature enabled.How it works
1
Upload a manifest
You upload a manifest for your app. See the manifest reference.
2
Review, when needed
Most changes go live at once. Some changes need review, for example a new required field. See which changes need review.
3
The merchant fills the Configure tab
The merchant opens the installation and saves the values. Only an owner or an admin can save. Members can read the values, but never the secrets.
4
Your app reads the settings
Dodo Payments sends the
app.settings.updated webhook. Your app then calls the settings API to read the current values and secrets.Key facts
- Settings belong to one installation. A live installation and a test installation have separate values.
- A merchant can install your app before they fill the settings. Missing required values do not block the installation. The app page shows Action needed instead.
- Secret fields are encrypted. The merchant can write them, but the dashboard never shows them again.
- The API is read only. Your app cannot write settings.
Pages in this section
Manifest reference
Field types, limits, versions, and review.
Read settings
Call the API with an app access token.
Settings webhook
Handle the app.settings.updated event.
Dynamic options
Fill a select field from your own server.