# Trigger Types

## WherebyWebhookTriggers: <mark style="color:green;">\<Object></mark>

<table><thead><tr><th width="390.96484375">Property</th><th width="173.77734375">Default</th><th>Description</th></tr></thead><tbody><tr><td><p><code>"room.client.joined": (</code></p><p><code>webhookData:</code> <a href="#wherebywebhookroomclientjoined-less-than-object-greater-than"><code>WherebyWebhookRoomClientJoined</code></a> <code>) => Promise&#x3C;boolean> | boolean</code></p></td><td><code>() => false</code></td><td>Custom matcher on incoming <a href="/pages/1mbheJqh7EnStvj4GPo0">"room.client.joined" webhook events</a>. Return <code>true</code> if a match should be triggered or <code>false</code> otherwise.</td></tr><tr><td><p><code>"room.client.left": (</code></p><p><code>webhookData:</code> <a href="#wherebywebhookroomclientleft-less-than-object-greater-than"><code>WherebyWebhookRoomClientLeft</code></a> <code>) => Promise&#x3C;boolean> | boolean</code></p></td><td><code>() => false</code></td><td>Custom matcher on incoming <a href="/pages/1mbheJqh7EnStvj4GPo0">"room.client.left" webhook events</a>. Return <code>true</code> if a match should be triggered or <code>false</code> otherwise.</td></tr><tr><td><p><code>"room.session.started": (</code></p><p><code>webhookData:</code> <a href="#wherebywebhookroomsessionstarted-less-than-object-greater-than"><code>WherebyWebhookRoomSessionStarted</code></a> <code>) => Promise&#x3C;boolean> | boolean</code></p></td><td><code>() => false</code></td><td>Custom matcher on incoming <a href="/pages/1mbheJqh7EnStvj4GPo0">"room.session.started" webhook events.</a> Return <code>true</code> if a match should be triggered or <code>false</code> otherwise.</td></tr><tr><td><p><code>"room.session.ended": (</code></p><p><code>webhookData:</code> <a href="#wherebywebhookroomsessionended-less-than-object-greater-than"><code>WherebyWebhookRoomSessionEnded</code></a> <code>) => Promise&#x3C;boolean> | boolean</code></p></td><td><code>() => false</code></td><td>Custom matcher on incoming <a href="/pages/1mbheJqh7EnStvj4GPo0">"room.session.ended" webhook events.</a> Return <code>true</code> if a match should be triggered or <code>false</code> otherwise.</td></tr><tr><td><code>"assistant.requested": (webhookData:</code><a href="#wherebywebhookassistantrequested-less-than-object-greater-than"> <code>WherebyWebhookAssistantRequested</code></a><code>) => Promise&#x3C;boolean> | boolean</code></td><td><code>() => false</code></td><td>Custom matcher on incoming <a href="/pages/1mbheJqh7EnStvj4GPo0">"assistant.requested" webhook events.</a> Return <code>true</code> if a match should be triggered or <code>false</code> otherwise.</td></tr></tbody></table>

## WherebyWebhookBase: <mark style="color:green;">\<Object></mark>

| Property            | Description                    |
| ------------------- | ------------------------------ |
| `type: WebhookType` | Type of webhook                |
| `apiVersion: 1.0`   | API version                    |
| `id: string`        | Webhook ID                     |
| `createdAt: string` | Time the webhook was generated |

## WherebyWebhookInRoom: <mark style="color:green;">\<Object></mark>

<table><thead><tr><th width="300.578125">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>meetingId?: string</code></td><td>Meeting identifier from the meeting that the webhook was fired from</td></tr><tr><td><code>roomName: string</code></td><td>Name of the room from which the webhook was fired from</td></tr><tr><td><code>roomSessionId: string | null</code></td><td>Session ID of the meeting that the webhook was fired from (if any)</td></tr><tr><td><code>subdoman: string</code></td><td>The subdomain identifier for your organization</td></tr></tbody></table>

## WherebyWebhookDataClient: <mark style="color:green;">\<Object></mark>

