Meeting Participants Webhook

[Rudrakshi]

Query from Mark Shead@xeric.net in #webex4devs space:

We have been using the REST APIs to pull attendance from WebEx Meeting events into a CRM system, but I've been wondering if we could get the information we need from a Web Hook pushing data to our server in real time instead. When a participant joins a meeting, they may or may not have a WebEx account and we need to get their Display Name and Email that they type when they join.

Is there anyway to get their Email from a webhook in addition to their Display Name?

[Rudrakshi]

We do have webhook to get details of Meeting Participants who has joined. Please find it here in the list of resources as meetingParticipants and event as joined: Create a Webhook .

The data payload received via Webhook will have below content:

"data": {
  "id": "XXXX_I_XXXX",
  "orgId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "displayName": "NAME OF THE PERSON JOINED",
  "state": "joined",
  "siteUrl": "sitename.webex.com",
  "meetingId": "XXXXXX_I_XXXX",
  "hostEmail": "host_email@gmail.com",
  "devices": [
    {
      "correlationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "deviceType": "XXX_OS_WIN32",
      "joinedTime": "2022-04-01T04:33:37Z",
      "leftTime": null
    }
  ],
  "hostPersonId": "HOST_PERSON_ID",
  "personId": "PERSON_ID"
}

Hope this will help!

[mark.shead]

RIght, that will show the DisplayName that they entered when joining, but not their email.

.Users who are joining without a WebEx account don't get a personId either, so it isn't apparent to me how I could use information in the hook to look up their email address either.

Is there any way to get their Email from a webhook in addition to their Display Name?

[philbell]

Hi Mark-

Referencing Rudrakshi's JSON response example, the "id" value in that webhook payload is the 'Participant Id'. You can use that Participant Id value to GET the details of a meeting participant, which will include the email address of the person that joined in the response.

I hope this helps!

Phil Bellanti

[mark.shead]

Thank you so much! That is helpful. 

It looks like if I want to get the display name and the email, I'll have to take every incoming request from the webhook and make a call back to the REST API. That feels like it kind of destroys a bit of the benefit of having the webhook. Is there any possibility of getting the email address as part of the data in the webhook or is that left out intentionally?

[philbell]

You're welcome - happy to help! 

Yes, once your app receives that webhook event, another API call is needed to GET the participant details. Data that is encrypted in Webex, such as display name, email and other personal identifiable information, is intentionally left out of the webhook payload for security reasons. This follows along the same specs as other Webex webhook events. 

[mark.shead]

---

@philbell wrote:

display name, email and other personal identifiable information, is intentionally left out of the webhook payload for security reasons. This follows along the same specs as other Webex webhook events. 

---

I can see how that makes sense, but are we talking about the same webhook? DisplayName actually is included in the webhook along with the host email address. It is just the participant email that is missing. Are those other fields shown in error?

[Jeff Marshall]

hostEmail is included because that may be required to correctly query /meetingParticipants to get a participant's full details depending on the roles of the user making the request. For example, if the user making the request is a full admin and the meeting was hosted by a different host then the hostEmail would be required. If the user making the API request is a compliance officer then the hostEmail wouldn't be required. displayName can be used to confirm you pulled the correct participant details to get their email.

[mark.shead]

Jeff - I understand that part, but Phil said that DisplayName was *not* included for security reasons, but it is there. Can I rely on it continuing to be part of the webhook or is it expected to be removed?

[Jeff Marshall]

Spoke with engineering about this and they are actually reevaluating the displayName being part of the webhook payload due to possible PII exposure. They said there is currently no plan to remove it but that could change in the future and recommended not relying on it always being included in the webhook payload but rather to pull the participant details to get it.

[philbell]

Hi Mark-

That was a mistake on my part -as Rudrakshi's example shows, the joined event webhook does indeed contain the display name. Apologies for the confusion. 

Regards-

Phil Bellanti