Aviato / docs
Plugins & integrations

Plugins & integrations

Connect your application and add typed provider widgets that run on your own infrastructure.

View Markdown

Use Aviato's language SDKs to extend your back-office with application behavior and ready-to-use provider widgets. Your connector runs next to your database; your application hosts the SDK plugin that declares the behavior and widget bindings.

Typed provider plugins

StripePlugin, ZendeskPlugin and IntercomPlugin implement the common IntegrationPlugin interface in each SDK. Their typed methods distinguish each provider's resource IDs. Configure the credential environment-variable name once, declare the widgets you want, and register the integration on your application plugin using use / Use.

Each widget selects a collection, a unique name within that collection, and an ID column. Bind directly to the current record or through one belongsTo relation. For example, an order can display invoices using its customer's stripe_customer_id. An optional title customizes the heading; otherwise Aviato supplies a localized title.

SDKIntegration registrationSetup
TypeScriptplugin.use(stripe)TypeScript SDK
NestJSAviatoModule.forFeature({ plugins: [token] })NestJS integration
Goplugin.Use(stripe)Go SDK
LaravelAviato::use($stripe)Laravel SDK

Registration validates and snapshots the declarations. To apply builder changes, register the integration again. An invalid registration leaves existing definitions unchanged. Reusing a collection/name pair replaces that widget while preserving others.

Stripe, Zendesk and Intercom have built-in adapters. The Stripe guide, Zendesk guide and Intercom guide include complete examples and release availability.

Where provider requests run

The record page requests a widget from your connector. The connector checks record and column permissions, resolves the provider ID from your database, and requests data directly from the configured provider. It returns only the display fields supported by the widget.

For Stripe, store the restricted key in the connector's process environment. SDK configuration contains only its environment-variable name. Provider keys and response bodies never pass through Aviato's control plane. The ordinary audit trail records the local record read and outcome without provider IDs, keys, or response bodies.

Widgets currently perform reads only. Configure the Stripe restricted key with Read/None permissions: accepting a restricted-key prefix and readOnly: true does not prove that the key has no write permissions. Follow the credential setup.

Zendesk uses an OAuth token and verifies its read-only scopes before each data request. See Zendesk credentials.

Intercom uses an access token that the connector cannot verify as read-only, so the read-only setup depends on the app's permissions. See Intercom credentials.

Extending the system

Integration authors implement IntegrationPlugin to produce widget declarations. Provider execution belongs in the customer connector's provider registry, where each adapter defines supported resources, credential rules, fixed endpoints, and projected display fields. Declaring a new provider name alone does not install an adapter.

The shared contract lets future providers reuse record authorization and the existing widget renderer. See future providers for the extension boundaries. For application-specific behavior today, use SDK actions, hooks, custom summaries and forms, or custom datasources.

Edit on GitHub

On this page