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 Automations

Guide Contents

This documentation covers the complete lifecycle of building and publishing a Stripe App:

Getting Started

GuideDescription
Publishing to MarketplaceRequirements and steps to submit your app for review
App Review RequirementsQuality, security, and UX standards for approval

Configuration & Reference

GuideDescription
App Manifest ReferenceComplete schema for the stripe-app.json manifest file
Permissions ReferenceFull list of Stripe API permissions and how to request them
Viewports ReferenceDashboard locations where your app UI can appear

Features & Integration

GuideDescription
Embedded Stripe AppsUsing Connect embedded components for platform integrations
Install Links & Deep LinksGenerate install URLs and deep link into specific app views
Post-Install ActionsConfigure onboarding flows after app installation

Operations & Growth

GuideDescription
App AnalyticsTrack installs, views, and conversion metrics
Partner EcosystemLeverage Stripe’s partner program for co-marketing and growth

Prerequisites

Before building a Stripe App, ensure you have:

  1. Stripe Account: An activated Stripe account (not restricted to test mode)
  2. Stripe CLI: Install the Stripe CLI for local development and app uploads
  3. Node.js: Version 16 or later for the app UI extension
  4. Tajo Platform Access: Active Tajo account with Brevo API credentials configured

Quick Start

Terminal window
# Install Stripe CLI
brew install stripe/stripe-cli/stripe
# Login to your Stripe account
stripe login
# Create a new Stripe App project
stripe apps create tajo-brevo-integration
# Start local development
stripe apps start

Key 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

  1. Define your manifest with required permissions and viewports
  2. Build the UI extension using Stripe’s React component library
  3. Implement backend endpoints for data sync with Brevo via Tajo
  4. Test locally using stripe apps start
  5. Upload with stripe apps upload
  6. Submit for review through the Stripe Dashboard
  7. 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.

AI Assistant

Hi! Ask me anything about the docs.

Start Free with Brevo