Subscribe to Google Meet events

This page describes the Google Meet events that your app can subscribe to using the Google Workspace Events API.

To learn more about developing apps for Google Meet, see the Google Meet REST API overview.

Supported Meet target resources

To receive Meet events, the Google Workspace Events API supports subscriptions to the following resources:

  • Meeting spaces, represented as space resources.
  • Users, represented as Cloud Identity API user resources.

Supported Meet events

Google Workspace subscriptions let you receive events about the following types of changes in Meet:

When you create a subscription to a Meet resource, you use the eventTypes[] field to specify which types of events you want to receive. Event types are formatted according to the CloudEvents specification, such as google.workspace.APPLICATION.RESOURCE.VERSION.ACTION. For example, to receive events about new participants in a conference for a Meet space, you specify the event type as google.workspace.meet.participant.v2.joined. To learn more about how events work, see Structure of Google Workspace events.

The following table displays the supported event types, a description, and the changed Meet resource that's represented in the event data:

Event type Description Meet resource

google.workspace.meet.conference.v2.started

A conference starts in the meeting space.

conferenceRecord

google.workspace.meet.conference.v2.ended

A conference ends in the meeting space.

conferenceRecord

google.workspace.meet.participant.v2.joined

A participant joins an active conference in the meeting space.

conferenceRecord.participantSession

google.workspace.meet.participant.v2.left

A participant leaves an active conference in the meeting space.

conferenceRecord.participantSession

google.workspace.meet.recording.v2.fileGenerated

A recording file is generated for a conference in the meeting space.

conferenceRecord.recording

google.workspace.meet.transcript.v2.fileGenerated

A transcript file is generated for a conference in the meeting space.

conferenceRecord.transcript

Event data

This section describes event data and example payloads for events in Meet meeting spaces.

When your Google Workspace subscription receives an event from Meet, the data field contains the payload for the event. This payload has information about the Google Workspace resource that changed. For example, if you've subscribed to events about new transcripts in a space, the payload for these events contains information about the transcript resource that changed.

Resource data in the event payload

The following table provides examples of JSON payloads for a subscription to a Meet meeting space. The examples use the conference conferenceRecords/AAA-BBB-CCC-DDD-EEE that takes place in the space. For each event that the subscription receives, the payload appears in the data field of the event:

Example Event type JSON payload

A conference starts for the Meet meeting space.

google.workspace.meet.conference.v2.started

Excludes resource data
{
    "conferenceRecord":
    {
        "name": "conferenceRecords/AAA-BBB-CCC-DDD-EEE"
    }
}
      
A participant joins a conference in the Meet meeting space.

google.workspace.meet.participant.v2.joined

Excludes resource data
{
    "participantSession":
    {
        "name": "conferenceRecords/AAA-BBB-CCC-DDD-EEE/participants/FFF-GGG-HHH-III-JJJ/participantSessions/LLL-MMM-NNN-OOO-PPP"
    }
}
      
A recording is generated for a conference in the Meet meeting space. google.workspace.meet.recording.v2.fileGenerated
Excludes resource data
{
    "recording":
    {
        "name": "conferenceRecords/AAA-BBB-CCC-DDD-EEE/recordings/LLL-MMM-NNN-OOO-PPP"
    }
}
      
A transcript is generated for a conference in the Meet meeting space. google.workspace.meet.transcript.v2.fileGenerated
Excludes resource data
{
    "transcript":
    {
        "name": "conferenceRecords/AAA-BBB-CCC-DDD-EEE/transcripts/PPP-QQQ-RRR-SSS-TTT"
    }
}