Aviato / docs
Reference

SDK capabilities

Choose where to implement custom behavior.

View Markdown

The TypeScript, Go, and Laravel SDKs implement the same plugin protocol. Their APIs follow each language's conventions.

CapabilityUse it for
Declarative UINative record summaries, reusable components, and custom action form layouts. See Custom UI.
LayoutA collection's label, icon, field order and settings, search fields, default sort and virtual relations, declared in code instead of the dashboard. See Declare layouts in code.
Provider integrationTyped StripePlugin widgets for billing, ZendeskPlugin widgets for users and support tickets, and IntercomPlugin widgets for contacts through the common IntegrationPlugin contract. See Stripe widgets for setup and release availability.
ActionA business operation run on one record, many records, or a collection.
Computed fieldA displayed value derived from declared dependencies.
HookValidate or modify an operation before it runs, or react afterwards.
SegmentA named filter supplied by application logic.
SearchTranslate a search term into a collection filter.
Write overrideTranslate a field edit into underlying values.
ChartCompute data or a visualization specification.
Relation hintsDescribe relations not expressed as database foreign keys.
Custom datasourceExpose records from an API or other external source.

Select an SDK

SDK guidePublic packageRequirements
TypeScript@getaviato/sdkNode.js 22+; Fetch-compatible HTTP handler.
Gogithub.com/getaviato/aviato-goGo 1.25+; standard HTTP, Gin, or Echo.
Laravelgetaviato/laravelPHP 8.3+ and Laravel 12 or 13.

All three SDKs are MIT licensed. The old Composer package aviato/laravel has been replaced by getaviato/laravel. SDK packages extend an existing Aviato connector; installing an SDK does not install the connector.

Test your handlers

Each SDK ships a test kit that calls your handlers without a connector, with a fake admin caller and an in-memory Data API seeded with records. The kits share method names (executeAction, computeField, runHooks, actingAs, withRecords, …) and write assertions (assertCreated, assertUpdated, assertDeleted, assertNothingWritten).

SDKTest kit
TypeScriptcreatePluginTest(plugin) from @getaviato/sdk/testing (guide)
NestJScreatePluginTest(moduleRef) from @getaviato/nestjs/testing (guide)
Goaviatotest.New(t, plugin) (guide)
LaravelAviato::fake() (guide)

The fake Data API does not apply your Aviato roles, row scopes or the read-only tokens of computed fields, search, segments and charts. Test permission boundaries against a connector.

Request security

The connector signs every plugin request with the Standard Webhooks secret you set as AVIATO_PLUGIN_SECRET (whsec_ followed by at least 16 base64-encoded bytes; the dashboard generates 24). Each SDK verifies that:

  • the signature is valid and less than five minutes old;
  • it was made for the endpoint that received it, so a captured request cannot be sent to another handler;
  • its webhook-id has not been seen before, so a captured request cannot be replayed. The TypeScript and Go SDKs remember IDs in memory per process; Laravel uses the files cache store, shared by your workers.

Connectors released before endpoint binding send unbound IDs, which the SDKs still accept. Upgrade the connector to get the binding.

Each call gives your code an invocation token for the Data API, valid for five minutes and acting as the caller. Tokens of hooks, write overrides, actions and custom datasource writes can create, update and delete records. Tokens of read-only calls (computed fields, search, segments, charts, form resolution, datasource reads) can only read. Write from an action or a hook, not from a computed field.

Compatibility

Pin your connector and SDK releases and check their compatibility before upgrading. The repository runs protocol conformance tests against language fixtures; your own application should also test its handlers and permission boundaries.

This documentation tracks the current codebase. There are no archived versioned documentation sets yet. Consult your pinned release's source when its API differs from an example.

Public and internal APIs

The SDK plugin protocol and connector interfaces are the integration surface described here. The dashboard's GraphQL schema is an internal application interface, so this site does not publish every resolver as a supported public API.

Edit on GitHub

On this page