# pusher

> For the complete documentation index, see [llms.txt](https://docs.redpanda.com/llms.txt). Component-specific: [connect-full.txt](https://docs.redpanda.com/connect-full.txt)

---
title: pusher
latest-connect-version: 4.93.0
latest-operator-version: v26.1.4
latest-console-tag: v3.7.3
latest-redpanda-tag: v26.1.9
docname: outputs/pusher
page-component-name: connect
page-version: master
page-component-version: master
page-component-title: Connect
page-relative-src-path: outputs/pusher.adoc
page-edit-url: https://github.com/redpanda-data/rp-connect-docs/edit/main/modules/components/pages/outputs/pusher.adoc
page-git-created-date: "2024-05-24"
page-git-modified-date: "2026-05-26"
---

<!-- Source: https://docs.redpanda.com/connect/components/outputs/pusher.md -->

**Available in:** Self-Managed

Output for publishing messages to Pusher API ([https://pusher.com](https://pusher.com))

Introduced in version 4.3.0.

#### Common

```yml
outputs:
  label: ""
  pusher:
    batching:
      count: 0
      byte_size: 0
      period: ""
      check: ""
      processors: [] # No default (optional)
    channel: "" # No default (required)
    event: "" # No default (required)
    appId: "" # No default (required)
    key: "" # No default (required)
    secret: "" # No default (required)
    cluster: "" # No default (required)
    secure: true
    max_in_flight: 1
```

#### Advanced

```yml
outputs:
  label: ""
  pusher:
    batching:
      count: 0
      byte_size: 0
      period: ""
      check: ""
      processors: [] # No default (optional)
    channel: "" # No default (required)
    event: "" # No default (required)
    appId: "" # No default (required)
    key: "" # No default (required)
    secret: "" # No default (required)
    cluster: "" # No default (required)
    secure: true
    max_in_flight: 1
```

## [](#fields)Fields

### [](#appid)`appId`

Pusher app id

**Type**: `string`

### [](#batching)`batching`

maximum batch size is 10 (limit of the pusher library)

**Type**: `object`

```yaml
# Examples:
batching:
  byte_size: 5000
  count: 0
  period: 1s

# ---

batching:
  count: 10
  period: 1s

# ---

batching:
  check: this.contains("END BATCH")
  count: 0
  period: 1m
```

### [](#batching-byte_size)`batching.byte_size`

An amount of bytes at which the batch should be flushed. If `0` disables size based batching.

**Type**: `int`

**Default**: `0`

### [](#batching-check)`batching.check`

A [Bloblang query](https://docs.redpanda.com/connect/guides/bloblang/about/) that should return a boolean value indicating whether a message should end a batch.

**Type**: `string`

**Default**: `""`

```yaml
# Examples:
check: this.type == "end_of_transaction"
```

### [](#batching-count)`batching.count`

A number of messages at which the batch should be flushed. If `0` disables count based batching.

**Type**: `int`

**Default**: `0`

### [](#batching-period)`batching.period`

A period in which an incomplete batch should be flushed regardless of its size.

**Type**: `string`

**Default**: `""`

```yaml
# Examples:
period: 1s

# ---

period: 1m

# ---

period: 500ms
```

### [](#batching-processors)`batching.processors[]`

A list of [processors](https://docs.redpanda.com/connect/components/processors/about/) to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.

**Type**: `processor`

```yaml
# Examples:
processors:
  - archive:
      format: concatenate

# ---

processors:
  - archive:
      format: lines

# ---

processors:
  - archive:
      format: json_array
```

### [](#channel)`channel`

Pusher channel to publish to. Interpolation functions can also be used This field supports [interpolation functions](https://docs.redpanda.com/connect/configuration/interpolation/#bloblang-queries).

**Type**: `string`

```yaml
# Examples:
channel: my_channel

# ---

channel: ${!json("id")}
```

### [](#cluster)`cluster`

Pusher cluster

**Type**: `string`

### [](#event)`event`

Event to publish to

**Type**: `string`

### [](#key)`key`

Pusher key

**Type**: `string`

### [](#max_in_flight)`max_in_flight`

The maximum number of parallel message batches to have in flight at any given time.

**Type**: `int`

**Default**: `1`

### [](#secret)`secret`

Pusher secret

**Type**: `string`

### [](#secure)`secure`

Enable SSL encryption

**Type**: `bool`

**Default**: `true`