> ## Documentation Index
> Fetch the complete documentation index at: https://www.cometchat.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Overview of Overview in CometChat REST API.

<Info>
  1. The Webhook API documentation provides comprehensive guidance on how to integrate and utilize Webhook functionality for real-time event-driven communication.
  2. Our platform is designed around the concept of event-driven communication. It allows your applications to subscribe to specific events and receive instant notifications when these events occur.
</Info>

### Please review the following requirements for setting up your webhook endpoint

<Info>
  1. Your webhook endpoint must be accessible over HTTPS. This is essential to ensure the security and integrity of data transmission.
  2. Provide us with the URL where you'd like to receive webhook payloads. Webhook payloads would be in JSON format. This URL should be publicly accessible from the internet.
  3. Ensure that your endpoint supports the HTTP POST method. Webhook payloads will be delivered via HTTP POST requests.
  4. Configure your endpoint to respond immediately to the CometChat server with a 200 OK response.
  5. We recommend you use Basic Auth while configuring webhook, so as to validate incoming webhook requests.
</Info>

Here is the list of properties associated with Webhook.

| Parameters   | Type    | Description                                                                                                                                                      |
| ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id           | string  | Unique identifier of the webhook. It can have a maximum of 50 characters.                                                                                        |
| name         | string  | Display name of the webhook. It can have a maximum of 50 characters.                                                                                             |
| webhookURL   | string  | The webhookURL field represents the target URL to which webhook events will be delivered.                                                                        |
| useBasicAuth | boolean | The useBasicAuth field is a boolean flag that indicates whether basic authentication should be applied when sending webhook requests to the specified webhookURL |
| username     | string  | This field should contain the username or identifier associated with the authentication credentials.                                                             |
| password     | string  | This field should contain the secret password that corresponds to the provided username.                                                                         |
| enabled      | boolean | The enabled field is a boolean flag that determines whether a webhook is currently active and capable of receiving and processing incoming events                |

## Constraints

| Item                     | Constraint                                       | Notes                                        |
| ------------------------ | ------------------------------------------------ | -------------------------------------------- |
| Maximum webhooks per app | 25                                               | Contact support if you need more             |
| Webhook URL              | 255 characters max                               | Must be a publicly accessible HTTPS endpoint |
| Webhook ID               | 50 characters, alphanumeric (UTF8mb4, no spaces) | Unique identifier for managing the webhook   |
| Authentication username  | 50 characters, alphanumeric (no spaces)          | Used for HTTP Basic Authentication           |
| Authentication password  | 100 characters, alphanumeric (no spaces)         | Keep secure; used to verify webhook requests |

### The list of triggers that are supported

