Stripe Apps Integration Guide
Stripe Apps let you embed custom functionality directly into the Stripe Dashboard, giving merchants access to Tajo’s Brevo integration without leaving their payments workflow. This guide covers everything you need to build, test, and publish a Stripe App that connects Stripe with Brevo through Tajo.
Tip
The goal is to publish a Brevo integration on the Stripe App Marketplace, enabling Stripe merchants to sync customer data, orders, and events directly into Brevo for marketing automation and CRM.
What Are Stripe Apps?
Stripe Apps extend the Stripe Dashboard with custom UI components and backend integrations. They allow third-party developers to:
- Add custom views to Stripe Dashboard pages (customers, payments, invoices, etc.)
- Access Stripe data through scoped permissions
- Sync data between Stripe and external platforms like Brevo
- Provide onboarding and configuration flows within the Dashboard
Tajo + Brevo Integration Goals
The Tajo Stripe App connects Stripe with Brevo to deliver:
- Customer Intelligence: Sync Stripe customer profiles, payment history, and lifetime value into Brevo contacts
- Event Tracking: Push Stripe events (payments, subscriptions, refunds) as Brevo transactional events
- Automated Campaigns: Trigger Brevo email, SMS, and WhatsApp campaigns based on Stripe activity
- Loyalty Programs: Build retention workflows using Stripe purchase data synced to Brevo
Architecture Overview
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐│ Stripe Dashboard │────▶│ Tajo Platform │────▶│ Brevo ││ (Stripe App UI) │◀────│ (Middleware) │◀────│ (CRM/Email) │└─────────────────┘ └─────────────────┘ └─────────────────┘ │ │ │ Customer views Data sync & Contacts, Payment details Event routing Campaigns, App settings Webhook handling AutomationsGuide Contents
This documentation covers the complete lifecycle of building and publishing a Stripe App:
Getting Started
| Guide | Description |
|---|---|
| Publishing to Marketplace | Requirements and steps to submit your app for review |
| App Review Requirements | Quality, security, and UX standards for approval |
Configuration & Reference
| Guide | Description |
|---|---|
| App Manifest Reference | Complete schema for the stripe-app.json manifest file |
| Permissions Reference | Full list of Stripe API permissions and how to request them |
| Viewports Reference | Dashboard locations where your app UI can appear |
Features & Integration
| Guide | Description |
|---|---|
| Embedded Stripe Apps | Using Connect embedded components for platform integrations |
| Install Links & Deep Links | Generate install URLs and deep link into specific app views |
| Post-Install Actions | Configure onboarding flows after app installation |
Operations & Growth
| Guide | Description |
|---|---|
| App Analytics | Track installs, views, and conversion metrics |
| Partner Ecosystem | Leverage Stripe’s partner program for co-marketing and growth |
Prerequisites
Before building a Stripe App, ensure you have:
- Stripe Account: An activated Stripe account (not restricted to test mode)
- Stripe CLI: Install the Stripe CLI for local development and app uploads
- Node.js: Version 16 or later for the app UI extension
- Tajo Platform Access: Active Tajo account with Brevo API credentials configured
Quick Start
# Install Stripe CLIbrew install stripe/stripe-cli/stripe
# Login to your Stripe accountstripe login
# Create a new Stripe App projectstripe apps create tajo-brevo-integration
# Start local developmentstripe apps startKey Concepts
App Manifest
Every Stripe App has a stripe-app.json manifest that declares permissions, viewports, and configuration. See the App Manifest Reference for the full schema.
UI Extensions
Stripe Apps can render React-based UI components in specific Dashboard viewports. The UI toolkit provides pre-built components that match the Stripe Dashboard design system.
Permissions
Apps must declare the specific Stripe API resources they need access to. Users approve these permissions during installation. See the Permissions Reference.
Signing Secret
Each app receives a signing secret for verifying install signatures and securing communication between your backend and Stripe.
Development Workflow
- Define your manifest with required permissions and viewports
- Build the UI extension using Stripe’s React component library
- Implement backend endpoints for data sync with Brevo via Tajo
- Test locally using
stripe apps start - Upload with
stripe apps upload - Submit for review through the Stripe Dashboard
- Publish and monitor via analytics
Caution
Stripe requires apps to be written in English for marketplace distribution. Your app listing, UI text, and documentation must all be in English.
Next Steps
Start with the Publishing Guide to understand the full requirements, then work through the technical references to configure your app manifest and permissions.