EventSubTransport

@Serializable
data class EventSubTransport(val method: String, val sessionId: String? = null, val callback: String? = null, val secret: String? = null, val conduitId: String? = null)

Transport configuration for an EventSubSubscription.

Constructors

Link copied to clipboard
constructor(method: String, sessionId: String? = null, callback: String? = null, secret: String? = null, conduitId: String? = null)

Properties

Link copied to clipboard

the callback URL where events are sent (webhook only).

Link copied to clipboard
@SerialName(value = "conduit_id")
val conduitId: String?

the conduit ID (conduit only).

Link copied to clipboard

the transport method: webhook, websocket, or conduit.

Link copied to clipboard

the secret used to verify webhook event signatures.

Link copied to clipboard
@SerialName(value = "session_id")
val sessionId: String?

the WebSocket session ID (websocket only).