Add conferencing to Events using Nylas API v2
Read conferencing details from the events endpoint across both Google and Exchange with our conferencing field. Get full CRUD access to Google’s conferenceData field using the Nylas conferencing field.
Supported Providers
CRUD for conferencing supported for Google GCal and GSuite. Microsoft Exchange and is READ-ONLY.
Create a Conference Event
To create a conference event for Google, add the conferencing object to /events. For this example, we will use Zoom.
Review the Events endpoint to see an example of other providers.
Zoom Meeting
- provider - Must be entered as Zoom Meeting
- details - Object that contains the meeting information.
- url - Zoom URL of the meeting.
- meeting_code - Zoom meeting code.
- password - Zoom meeting password.
- phone - Zoom meeting phone number. The country code must be included.
Create Conference Event Request
curl --location --request POST 'https://api.nylas.com/events' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "Birthday Party",
"location": "Roller Rink",
"calendar_id": "9ev16mzqlwux5vrxai6s2t4uf",
"status": "confirmed",
"busy": true,
"read_only": false,
"participants": [
{
"name": "Dorothy Vaughan",
"email": "[email protected]"
},
{
"name": "Katherine Johnson",
"email": "[email protected]"
},
{
"name": "Hedy Lamarr",
"email": "[email protected]"
}
],
"description": "Lets celebrate",
"when": {
"start_time": "1608241500",
"end_time": "1608245100"
},
"conferencing": {
"provider": "Zoom Meeting",
"details": {
"url": "https://us02web.zoom.us/j/****************",
"meeting_code": "213",
"password": "xyz",
"phone": [
"+11234567890"
]
}
}
}' Create Conference Event Response
The response includes the conferencing details object. The details can vary by provider.
{
"account_id": "5tgncdmczat02216u7d6uypyi",
"busy": true,
"calendar_id": "9ev16mzqlwux5vrxai6s2t4uf",
"conferencing": {
"details": {
"meeting_code": "213",
"password": "xyz",
"phone": [
"+11234567890"
],
"url": "https://us02web.zoom.us/j/****************"
},
"provider": "Zoom Meeting"
},
"description": "Let's celebrate",
"ical_uid": null,
"id": "b54acjszoyhsxljnfr3lnhm2y",
"job_status_id": "73p1s2umn46ym77krav0qm8cx",
"location": "Roller Rink",
"message_id": null,
"object": "event",
"owner": "Jane Doe <[email protected]>",
"participants": [
{
"comment": null,
"name": "Hedy Lamarr",
"email": "[email protected]",
"status": "noreply"
}
],
"read_only": false,
"status": "confirmed",
"title": "Birthday Party",
"when": {
"end_time": 1608245100,
"object": "timespan",
"start_time": 1608241500
}
} Get Conference Event Data
Nylas will attempt to pull conference data from the conferenceData field on Google Calendar or from location/description on Exchange into the conferencing object in Nylas.
To view conference details object use the GET /events or GET /events/{event_id}.
You can view conference data for the following providers:
- WebEx
- GoToMeeting
- Zoom
- Google Meet
Conference Event Data Request
curl --location --request GET 'https://api.nylas.com/events' \
--header 'Authorization: Bearer <access_token>' \ Conference Event Data Response
Zoom Conference Details
The following is an example of the response when conference details are available.
[{
"account_id": "5tgncdmczat02216u7d6uypyi",
"busy": true,
"calendar_id": "cdv2pa13ogzd7x1fgb6bk0uy0",
"conferencing": {
"details": {
"meeting_code": "123 456 7890",
"phone": [
"+12345678901",
"+12532158782"
],
"url": "https://us02web.zoom.us/j/5668774452"
},
"provider": "Zoom Meeting"
},
"description": "\n──────────\nAda Lovelace is inviting you to a scheduled Zoom meeting.\n\nJoin Zoom Meeting\nhttps://us02web.zoom.us/j/**********\n\nMeeting ID: 123 456 7890\nOne tap mobile\n+1234567890,,**********# US (San Jose)\n+1234567890,,**********# US (Tacoma)\n\nDial by your location\n +1 123 456 7890 US (San Jose)\n +1 123 456 7890 US (Tacoma)\n +1 123 456 7890 US (Houston)\n +1 123 456 7890 US (Germantown)\n +1 123 456 7890US (Chicago)\n +1 123 456 7890 US (New York)\nMeeting ID: 123 456 7890\nFind your local number: https://us02web.zoom.us/u/*******\n\n\n──────────\n\n-::~:~::~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~::~:~::-\nPlease do not edit this section of the description.\n\nView your event at https://calendar.google.com/calendar/event?action=VIEW&eid=********&tok=******&ctz=America%2FChicago&hl=en&es=1.\n-::~:~::~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~::~:~::-",
"ical_uid": "***********@google.com",
"id": "4wa541hgeph6vje9mzzf5wrru",
"location": "https://us02web.zoom.us/j/**********",
"message_id": "3etfeskt26j5oqdt5w1ordafz",
"object": "event",
"owner": "Ada Lovelace <[email protected]>",
"participants": [
{
"comment": null,
"email": "[email protected]",
"name": "[email protected]",
"status": "noreply"
},
{
"comment": null,
"email": "[email protected]",
"name": "[email protected]",
"status": "yes"
}
],
"read_only": true,
"recurrence": {
"rrule": [
"RRULE:FREQ=WEEKLY;BYDAY=WE"
],
"timezone": "America/Los_Angeles"
},
"status": "confirmed",
"title": "Weekly 1:1",
"when": {
"end_time": 1608150600,
"object": "timespan",
"start_time": 1608148800
}
}] Zoom Event Data
The following is an example of when conference details are not available. The information is still available as part of the location and description.
- location - Typically includes the video URL.
- description - Full event details
[{
"account_id": "5tgncdmczat02216u7d6uypyi",
"busy": true,
"calendar_id": "cdv2pa13ogzd7x1fgb6bk0uy0",
"description": "\n──────────\nAda Lovelace is inviting you to a scheduled Zoom meeting.\n\nJoin Zoom Meeting\nhttps://us02web.zoom.us/j/**********\n\nMeeting ID: 123 456 7890\nOne tap mobile\n+1234567890,,**********# US (San Jose)\n+1234567890,,**********# US (Tacoma)\n\nDial by your location\n +1 123 456 7890 US (San Jose)\n +1 123 456 7890 US (Tacoma)\n +1 123 456 7890 US (Houston)\n +1 123 456 7890 US (Germantown)\n +1 123 456 7890US (Chicago)\n +1 123 456 7890 US (New York)\nMeeting ID: 123 456 7890\nFind your local number: https://us02web.zoom.us/u/*******\n\n\n──────────\n\n-::~:~::~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~::~:~::-\nPlease do not edit this section of the description.\n\nView your event at https://calendar.google.com/calendar/event?action=VIEW&eid=********&tok=******&ctz=America%2FChicago&hl=en&es=1.\n-::~:~::~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~:~::~:~::-",
"ical_uid": "***********@google.com",
"id": "4wa541hgeph6vje9mzzf5wrru",
"location": "https://us02web.zoom.us/j/**********",
"message_id": "3etfeskt26j5oqdt5w1ordafz",
"object": "event",
"owner": "Ada Lovelace <[email protected]>",
"participants": [
{
"comment": null,
"email": "[email protected]",
"name": "[email protected]",
"status": "noreply"
},
{
"comment": null,
"email": "[email protected]",
"name": "[email protected]",
"status": "yes"
}
],
"read_only": true,
"recurrence": {
"rrule": [
"RRULE:FREQ=WEEKLY;BYDAY=WE"
],
"timezone": "America/Los_Angeles"
},
"status": "confirmed",
"title": "Weekly 1:1",
"when": {
"end_time": 1608150600,
"object": "timespan",
"start_time": 1608148800
}
}] Supported Conference Providers
We can access conference data for the following providers and fields:
| Provider | Fields |
|---|---|
| Zoom Meeting | meeting_code, password, url |
| Google Meet | phone, pin, url |
| Microsoft Teams | url |
| WebEx | password, pin, url |
| GoToMeeting | meeting_code, phone, url |
Keep in Mind
- When fetching events, you might not get the conferencing object returned. Nylas will make an attempt to get the conferencing details when available.
- CRUD is supported for Google only.
- There is no SDK support.