Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Developer tools
Get started
Payments
Finance automation
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Overview
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Developer tools
SDKs
API
Testing
Workbench
Event Destinations
Workflows
Stripe CLI
Stripe Shell
Developers Dashboard
Agent toolkit
Stripe health alertsBuild with LLMsStripe for Visual Studio CodeFile uploads
Security
Security
Extend Stripe
Stripe Apps
    Overview
    Get started
    Create an app
    How Stripe Apps work
    Sample apps
    Build an app
    Store secrets
    API authentication methods
    Authorization flows
    Server-side logic
    Listen to events
    Handle different modes
    Enable sandbox support
    App settings page
    Build a UI
    Onboarding
    Distribute your app
    Distribution options
    Upload your app
    Versions and releases
    Test your app
    Publish your app
    Promote your app
    Add deep links
    Create install links
    Assign roles in UI extensions
    Post-install actions
    App analytics
    Embedded components for Apps
    Embed third-party Stripe Apps
    Migrating to Stripe Apps
    Migrate or build an extension
    Migrate a plugin to Stripe Apps or Stripe Connect
    Reference
    App manifest
    CLI
    Extension SDK
    Permissions
    Viewports
    Design patterns
    Components
Stripe Connectors
Partners
Partner ecosystem
Partner certification
HomeDeveloper toolsStripe Apps

Enable post-install actions and configurations

Support additional configurations that occur after app installation.

Copy page

After a user installs your app, you might require them to perform additional actions or configurations. For example, your app might require that the user supply separate credentials to access an external service. Stripe Apps refer to these additional steps as post-install actions. You can configure one of several types of post-install actions:

  • Within the app itself, using a SettingsView component
  • Externally, using a link to an external website

If you don’t define a post-install action, the Dashboard displays the app after installation.

Add a post-install action

To add a post-install action:

  1. Open your app manifest file.

  2. Add a new field, post_install_action.

    stripe-app.json
    { "id": "com.invoicing.[YOUR_APP]", "version": "1.2.3", "name": "[YOUR APP] Shipment Invoicing", "icon": "./[YOUR_APP]_icon_32.png", "permissions": [], "app_backend": {}, "ui_extension": {}, "post_install_action": {} }
  3. Add the configuration option for the post_install_action that meets the needs of your application setup.

  4. Upload your app to Stripe.

  5. Make a new release of your app.

  6. Publish your app to the marketplace.

Configuration options

Stripe Apps support the following post-install actions:

  • Link to app
  • Link to settings
  • Link to external URL

Link to app (default)

The default action after the user installs your app is to redirect that user to your application interface, if one is available.

Post-install screen with a link to view an app

This behavior requires no additional configuration to implement.

Link to external URL

If you need the user to visit an external site to configure their app, update the post_install_action parameter in your app manifest file as follows:

stripe-app.json
{ "id": "com.invoicing.[YOUR_APP]", "version": "1.2.3", "name": "[YOUR APP] Shipment Invoicing", "icon": "./[YOUR_APP]_icon_32.png", "permissions": [], "app_backend": {}, "ui_extension": {}, "post_install_action": { "type": "external", "url": "https://[YOUR-URL]" } }

Replace [YOUR-URL] with the URL to the external site.

When the user installs your app, the application displays a button that redirects the user to the URL specified in the app manifest file.

This URL includes an account_id query string parameter that you can use to identify the user. For example:

https://www.company.com/marketplace/stripe?account_id=12345
Post-install screen with an external link

Link to settings

If your app contains a SettingsView component, you can configure a post_install_action to open it after installation. To enable this action, update your app manifest file as follows:

stripe-app.json
{ "id": "com.invoicing.[YOUR_APP]", "version": "1.2.3", "name": "[YOUR APP] Shipment Invoicing", "icon": "./[YOUR_APP]_icon_32.png", "permissions": [], "app_backend": {}, "ui_extension": {}, "post_install_action": { "type": "settings" } }

When the user installs your app, the application displays a button that redirects them to your applications SettingsView component.

Post-install screen with a link to view settings
Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc