Index

OpenBack documentation

Everything you need to use OpenBack and build on it. Each area has an entry page, how-to guides for tasks and a reference page for every piece.

How it is organized

Area

The entry page of each area: where to start, the key concepts in a few lines, the list of guides and reference pages.

How-to

A guide for one task: what you need first, the steps with their expected result, how to check, common problems.

Reference

The reference of a single piece: what it is for, inputs, outputs, settings, limits, examples and where it is used.

Areas

Functions and LogicBlocksFunctions are the logic OpenBack stores and runs. You build them by connecting blocks in a visual editor, and they start from an API call, an event, a webhook or a timer.

API and endpointsComing soon

Integrations and pluginsComing soon

App authenticationComing soon

AI gatewayComing soon

Graph and AIComing soon

HostingComing soon

StorageComing soon

MQTT and Lab BridgeComing soon

Logs and metricsComing soon

Configuration and secretsComing soon

Organizations, projects and permissionsComing soon

Exporting and importing projectsComing soon

SDKs

Integration SDK Python 3.9+ · v0.23.0

The library for writing integration packages: new connections to external services, block libraries and AI model providers. Its documentation will be published here, covering:

Getting started
The package manifest
Operations
Webhooks
Calling REST APIs
Connected accounts (OAuth)
SQL databases and query templates
AI providers
LogicBlock libraries
Testing
Packaging, dependencies and documentation
Versioning

Authentication SDKs 13 platforms · v1.0.0

The libraries that sign the users of your apps in to an OpenBack user pool and verify their tokens on your servers. Sources, examples and READMEs are on GitHub.

Open the SDKs on GitHub ↗