Participant.Joined
The Participant.Joined event is sent when a new participant joined the conference.
{
"eventType": "Participant.Joined",
"thirdPartyId": "example_thirdpartyId",
"conference": {
"confId": "conferenceId_UUID",
"confAlias": "example_conference_alias"
},
"region": "eu",
"participant": {
"userId": "userId_UUID",
"externalId": "example_externalId",
"externalName": "example_externalName",
"externalPhotoUrl": "example_externalPhotoUrl"
}
}
The following table explains all fields of the webhook object:
Field name | Object | Type | Meaning | Example |
---|---|---|---|---|
eventType | Root | String | The type of the webhook event. | Participant.Joined |
thirdPartyId | Root | String | The app key. If you implemented a common webhook listener for multiple applications, this can help you to distinguish which application is this webhook event for. | XSTXp4EsAmMrcw4g== |
conference.confId | Root | String in UUID format | The identifier of the conference. | a88484c6-2a47-4691-86e2-933eec80b316 |
conference. confAlias | Root | String | The alias of the conference. | virtual event 1 |
region | Root | String | The conference creation region. The possible values are: ca : Canada, us : United States, eu : Europe, in : India, au : Australia | eu |
participant. userId | Participant | String | The participant ID generated by Dolby. | 00000000-0000-0000-0000-000000000000 |
participant. externalId | Participant | String | The external ID of the participant. | [email protected] |
participant. externalName | Participant | String | The external name of the participant. | Jane Smith |
participant. externalPhotoUrl | Participant | String | The participant's avatar URL. | - |
Close
Restore Version
Updated 2 months ago