> ## Documentation Index
> Fetch the complete documentation index at: https://docs.allium.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Create, deploy, and consume your first Beam pipeline in minutes.

> [!NOTE]
>
> **Beta access required.** Beam is in beta. Contact [support@allium.so](mailto:support@allium.so) to request access before you begin.

![A Beam pipeline that streams Polygon logs through a set filter on address into a Kafka sink named usdc-logs](https://mintcdn.com/allium-e770e2b7/2Cik69FC65-mGWej/images/app/beam/editor.webp?fit=max\&auto=format\&n=2Cik69FC65-mGWej\&q=85\&s=8981a9b386c141561718c94dca6398ed)

## Create your first pipeline

**1. Create a pipeline**

In Allium App, open **Build > Beam** and choose **New**. A new pipeline streams Polygon logs through an empty set filter into a Kafka sink. **Start with Template** builds one from a template instead, and can deploy it in the same step.

**2. Pick the source**

Choose a chain and entity to stream, for example **polygon** and **log** for every Polygon log. **Zero-lag** streams from the chain tip before finality, for lower latency at the cost of possible reorged data.

![Beam source set to the polygon chain and log entity](https://mintcdn.com/allium-e770e2b7/2Cik69FC65-mGWej/images/app/beam/source.webp?fit=max\&auto=format\&n=2Cik69FC65-mGWej\&q=85\&s=1ea1b210afa1da78052aacd3886e7c2b)

**3. Filter the records**

Edit the set filter, pick the field to match, and add the values to keep. To keep only USDC on Polygon, filter on `address`, the contract that emitted the log, and add `0x3c499c542cef5e3811e1192ce70d8cc03d5c3359`. Values can be pasted or uploaded as a `.txt` or `.csv` file.

![Set filter matching address against the allowed set](https://mintcdn.com/allium-e770e2b7/2Cik69FC65-mGWej/images/app/beam/filter.webp?fit=max\&auto=format\&n=2Cik69FC65-mGWej\&q=85\&s=953d32d598a49e25ba9b97c4c9975b19)

**4. Name the sink**

Name the Kafka sink, for example `usdc-logs`. The name becomes part of the topic you consume from.

![Kafka sink named usdc-logs](https://mintcdn.com/allium-e770e2b7/2Cik69FC65-mGWej/images/app/beam/sink.webp?fit=max\&auto=format\&n=2Cik69FC65-mGWej\&q=85\&s=91626035fcad05ebd01f8b4fd7e37f02)

**5. Deploy**

**Save** keeps the pipeline without running it. **Deploy** provisions your Kafka topic and credentials and starts the pipeline, usually in under 30 seconds.

**6. Consume your data**

Once deployed, **Get cooking** has the Kafka credentials, the topic, and consumer code with the credentials filled in.

![Get cooking panel with Kafka credentials and the pipeline's topic](https://mintcdn.com/allium-e770e2b7/2Cik69FC65-mGWej/images/app/beam/get-cooking.webp?fit=max\&auto=format\&n=2Cik69FC65-mGWej\&q=85\&s=37510166cd6f111a4335df5e1d75f804)

```python Python theme={null}
from confluent_kafka import Consumer

conf = {
    "bootstrap.servers": "<bootstrap-server>",
    "group.id": "<group-id-prefix>my-consumer-group",
    "security.protocol": "SASL_SSL",
    "sasl.mechanism": "SCRAM-SHA-512",
    "sasl.username": "<username>",
    "sasl.password": "<password>",
    "auto.offset.reset": "latest",
}

consumer = Consumer(conf)
consumer.subscribe(["beam.<config_id>.usdc-logs"])

while True:
    msg = consumer.poll(1.0)
    if msg is None:
        continue
    print(msg.value().decode("utf-8"))
```

```typescript TypeScript theme={null}
import { Kafka } from "kafkajs";

const kafka = new Kafka({
  brokers: ["<bootstrap-server>"],
  ssl: true,
  sasl: {
    mechanism: "scram-sha-512",
    username: "<username>",
    password: "<password>",
  },
});

const consumer = kafka.consumer({ groupId: "<group-id-prefix>my-consumer-group" });

await consumer.connect();
await consumer.subscribe({ topic: "beam.<config_id>.usdc-logs" });

await consumer.run({
  eachMessage: async ({ message }) => {
    console.log(message.value?.toString());
  },
});
```

Replace the placeholders with the values from **Get cooking**. Start the consumer group ID with your group ID prefix.

## Verify your deployment

A deployed pipeline previews the latest messages from each sink, and reports worker health, events processed, latency, and errors over the last hour, day, or week. Every worker should be healthy. If one isn't, see [Troubleshooting](https://docs.allium.so/beam/configuration.md#troubleshooting).

![Deployment messages preview for a healthy pipeline's Kafka sink](https://mintcdn.com/allium-e770e2b7/2Cik69FC65-mGWej/images/app/beam/deployment-messages.webp?fit=max\&auto=format\&n=2Cik69FC65-mGWej\&q=85\&s=7a6844e7a6ad1dc48a9a57e6fe53d733)

![Deployment health with one healthy worker, events processed and latency charts](https://mintcdn.com/allium-e770e2b7/2Cik69FC65-mGWej/images/app/beam/deployment-health.webp?fit=max\&auto=format\&n=2Cik69FC65-mGWej\&q=85\&s=dd0926b0108935e4735dff60c6f48acd)

## Updating a pipeline

Edit the source, transforms, or sinks and deploy again. Deploys are **idempotent and zero-downtime**; changes apply in place.

> [!WARNING]
>
> Don't tear down before redeploying. Tearing down causes unnecessary downtime.

## Next steps

> [card] [Configuration reference](https://docs.allium.so/beam/configuration.md)
>
> Sources, transforms, and sinks

> [card] [Examples](https://docs.allium.so/beam/examples.md)
>
> Ready-to-use pipeline configs for common use cases
