Meeting

Before you start

To receive these events, you need to have a webhook event receiver preconfigured. You also need to understand the basic structure of the events accompanying the message object. If you haven't done this yet, please refer to the Webhooks section to learn how to do it.

Events

MEETING_STATS

This event is triggered when a meeting ends and statistics are available.

Description of message object

The object message contains an array of meeting statistics. Each item in the array has the following properties:

Property	Type	Description
uuid	string	Unique identifier for the meeting stats entry.
meetingId	string	Identifier for the meeting.
groupId	string	Identifier for the group associated with the meeting.
userId	string	Identifier for the user who started the meeting.
startedAt	string	ISO 8601 timestamp of when the meeting started.
endedAt	string	ISO 8601 timestamp of when the meeting ended.
meetingMinutes	number	Duration of the meeting in minutes.
recordingMinutes	number	Duration of any recordings made during the meeting.
price	number	Cost associated with the meeting.
participants	array	List of participants who joined the meeting.
createdBy	string	Identifier of the user who created the meeting.

Each participant object in the participants array contains:

Property	Type	Description
uuid	string	Unique identifier for the participant.
name	string	Name of the participant.
userId	string	User identifier of the participant.
permission	string	Permission level of the participant.
meetingStatsId	string	Identifier linking the participant to the meeting stats.
createdAt	string	ISO 8601 timestamp of when the participant joined.

Payload example

The following is an example of the payload sent when a meeting ends and stats are available:

{
    "id": "f3a92b7c-8d61-4e77-a639-45d2c9f8e012",
    "type": "MEETING_STATS",
    "apiKey": "ab12cd34ef56gh78ij90kl12mn34op56",
    "environment": "production",
    "timestamp": "2024-03-15T14:30:22.789Z",
    "message": [
        {
            "uuid": "9876dcba-5432-4321-abcd-ef0123456789",
            "meetingId": "weekly-standup-2024-03-15",
            "groupId": "dev-team-alpha",
            "userId": "user-789012",
            "startedAt": "2024-03-15T14:00:00.000Z",
            "endedAt": "2024-03-15T14:30:00.000Z",
            "meetingMinutes": 30,
            "recordingMinutes": 28,
            "price": 58,
            "participants": [
                {
                    "uuid": "abcd1234-5678-90ef-ghij-klmnopqrstuv",
                    "name": "Alice Johnson",
                    "userId": "alice.j",
                    "permission": "host",
                    "meetingStatsId": "9876dcba-5432-4321-abcd-ef0123456789",
                    "createdAt": "2024-03-15T13:59:45.123Z"
                },
                {
                    "uuid": "wxyz9876-5432-1098-7654-abcdefghijkl",
                    "name": "Bob Smith",
                    "userId": "bob.s",
                    "permission": "participant",
                    "meetingStatsId": "9876dcba-5432-4321-abcd-ef0123456789",
                    "createdAt": "2024-03-15T14:00:05.456Z"
                },
                {
                    "uuid": "mnop5678-9012-3456-7890-qrstuvwxyzab",
                    "name": "Charlie Brown",
                    "userId": "charlie.b",
                    "permission": "participant",
                    "meetingStatsId": "9876dcba-5432-4321-abcd-ef0123456789",
                    "createdAt": "2024-03-15T14:00:12.789Z"
                }
            ],
            "createdBy": "user-789012"
        }
    ]
}