Viewports Referenz

Viewports definieren, wo die UI-Komponenten Ihrer Stripe App im Stripe Dashboard erscheinen. Jeder Viewport entspricht einer bestimmten Dashboard-Seite oder Position, an der Ihre App eine Ansicht rendern kann.

Funktionsweise von Viewports

Wenn Sie eine Ansicht in Ihrem App-Manifest deklarieren, ordnen Sie eine React-Komponente einem Viewport zu:

{
"ui_extension": {
"views": [
{
"viewport": "stripe.dashboard.customer.detail",
"component": "CustomerDetailView"
}
]
}
}

Dashboard-weite Viewports

Viewport-IDBeschreibung
stripe.dashboard.drawer.defaultStandard-Drawer-Ansicht, von jeder Seite über das App-Icon erreichbar
stripe.dashboard.home.overviewStartseiten-Übersicht auf der Dashboard-Landingpage
stripe.dashboard.settingsApp-Einstellungsseite
stripe.dashboard.onboardingOnboarding-Flow nach der App-Installation

Tip

Der drawer.default Viewport dient als Fallback. Wenn ein Benutzer Ihre App auf einer Seite öffnet, für die Sie keinen spezifischen Viewport deklariert haben, wird stattdessen die drawer.default Ansicht gerendert.

Seitenspezifische Viewports

Zahlungen

Viewport-IDSeiteURL-Muster
stripe.dashboard.payment.listZahlungsliste/payments
stripe.dashboard.payment.detailZahlungsdetail/payments/:id

Kunden

Viewport-IDSeiteURL-Muster
stripe.dashboard.customer.listKundenliste/customers
stripe.dashboard.customer.detailKundendetail/customers/:id

Produkte & Preise

Viewport-IDSeiteURL-Muster
stripe.dashboard.product.listProduktliste/products
stripe.dashboard.product.detailProduktdetail/products/:id

Rechnungen

Viewport-IDSeiteURL-Muster
stripe.dashboard.invoice.listRechnungsliste/invoices
stripe.dashboard.invoice.detailRechnungsdetail/invoices/:id

Abonnements

Viewport-IDSeiteURL-Muster
stripe.dashboard.subscription.listAbonnementliste/subscriptions
stripe.dashboard.subscription.detailAbonnementdetail/subscriptions/:id

Empfohlene Viewports für Tajo Brevo-Integration

KomponenteZweck
CustomerDetailViewBrevo-Kontaktinfos und Synchronisierungsstatus für einen bestimmten Kunden anzeigen
CustomerListViewBatch-Synchronisierungskontrollen und aggregierte Brevo-Synchronisierungsstatistiken
OverviewViewDashboard-Home-Widget mit Synchronisierungszustand und wichtigen Brevo-Metriken
SettingsViewBrevo API-Schlüssel, Synchronisierungspräferenzen und Feldzuordnungen konfigurieren
OnboardingViewNeue Benutzer durch die Verbindung ihres Brevo-Kontos führen

Caution

Wenn Ihr Manifest einen nicht existierenden Viewport deklariert, schlägt der App-Upload bei der Validierung fehl. Überprüfen Sie Viewport-IDs immer anhand dieser Referenz.

Subscribe to updates

developer-docs

Drop your email or phone number — we'll send you what matters next.

AI-Assistent

Hallo! Fragen Sie mich alles über die Dokumentation.

Kostenlos mit Brevo starten