Skip to main content

Aventian SaaS Integration Docs

Welcome! This site is the starting point for onboarding a new product under the Aventian umbrella. Follow the quick start below, then dive deeper into the linked guides.

Quick Start (High-Level)

  1. Read the Integration Steps – a concise map of the whole journey.
  2. Contact Aventian – request an onboarding session & product registration credentials.
  3. Register Your Product – add metadata so provisioning & routing work.
  4. Set Up Authentication – implement Auth0 + token verification flows.
  5. Understand Tenant Databases – learn silo / schema model & provisioning expectations.
  6. Adopt Optional Services – notifications, management APIs, shared React components.
  7. Iterate & Review – regular check‑ins to validate roles, privileges & UX flow.

If you only do one thing first: read the high‑level page. It links every deep dive.

When to Use Which Doc

GoalStart Here
Confirm product eligibilityproduct-integration (minimum requirements)
Understand tenant DB isolationtenant-architecture/intro
Implement login + secure routesauthentication/overview & authentication/integration
Define resources / privileges / rolesproduct-integration
Send user notificationsnotification-service
Call platform / management APIsexternal-api
Embed shared UI widgetsreact-components

Responsibilities

Aventian Team

  • Provide onboarding session & sandbox credentials.
  • Maintain platform & core integration docs.
  • Provision / approve product registration & tenant resources.
  • Support troubleshooting and review security / role models.

Product Team

  • Study & follow integration and security guidelines.
  • Supply product metadata (name, base URL, logo, redirects) promptly.
  • Implement auth, resource + privilege modeling, and database schema per standards.
  • Report blockers early; request scope changes before building divergences.
  • Participate in integration reviews & suggest doc improvements.

Core Platform Stack

TechPurpose
Auth0Centralized authentication & SSO
PostgreSQLPer‑tenant silo DB engine
GKEContainer orchestration for tenant silos
Pub/SubEvent & async messaging backbone
ReactShared UI & component library foundation

These services underpin provisioning, multi‑tenant isolation, and product interoperability.