Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventStreamUpdate

Hierarchy

  • EventStreamUpdate

Index

Properties

Optional description

description: string

Human-readable description of the Event Stream. Optional, max 255 bytes.

Optional destinationIds

destinationIds: string[]

A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.

Optional fields

fields: string[]

A list of protocol-specific fields you want to collect on each event.

id

id: string

Unique identifier for this Event Stream.

Optional metadata

metadata: string

Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.

Optional samplingRate

samplingRate: number

The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.

Generated using TypeDoc