BeamConfig
The top-level object returned by all config endpoints.CreateBeamConfigRequest
Request body for Create pipeline. Same asBeamConfig, without the server-set fields.
UpdateBeamConfigRequest
Request body for Update pipeline. Same shape asCreateBeamConfigRequest. The pipeline is identified by config_id in the URL path. Server-set fields (id, owner_org_team_user_id, organization_id, created_at, updated_at) keep their existing values and are ignored if sent.
PipelineConfig
Source
The Allium Datastream the pipeline reads from, identified by chain and entity.For
kafka sources, set only type, chain, and entity. The connection fields keep their defaults.Supported chains and entities
Coverage expands regularly. For current availability, see the Datastreams catalog or call
GET /api/v1/beam/sources, which requires a Beam-enabled organization.Transforms
Transforms run in order. Each one is a JavaScript (v8) function. Omit uid when adding a transform; the server assigns one.
Filter, modify, enrich, or reshape each record with a JavaScript function. Return null to drop the record.
Example: keep only transfers of Base USDC.
beam.contains().
Example: tag each transfer by size.
Sinks
A sink is where the pipeline delivers records. Each pipeline has exactly one sink, sosinks takes a single entry. Omit uid when adding a sink; the server assigns one. Five types are available:
- Kafka
- SNS
- External Kafka
- Webhook
- NATS JetStream
Delivers to an Allium-managed Kafka topic. After deployment, the Allium App shows connection credentials and consumer code samples.
Need a different sink type? Contact [email protected].
IDs
When you create a pipeline, transform, or sink, omitid or uid and the server assigns one. When you update, include it to reference the existing resource.