Integrations

An integration is a typed binding to an external API. Integrations define how the platform communicates with external services — what endpoints are available, how to authenticate, what events to listen for, and what data structures to expect.

When an integration is added to a blueprint, its operations become actions that can be called from flows, agents, and application code through the same unified interface used for all platform operations.

What an integration defines

Integration structure

Integration
├── name, version
├── kind (rest, graphql, grpc, soap, custom)
├── baseUrl
├── params[]              → default parameters applied to all operations
│
├── auth[]                → available authentication methods
│   ├── kind              → basic, bearer, apikey, oauth2, custom
│   ├── params[]          → credential field definitions
│   └── oauth2 config     → authorization URL, token URL, scopes
│
├── operations[]          → API endpoints
│   ├── method, path      → HTTP method and URL path
│   ├── params[]          → input parameters (path, query, header, body)
│   ├── output[]          → response definitions with transforms
│   └── auth              → override or inherit auth method
│
├── channels[]            → event channels (webhook, SSE, polling)
│   └── events[]          → typed event definitions
│
├── dataTypes{}           → shared JSON schemas
└── rateLimits[]          → throttling rules

How integrations sync to blueprints

When you create or update an integration, the platform automatically synchronizes its components into the blueprint:

1. Operations → Actions — each operation becomes a callable action with auto-generated UID, input schema, and output schema
2. Auth methods → Blueprint auth methods — each authentication scheme is registered on the blueprint
3. Event channels → Blueprint event channels + definitions — each channel and its events are registered
4. Data types → Blueprint data types — shared schemas are made available

This sync happens automatically. You define the integration, and the platform creates the corresponding actions, auth methods, and event infrastructure.

Supported integration kinds

In this section

• Creating Integrations — defining a custom integration from scratch
• OpenAPI Import — importing an existing OpenAPI specification
• Connections — managing authenticated credentials for integrations
• Event Channels — receiving events from external systems