| triggerId                                                           | Description                                                                                                      |
| ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| [`message_sent`](#message_sent)                                     | The hook triggers after the message is sent.                                                                     |
| [`message_edited`](#message_edited)                                 | The hook triggers after the message is edited.                                                                   |
| [`message_deleted`](#message_deleted)                               | The hook triggers after the message is deleted.                                                                  |
| [`message_reaction_added`](#message_reaction_added)                 | The hook triggers after reaction is added to a message.                                                          |
| [`message_reaction_removed`](#message_reaction_removed)             | The hook triggers after reaction is removed from a message.                                                      |
| [`user_blocked`](#user_blocked)                                     | The hook triggers when a user blocks another user.                                                               |
| [`user_unblocked`](#user_unblocked)                                 | The hook triggers when a user unblocks another user.                                                             |
| [`group_created`](#group_created)                                   | The hook triggers after the group is created.                                                                    |
| [`group_updated`](#group_updated)                                   | The hook triggers after the group is updated.                                                                    |
| [`group_deleted`](#group_deleted)                                   | The hook triggers after the group is deleted.                                                                    |
| [`group_member_joined`](#group_member_joined)                       | The hook triggers after a user joins a group.                                                                    |
| [`group_member_left`](#group_member_left)                           | The hook triggers after a user leaves the group.                                                                 |
| [`group_member_added`](#group_member_added)                         | The hook triggers after members are added to a group.                                                            |
| [`group_member_kicked`](#group_member_kicked)                       | The hook triggers after members are kicked from a group.                                                         |
| [`group_member_banned`](#group_member_banned)                       | The hook triggers after members are banned from a group.                                                         |
| [`group_member_unbanned`](#group_member_unbanned)                   | The hook triggers after members are unbanned from a group.                                                       |
| [`group_member_scope_changed`](#group_member_scope_changed)         | The hook triggers if the scope of a member changes in a group.                                                   |
| [`group_owner_transferred`](#group_owner_transferred)               | The hook triggers if the owner of the group is changed.                                                          |
| [`user_connection_status_changed`](#user_connection_status_changed) | The hook triggers after a user connects/disconnects from the websocket server.                                   |
| [`message_delivery_receipt`](#message_delivery_receipt)             | The hook triggers when the client chat application confirms with Cometchat servers that a message was delivered. |
| [`message_read_receipt`](#message_read_receipt)                     | The hook triggers when the client chat application confirms with Cometchat servers that a message was read.      |
| [`call_initiated`](#call_initiated)                                 | The hook triggers when the call is initiated.                                                                    |
| [`call_started`](#call_started)                                     | The hook triggers when the call is started.                                                                      |
| [`call_participant_joined`](#call_participant_joined)               | The hook triggers when a participant joins the call.                                                             |
| [`call_participant_left`](#call_participant_left)                   | The hook triggers when a participant leaves the call.                                                            |
| [`call_ended`](#call_ended)                                         | The hook triggers when the call is ended.                                                                        |
| [`meeting_started`](#meeting_started)                               | The hook triggers when a meeting is started.                                                                     |
| [`meeting_participant_joined`](#meeting_participant_joined)         | The hook triggers when a participant joins the meeting.                                                          |
| [`meeting_participant_left`](#meeting_participant_left)             | The hook triggers when a participant leaves the meeting.                                                         |
| [`meeting_ended`](#meeting_ended)                                   | The hook triggers when the meeting is ended.                                                                     |
| [`recording_generated`](#recording_generated)                       | The hook triggers when the recording is generated.                                                               |

### Payload structure of events

#### Groups

##### group\_created:

<CodeGroup>
  ```json group_created theme={null}
  {  
     "trigger":"group_created",  
     "data":{  
        "group":{  
           "guid":"cometchat-guid-1",  
           "name":"Hiking Group",  
           "type":"public",  
           "scope":"admin",  
           "membersCount":1,  
           "joinedAt":1696932915,  
           "conversationId":"group_cometchat-guid-1",  
           "hasJoined":true,  
           "createdAt":1696932915,  
           "owner":"cometchat-uid-1"  
        },  
        "members":{  
           "cometchat-uid-1":{  
              "uid":"cometchat-uid-1",  
              "name":"Andrew Joseph", 
              "status":"available",  
              "role":"default",  
              "lastActiveAt":1696932834  
           }  
        }  
     },  
     "appId":"<appId>",  
     "region":"<region>",  
     "webhook":"<webhookID>"  
  }
  ```
</CodeGroup>

##### group\_updated:

<CodeGroup>
  ```json group_updated theme={null}
  {
      "trigger": "group_updated",
      "data": {
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 2,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1695728507,
              "owner": "cometchat-uid-2",
              "updatedAt": 1696934048,
              "updatedBy": "cometchat-uid-1",
              "onlineMembersCount": 2
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_deleted:

<CodeGroup>
  ```json group_deleted theme={null}
  {
      "trigger": "group_deleted",
      "data": {
          "group": {
              "guid": "cometchat-guid-1",
              "name": "1234",
              "type": "public",
              "membersCount": 1,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1695722912,
              "owner": "cometchat-uid-1",
              "updatedAt": 1695817083,
              "updatedBy": "cometchat-uid-1",
              "onlineMembersCount": 1
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_owner\_transferred:

<CodeGroup>
  ```json group_owner_transferred theme={null}
  {
      "trigger": "group_owner_transferred",
      "data": {
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 2,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1695728507,
              "owner": "cometchat-uid-2",
              "updatedAt": 1696933737,
              "updatedBy": "cometchat-uid-1",
              "onlineMembersCount": 2,
              "oldOwner": "cometchat-uid-1"
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_member\_added:

<CodeGroup>
  ```json group_member_added theme={null}
  {
      "trigger": "group_member_added",
      "data": {
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 2,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1696932915,
              "owner": "cometchat-uid-1",
              "onlineMembersCount": 1
          },
          "members": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "avatar": "https://example.com/avatars/george-alan.png",
                  "status": "offline",
                  "role": "default",
                  "lastActiveAt": 1695751453,
                  "conversationId": "cometchat-uid-1_user_cometchat-uid-2"
              }
          },
          "by": {
              "uid": "cometchat-uid-1",
              "name": "Andrew Joseph",
              "avatar": "https://example.com/avatars/andrew-joseph.png",
              "status": "available",
              "role": "default",
              "lastActiveAt": 1696932834
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_member\_banned:

<CodeGroup>
  ```json group_member_banned theme={null}
  {
      "trigger": "group_member_banned",
      "data": {
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 1,
              "conversationId": "group_group__1696932914913",
              "createdAt": 1696932915,
              "owner": "cometchat-uid-1",
              "updatedAt": 1696933533,
              "onlineMembersCount": 1
          },
          "members": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "avatar": "https://example.com/avatars/george-alan.png",
                  "status": "offline",
                  "role": "default",
                  "lastActiveAt": 1695751453,
                  "conversationId": "cometchat-uid-1_user_cometchat-uid-2"
              }
          },
          "by": {
              "uid": "cometchat-uid-1",
              "name": "Andrew Joseph",
              "avatar": "https://example.com/avatars/andrew-joseph.png",
              "status": "available",
              "role": "default",
              "lastActiveAt": 1696932834
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_member\_unbanned:

<CodeGroup>
  ```json group_member_unbanned theme={null}
  {
      "trigger": "group_member_unbanned",
      "data": {
          "members": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "avatar": "https://example.com/avatars/george-alan.png",
                  "status": "offline",
                  "role": "default",
                  "lastActiveAt": 1695751453,
                  "conversationId": "cometchat-uid-1_user_cometchat-uid-2"
              }
          },
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 1,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1696932915,
              "owner": "cometchat-uid-1",
              "updatedAt": 1696933533,
              "onlineMembersCount": 1
          },
          "by": {
              "uid": "cometchat-uid-1",
              "name": "Andrew Joseph",
              "avatar": "https://example.com/avatars/andrew-joseph.png",
              "status": "available",
              "role": "default",
              "lastActiveAt": 1696932834
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_member\_joined:

<CodeGroup>
  ```json group_member_joined theme={null}
  {
      "trigger": "group_member_joined",
      "data": {
          "members": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "avatar": "https://example.com/avatars/george-alan.png",
                  "status": "available",
                  "role": "default",
                  "lastActiveAt": 1696933689
              }
          },
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 2,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1695728507,
              "owner": "cometchat-uid-1",
              "updatedAt": 1696933691,
              "onlineMembersCount": 1
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_member\_left:

<CodeGroup>
  ```json group_member_left theme={null}
  {
      "trigger": "group_member_left",
      "data": {
          "members": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "avatar": "https://example.com/avatars/george-alan.png",
                  "status": "available",
                  "role": "default",
                  "lastActiveAt": 1696933689
              }
          },
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 1,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1695722891,
              "owner": "cometchat-uid-1",
              "updatedAt": 1696933827,
              "onlineMembersCount": 1
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_member\_scope\_changed:

<CodeGroup>
  ```json group_member_scope_changed theme={null}
  {
      "trigger": "group_member_scope_changed",
      "data": {
          "members": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "avatar": "https://example.com/avatars/george-alan.png",
                  "status": "available",
                  "role": "default",
                  "lastActiveAt": 1696933928,
                  "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
                  "scope": "admin",
                  "oldScope": "participant"
              }
          },
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 2,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1695722891,
              "owner": "cometchat-uid-1",
              "updatedAt": 1696933925,
              "onlineMembersCount": 2
          },
          "by": {
              "uid": "cometchat-uid-1",
              "name": "Andrew Joseph",
              "avatar": "https://example.com/avatars/andrew-joseph.png",
              "status": "available",
              "role": "default",
              "lastActiveAt": 1696933934
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### group\_member\_kicked:

<CodeGroup>
  ```json group_member_kicked theme={null}
  {
      "trigger": "group_member_kicked",
      "data": {
          "members": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "avatar": "https://example.com/avatars/george-alan.png",
                  "status": "available",
                  "role": "default",
                  "lastActiveAt": 1696933689,
                  "conversationId": "cometchat-uid-1_user_cometchat-uid-2"
              }
          },
          "group": {
              "guid": "cometchat-guid-1",
              "name": "Hiking Group",
              "type": "public",
              "membersCount": 1,
              "conversationId": "group_cometchat-guid-1",
              "createdAt": 1695722891,
              "owner": "cometchat-uid-1",
              "updatedAt": 1696933889,
              "onlineMembersCount": 8
          },
          "by": {
              "uid": "cometchat-uid-1",
              "name": "Andrew Joseph",
              "avatar": "https://example.com/avatars/andrew-joseph.png",
              "status": "available",
              "role": "default",
              "lastActiveAt": 1696933881
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

#### Messages

##### message\_sent:

<CodeGroup>
  ```json message_sent theme={null}
  {
      "trigger": "message_sent",
      "data": {
          "message": {
              "id": "1",
              "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
              "sender": "cometchat-uid-1",
              "receiverType": "user",
              "receiver": "cometchat-uid-2",
              "category": "message",
              "type": "text",
              "data": {
                  "text": "hi",
                  "entities": {
                      "sender": {
                          "entity": {
                              "uid": "cometchat-uid-1",
                              "name": "Andrew Joseph",
                              "avatar": "https://example.com/avatars/andrew-joseph.png",
                              "status": "available",
                              "role": "default",
                              "lastActiveAt": 1696934440
                          },
                          "entityType": "user"
                      },
                      "receiver": {
                          "entity": {
                              "uid": "cometchat-uid-2",
                              "name": "George Alan",
                              "avatar": "https://example.com/avatars/george-alan.png",
                              "status": "available",
                              "role": "default",
                              "lastActiveAt": 1696934491,
                              "conversationId": "cometchat-uid-1_user_cometchat-uid-2"
                          },
                          "entityType": "user"
                      }
                  }
              },
              "sentAt": 1696934912,
              "updatedAt": 1696934912
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### message\_edited:

<CodeGroup>
  ```json message_edited theme={null}
  {
      "trigger": "message_edited",
      "data": {
          "message": {
              "id": "2",
              "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
              "sender": "cometchat-uid-1",
              "receiverType": "user",
              "receiver": "cometchat-uid-2",
              "category": "action",
              "type": "message",
              "data": {
                  "action": "edited",
                  "entities": {
                      "by": {
                          "entity": {
                              "uid": "cometchat-uid-1",
                              "name": "Andrew Joseph",
                              "avatar": "https://example.com/avatars/andrew-joseph.png",
                              "status": "available",
                              "role": "default",
                              "lastActiveAt": 1696934440
                          },
                          "entityType": "user"
                      },
                      "on": {
                          "entity": {
                              "id": "1",
                              "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
                              "sender": "cometchat-uid-1",
                              "receiverType": "user",
                              "receiver": "cometchat-uid-2",
                              "category": "message",
                              "type": "text",
                              "data": {
                                  "text": "hello"
                              },
                              "sentAt": 1696934912,
                              "editedAt": 1696934985,
                              "editedBy": "cometchat-uid-1"
                          },
                          "entityType": "message"
                      }
                  }
              },
              "sentAt": 1696934985,
              "updatedAt": 1696934985
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### message\_deleted:

<CodeGroup>
  ```json message_deleted theme={null}
  {
      "trigger": "message_deleted",
      "data": {
          "message": {
              "id": "3",
              "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
              "sender": "cometchat-uid-1",
              "receiverType": "user",
              "receiver": "cometchat-uid-2",
              "category": "action",
              "type": "message",
              "data": {
                  "action": "deleted",
                  "entities": {
                      "by": {
                          "entity": {
                              "uid": "cometchat-uid-1",
                              "name": "Andrew Joseph"
                          },
                          "entityType": "user"
                      },
                      "on": {
                          "entity": {
                              "id": "2",
                              "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
                              "deletedAt": 1696935005,
                              "deletedBy": "cometchat-uid-1"
                          },
                          "entityType": "message"
                      }
                  }
              },
              "sentAt": 1696935005,
              "updatedAt": 1696935005
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### message\_delivery\_receipt:

<CodeGroup>
  ```json message_delivery_receipt theme={null}
  {
      "trigger": "message_delivery_receipt",
      "data": {
          "receiver": "cometchat-uid-1",
          "receiverType": "user",
          "type": "receipts",
          "sender": "cometchat-uid-2",
          "messageSender": "cometchat-uid-1",
          "body": {
              "action": "delivered",
              "messageId": "57",
              "user": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "status": "online"
              },
              "timestamp": 1696934912
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### message\_read\_receipt:

<CodeGroup>
  ```json message_read_receipt theme={null}
  {
      "trigger": "message_read_receipt",
      "data": {
          "receiver": "cometchat-uid-1",
          "receiverType": "user",
          "type": "receipts",
          "sender": "cometchat-uid-2",
          "messageSender": "cometchat-uid-1",
          "body": {
              "action": "read",
              "messageId": "57",
              "user": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan",
                  "status": "online"
              },
              "timestamp": 1696934950
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### message\_reaction\_added:

<CodeGroup>
  ```json message_reaction_added theme={null}
  {
      "trigger": "message_reaction_added",
      "data": {
          "reaction": {
              "id": "<reactionId>",
              "messageId": "<messageId>",
              "reaction": "🏒",
              "uid": "cometchat-uid-1",
              "reactedAt": 1700655536,
              "reactedBy": {
                  "uid": "cometchat-uid-1",
                  "name": "Andrew Joseph"
              }
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### message\_reaction\_removed:

<CodeGroup>
  ```json message_reaction_removed theme={null}
  {
      "trigger": "message_reaction_removed",
      "data": {
          "reaction": {
              "id": "<reactionId>",
              "messageId": "<messageId>",
              "reaction": "🏒",
              "uid": "cometchat-uid-1",
              "reactedAt": 1700231289,
              "reactedBy": {
                  "uid": "cometchat-uid-1",
                  "name": "Andrew Joseph"
              }
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

#### Users

##### user\_connection\_status\_changed:

<CodeGroup>
  ```json user_connection_status_changed theme={null}
  {
      "trigger": "user_connection_status_changed",
      "data": {
          "timestamp": 1696935103114,
          "user": {
              "uid": "cometchat-uid-1",
              "name": "Andrew Joseph",
              "status": "offline",
              "role": "default"
          },
          "status": "offline",
          "currentConnection": {
              "action": "disconnected",
              "platform": "javascript",
              "connectedAt": 1696934440982
          },
          "userPresenceChanged": true
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### user\_blocked:

<CodeGroup>
  ```json user_blocked theme={null}
  {
      "trigger": "user_blocked",
      "data": {
          "users": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan"
              }
          },
          "by": {
              "uid": "cometchat-uid-1",
              "name": "Andrew Joseph"
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### user\_unblocked:

<CodeGroup>
  ```json user_unblocked theme={null}
  {
      "trigger": "user_unblocked",
      "data": {
          "users": {
              "cometchat-uid-2": {
                  "uid": "cometchat-uid-2",
                  "name": "George Alan"
              }
          },
          "by": {
              "uid": "cometchat-uid-1",
              "name": "Andrew Joseph"
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### user\_mentioned:

<CodeGroup>
  ```json user_mentioned theme={null}
  {
      "trigger": "user_mentioned",
      "data": {
          "message": {
              "id": "4",
              "conversationId": "cometchat-uid-1_user_cometchat-uid-2",
              "sender": "cometchat-uid-1",
              "receiverType": "user",
              "receiver": "cometchat-uid-2",
              "category": "message",
              "type": "text",
              "data": {
                  "text": "Hi <@uid:cometchat-uid-2>",
                  "mentions": {
                      "cometchat-uid-2": {
                          "uid": "cometchat-uid-2",
                          "name": "Andrew Joseph"
                      }
                  }
              },
              "sentAt": 1702028666,
              "updatedAt": 1702028666
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

#### Calls & Meetings

##### call\_initiated:

<CodeGroup>
  ```json call_initiated theme={null}
  {
      "trigger": "call_initiated",
      "data": {
          "call": {
              "id": "52",
              "conversationId": "cometchat-uid-1_user_cometchat-uid-5",
              "sender": "cometchat-uid-1",
              "receiverType": "user",
              "receiver": "cometchat-uid-5",
              "category": "call",
              "type": "audio",
              "data": {
                  "action": "initiated"
              },
              "sentAt": 1696934199,
              "updatedAt": 1696934199
          }
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### call\_started:

<CodeGroup>
  ```json call_started theme={null}
  {
      "trigger": "call_started",
      "data": {
          "created_at": 1696934572,
          "sessionId": "<sessionId>"
      },
      "type": "call",
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### call\_ended:

<CodeGroup>
  ```json call_ended theme={null}
  {
      "trigger": "call_ended",
      "data": {
          "all_occupants": [
              {
                  "joined_at": 1696934501,
                  "audio_call": "true",
                  "left_at": 1696934553,
                  "name": "George Alan"
              },
              {
                  "joined_at": 1696934501,
                  "audio_call": "true",
                  "left_at": 1696934551,
                  "name": "Andrew Joseph"
              }
          ],
          "destroyed_at": 1696934553,
          "created_at": 1696934501,
          "sessionId": "<sessionId>"
      },
      "type": "call",
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### call\_participant\_joined:

<CodeGroup>
  ```json call_participant_joined theme={null}
  {
      "trigger": "call_participant_joined",
      "data": {
          "occupant": {
              "joined_at": 1696934573,
              "audio_call": "true",
              "name": "Andrew Joseph"
          },
          "sessionId": "<sessionId>"
      },
      "type": "call",
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### call\_participant\_left:

<CodeGroup>
  ```json call_participant_left theme={null}
  {
      "trigger": "call_participant_left",
      "data": {
          "occupant": {
              "joined_at": 1696934501,
              "audio_call": "true",
              "left_at": 1696934553,
              "name": "George Alan"
          },
          "sessionId": "<sessionId>"
      },
      "type": "call",
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### meeting\_started:

<CodeGroup>
  ```json meeting_started theme={null}
  {
      "trigger": "meeting_started",
      "data": {
          "created_at": 1696934692,
          "sessionId": "<sessionId>"
      },
      "type": "meet",
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### meeting\_participant\_joined:

<CodeGroup>
  ```json meeting_participant_joined theme={null}
  {
      "trigger": "meeting_participant_joined",
      "data": {
          "occupant": {
              "joined_at": 1696934692,
              "audio_call": "false",
              "name": "Andrew Joseph"
          },
          "sessionId": "<sessionId>"
      },
      "type": "meet",
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### meeting\_participant\_left:

<CodeGroup>
  ```json meeting_participant_left theme={null}
  {
      "trigger": "meeting_participant_left",
      "data": {
          "occupant": {
              "joined_at": 1696934692,
              "audio_call": "false",
              "left_at": 1696934730,
              "name": "Andrew Joseph"
          },
          "sessionId": "<sessionId>"
      },
      "type": "meet",
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### meeting\_ended:

<CodeGroup>
  ```json meeting_ended theme={null}
  {
      "trigger": "meeting_ended",
      "data": {
          "all_occupants": [
              {
                  "joined_at": 1696934692,
                  "audio_call": "false",
                  "left_at": 1696934730,
                  "name": "Andrew Joseph"
              }
          ],
          "destroyed_at": 1696934730,
          "created_at": 1696934692,
          "sessionId": "<sessionId>"
      },
      "type": "meet",
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>

##### recording\_generated:

<CodeGroup>
  ```json recording_generated theme={null}
  {
      "trigger": "recording_generated",
      "data": {
          "recordingDate": "2023-10-10",
          "duration": "21.433000",
          "startTime": "1696937627",
          "sessionId": "<sessionId>",
          "recording_url": "<recording_url>"
      },
      "appId": "<appId>",
      "region": "<region>",
      "webhook": "<webhookID>"
  }
  ```
</CodeGroup>
