Trigger Types
WebhookType:<string>
room.client.joined
This is sent when a user joins the meeting room
room.client.left
This is sent when a user leaves the meeting room (this could be via the leave button or by closing the browser tab)
room.session.started
Sent when a room session starts, which is when there are at least 2 users in a room.
room.session.ended
Sent when a room session ends. Currently, a session will end when the number of participants has been less than 2 for some time. This heuristic could change in the future to better determine that a session has ended
TriggerOptions<Object>
webhookTriggers: WherebyWebhookTriggers
Webhook trigger that should be listened for to trigger room join
port?: number
The port that this service should run on - default is 8080
TriggerEvents
[TRIGGER_EVENT_SUCCESS]: [ { roomUrl: string; triggerWebhook: WherebyWebhookType, ];
Emitted when trigger conditions are successfully met
WherebyWebhookTriggers
A function that receives the payload defined for this webhook type (WherebyWebhookTriggerTypes[Key]) and returns a boolean or Promise<boolean>. Returning true indicates that the trigger should start an Assistant. |
WherebyWebhookTriggerTypes<Object>
"room.client.joined": WherebyWebhookRoomClientJoined
Room client joined event
"room.client.left":WherebyWebhookRoomClientLeft
Room client left event
"room.session.started": WherebyWebhookRoomSessionStarted
Room session started event
"room.session.ended": WherebyWebhookRoomSessionEnded
Room session ended event
WherebyWebhookBase<Object>
type: WebhookType
Type of webhook
apiVersion: 1.0
Api version
id: string
Webhook ID
createdAt: string
Time the webhook was created at
WherebyWebhookType
WherebyRoleName<string>
"owner"
"member"
"host"
"granted_visitor"
"viewer"
"granted_viewer"
"recorder"
"streamer"
"captioner"
"assistant"
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
subdoman: string
The 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
Last updated
Was this helpful?