Skip to content

PayloadType

Union Type

PayloadType module-attribute

Contains the payload content for an event.

Union Member Types

PayloadTypeConversational dataclass

Bases: _SerdeShape

The conversational content of the payload.

Attributes

value instance-attribute

PayloadTypeBlob dataclass

Bases: _SerdeShape

The binary content of the payload.

Attributes

value instance-attribute
value: Document

PayloadTypeJson dataclass

Bases: _SerdeShape

The JSON content of the payload. Use this type to store non-conversational, JSON-formatted data, such as behavioral events, activity logs, or system events.

Attributes

value instance-attribute

PayloadTypeUnknown dataclass

Bases: _SerdeShape

Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. This value may not be deliberately sent.

Attributes

tag instance-attribute
tag: str