• management
• Management
• SubscribeEventsRequestParameters

Interface SubscribeEventsRequestParameters

Example

{ * from: "from", * from_timestamp: "from_timestamp", * event_type: ["group.created"] * }Copy

interface SubscribeEventsRequestParameters {
from?: string | null;
from_timestamp?: string | null;
event_type?:
| Management.EventStreamSubscribeEventsEventTypeEnum
| (EventStreamSubscribeEventsEventTypeEnum | null)[]
| null;
}

Index

Properties

from?from_timestamp?event_type?

Properties

Optionalfrom

from?: string | null

Opaque token representing position in the stream. If not provided, stream will start from the latest events.

Optionalfrom_timestamp

from_timestamp?: string | null

RFC-3339 timestamp indicating where to start streaming events from. This should only be used on the initial query when a cursor may not be available. Subsequent requests should use the cursor (from) as it will be more accurate.

Optionalevent_type

event_type?:
| Management.EventStreamSubscribeEventsEventTypeEnum
| (EventStreamSubscribeEventsEventTypeEnum | null)[]
| null

Event type(s) to listen for. Specify multiple times for multiple types (e.g., ?event_type=user.created&event_type=user.updated). If not provided, all event types will be streamed.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties fromfrom_timestampevent_type