Trigger Types
WherebyWebhookTriggers: <Object>
"room.client.joined": (
webhookData: WherebyWebhookRoomClientJoined ) => Promise<boolean> | boolean
() => false
Custom matcher on incoming "room.client.joined" webhook events. Return true if a match should be triggered or false otherwise.
"room.client.left": (
webhookData: WherebyWebhookRoomClientLeft ) => Promise<boolean> | boolean
() => false
Custom matcher on incoming "room.client.left" webhook events. Return true if a match should be triggered or false otherwise.
"room.session.started": (
webhookData: WherebyWebhookRoomSessionStarted ) => Promise<boolean> | boolean
() => false
Custom matcher on incoming "room.session.started" webhook events. Return true if a match should be triggered or false otherwise.
"room.session.ended": (
webhookData: WherebyWebhookRoomSessionEnded ) => Promise<boolean> | boolean
() => false
Custom matcher on incoming "room.session.ended" webhook events. Return true if a match should be triggered or false otherwise.
WherebyWebhookBase: <Object>
type: WebhookType
Type of webhook
apiVersion: 1.0
API version
id: string
Webhook ID
createdAt: string
Time the webhook was generated
WherebyWebhookInRoom: <Object>
meetingId?: string
Meeting identifier from the meeting that the webhook was fired from
roomName: string
Name of the room from which the webhook was fired from
roomSessionId: string | null
Session ID of the meeting that the webhook was fired from (if any)
subdoman: string
The subdomain identifier for your organization
WherebyWebhookDataClient: <Object>
displayName: string
Display name of the participant
participantId: string
Unique identifier for the participant
metadata: string | null
Custom metadata attached to the webhook
externalId: string | null
Custom identifier attached to the webhook
WherebyWebhookDataClientJoinLeave: <Object>
roleName: WherebyRoleName
Role name of the client
numClients: number
Number of clients
numClientsByRoleName: Record<WherebyRoleName, number>
Number of clients grouped by role name
WherebyWebhookRoomClientJoined: <Object>
Extends WherebyWebhookBase
Payload of this event
WherebyWebhookRoomClientLeft: <Object>
Extends WherebyWebhookBase
Payload of this event
WherebyWebhookRoomSessionStarted: <Object>
Extends WherebyWebhookBase
data: WherebyWebhookInRoom
Payload of this event
WherebyWebhookRoomSessionEnded: <Object>
Extends WherebyWebhookBase
data: WherebyWebhookInRoom
Payload of this event
WherebyRoleName: <string>
"owner"
"member"
"host"
"granted_visitor"
"viewer"
"granted_viewer"
"recorder"
"streamer"
"captioner"
"assistant"
Last updated
Was this helpful?