API
We've released two updates to Real-Time Scheduling that give you more control over the calendar events it can create on your behalf.
- events can now have conferencing settings overridden based on who is selected as the organizer of the event
- events can have attendees automatically added when they are selected for the time slot as a result of the Availability Query you specify
There's a full example that makes use of both new features over on our docs site. For more details, read on.
These features build on top of single event creation mode and are both an addition to the target_calendars
parameter.
In this mode, the Real-Time Scheduling link will create a single event in an organizer's calendar as the result of the end-user selecting a time. The organizer is chosen based on the Availability Query you provide. The Availability Query may specify that multiple members of a group of potential participants must be available at the same time for a slot to be valid. For example, an interview that requires three members out of a larger pool of potential interviewers.
Specifying the organizer's conferencing profile
target_calendars.event
(docs) controls event overrides when a given user is selected as the event organizer.
{
...
"target_calendars": [
{
"sub": "acc_5e591ae2815c14f86ea55caf",
"calendar_id": "cal_Xlka34FcFPhupVxZ_K@fbCQqIXfoVEHSVR06mpg",
"event": {
"conferencing": {
"profile_id": "pro_YABpIfWqk4wjcW5t"
}
}
}
...
}
Here, a specific conferencing profile belonging to the account is provided. When the event is placed in their calendar, this will override any conferencing set on the top level event template.
This allows you to provide end-users with discrete control over their preferred conferencing mechanism, for events booked in their calendar.
Adding attendees from the Availability Query
target_calendars.attendee
(docs) controls how the other participants in the Availability Query are added to the final event. They'll only be added if they are available at the selected time, and only as many as are required.
{
...
"availability": {
"participants": [
{
"members": [
{
"sub": "acc_5e591ae2815c14f86ea55caf"
}, ...
],
"required": 3
}
...
"target_calendars": [
{
"sub": "acc_5e591ae2815c14f86ea55caf",
"calendar_id": "cal_Xlka34FcFPhupVxZ_K@fbCQqIXfoVEHSVR06mpg",
"attendee": {
"email": "marty@evenitron.com",
"display_name": "Marty McFly"
}
}, ...
],
...
}
In the scenario where three members of a pool must be available at the same time:
- the first will have the event placed in their calendar
- the other two can now automatically be invited as an attendee, should they be specified here