Class LiveKitWebhookParser

Verifies and parses LiveKit webhooks.

Index

Constructors

Methods

Constructors

constructor

new LiveKitWebhookParser(
config?: Partial<LiveKitServerConfig>,
receiver?: WebhookReceiverLike,
): LiveKitWebhookParser
Parameters
- Optionalconfig: Partial<LiveKitServerConfig>
  Explicit credentials; omitted fields fall back to the LIVEKIT_* environment variables.
- Optionalreceiver: WebhookReceiverLike
  Injectable receiver (tests); defaults to the SDK's WebhookReceiver.
Returns LiveKitWebhookParser
Throws
when no receiver is injected and the API key and secret are not configured.
- Defined in LiveKitRoomServer/src/livekit-webhook.ts:51

Methods

Parse

Parse(body: string, authHeader?: string): Promise<LiveKitRoomWebhookEvent>
Verifies the request's signature and returns the event.

One event is also acted on here, because every LiveKit webhook MJ receives passes through this method: on a verified room_finished the room's RoomAudioPlayer playbacks (hold music) are stopped, so a bot never outlives its room. That cleanup runs in the background and never throws.
Parameters
- body: string
  The raw request body (the signature covers the exact bytes, so do not re-serialise parsed JSON).
- OptionalauthHeader: string
  The request's Authorization header.
Returns Promise<LiveKitRoomWebhookEvent>
Throws
when the signature is missing or does not verify.
- Defined in LiveKitRoomServer/src/livekit-webhook.ts:75