<table><thead><tr><th width="302.49609375">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>displayName: string</code></td><td>Display name of the participant</td></tr><tr><td><code>participantId: string</code></td><td>Unique identifier for the participant</td></tr><tr><td><code>metadata: string | null</code></td><td>Custom metadata attached to the webhook</td></tr><tr><td><code>externalId: string | null</code></td><td>Custom identifier attached to the webhook</td></tr></tbody></table>

## WherebyWebhookDataClientJoinLeave: <mark style="color:green;">\<Object></mark>

<table><thead><tr><th width="303.4140625">Property</th><th>Description</th></tr></thead><tbody><tr><td><code>roleName:</code> <a href="#wherebyrolename-less-than-string-greater-than"><code>WherebyRoleName</code></a></td><td>Role name of the client</td></tr><tr><td><code>numClients: number</code></td><td>Number of clients</td></tr><tr><td><code>numClientsByRoleName: Record&#x3C;</code><a href="#wherebyrolename-less-than-string-greater-than"><code>WherebyRoleName</code></a><code>, number></code></td><td>Number of clients grouped by role name</td></tr></tbody></table>

## WherebyWebhookRoomClientJoined: <mark style="color:green;">\<Object></mark>

Extends [WherebyWebhookBase](#wherebywebhookbase-less-than-object-greater-than)

| Property                                                                                                                                                                                                                                                                                    | Description           |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| `data:` [`WherebyWebhookInRoom`](#wherebywebhookinroom-less-than-object-greater-than) `&` [`WherebyWebhookDataClientJoinLeave`](#wherebywebhookdataclientjoinleave-less-than-object-greater-than) `&` [`WherebyWebhookDataClient`](#wherebywebhookdataclient-less-than-object-greater-than) | Payload of this event |

## WherebyWebhookRoomClientLeft: <mark style="color:green;">\<Object></mark>

Extends [WherebyWebhookBase](#wherebywebhookbase-less-than-object-greater-than)

| Property                                                                                                                                                                                                                                                                                    | Description           |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| `data:` [`WherebyWebhookInRoom`](#wherebywebhookinroom-less-than-object-greater-than) `&` [`WherebyWebhookDataClientJoinLeave`](#wherebywebhookdataclientjoinleave-less-than-object-greater-than) `&` [`WherebyWebhookDataClient`](#wherebywebhookdataclient-less-than-object-greater-than) | Payload of this event |

## WherebyWebhookRoomSessionStarted: <mark style="color:green;">\<Object></mark>

Extends [WherebyWebhookBase](#wherebywebhookbase-less-than-object-greater-than)

| Property                                                                              | Description           |
| ------------------------------------------------------------------------------------- | --------------------- |
| `data:` [`WherebyWebhookInRoom`](#wherebywebhookinroom-less-than-object-greater-than) | Payload of this event |

## WherebyWebhookRoomSessionEnded: <mark style="color:green;">\<Object></mark>

Extends [WherebyWebhookBase](#wherebywebhookbase-less-than-object-greater-than)

| Property                                                                              | Description           |
| ------------------------------------------------------------------------------------- | --------------------- |
| `data:` [`WherebyWebhookInRoom`](#wherebywebhookinroom-less-than-object-greater-than) | Payload of this event |

## WherebyWebhookAssistantRequested: <mark style="color:green;">\<Object></mark>

Extends [WherebyWebhookBase](#wherebywebhookbase-less-than-object-greater-than)

| Property                                                                              | Description           |
| ------------------------------------------------------------------------------------- | --------------------- |
| `data:` [`WherebyWebhookInRoom`](#wherebywebhookinroom-less-than-object-greater-than) | Payload of this event |

## WherebyRoleName: <mark style="color:green;">\<string></mark>

| Type                |
| ------------------- |
| "`owner"`           |
| `"member"`          |
| `"host"`            |
| `"granted_visitor"` |
| `"viewer"`          |
| `"granted_viewer"`  |
| `"recorder"`        |
| `"streamer"`        |
| `"captioner"`       |
| `"assistant"`       |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.whereby.com/reference/assistant-sdk-reference/types/trigger-types.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.