Connect
Self-Managed Only

pusher

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

Introduced in version 4.3.0.

  • Common

  • Advanced

output:
  label: ""
  pusher:
    batching:
      count: 0
      byte_size: 0
      period: ""
      check: ""
    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
output:
  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

appId

Pusher app id

Type: string

batching

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

Type: object

# 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

The maximum total size (in bytes) that a batch can reach before it is flushed. When the combined size of all messages in the batch reaches or exceeds this limit, the batch is immediately sent to the next stage (such as a processor or output).

Set to 0 to disable size-based batching. When disabled, messages are flushed based on other conditions (such as count or period).

Type: int

Default: 0

batching.check

A Bloblang query that returns a boolean value indicating whether a message should end a batch.

Type: string

Default: ""

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

batching.count

The number of messages at which the batch is flushed. Set to 0 to disable count-based batching.

Type: int

Default: 0

batching.period

The length of time after which an incomplete batch is flushed regardless of its size. This field accepts Go duration format strings such as 100ms, 1s, or 5s. Supported time units are ns, us, ms, s, m, and h.

Type: string

Default: ""

# Examples:
period: 1s

# ---

period: 1m

# ---

period: 500ms

batching.processors[]

A list of processors to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. All resulting messages are flushed as a single batch, so splitting the batch into smaller batches with these processors has no effect.

Type: array<processor>

# Examples:
processors:
  - archive:
      format: concatenate


# ---

processors:
  - archive:
      format: lines


# ---

processors:
  - archive:
      format: json_array

channel

Pusher channel to publish to. Interpolation functions can also be used

Type: string

# Examples:
channel: my_channel

# ---

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

cluster

Pusher cluster

Type: string

event

Event to publish to

Type: string

key

Pusher key

Type: string

max_in_flight

The maximum number of message batches to publish to Pusher in parallel. Each batch is sent as one trigger batch request.

Type: int

Default: 1

secret

Pusher secret

Type: string

secure

Enable SSL encryption

Type: bool

Default: true