Availability Query Sync Statuses

The latest addition to the API helps you make scheduling decisions with greater confidence.

We now support returning a summary of participants' synchronization statuses when you are making an Availability Query.

This allows you to handle cases where stale or incomplete data (caused by authorization issues or calendar provider downtime, for example) means we can't guarantee the query has been done using a completely up-to-date view of participants' calendars.

Opt-in to this by setting the new include_member_statuses flag to true on the request:

POST /v1/availability HTTP/1.1
Host: api.cronofy.com
Authorization: Bearer {API_KEY}
Content-Type: application/json; charset=utf-8

{
  ...your availability query...
  "include_member_statuses": true
}

And you'll get the new member_statuses field in the Availability Query response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  ...availability query results...
  "member_statuses": [
    {
      "sub": "acc_678347111010113",
      "sync_status": "active"
    },
    {
      "sub": "acc_545665722612031",
      "sync_status": "pending"
    },
    {
      "sub": "acc_126865445645615",
      "sync_status": "disconnected"
    }
  ]
}

As a reminder, this information is already available in a more granular form by querying accounts' Profile Information, or you may handle this case by subscribing to the profile_disconnected Push Notification; However, we expect for many workflows, this single summarized view will be more convenient.

Integrated Conferencing: explicit Google Meet

We support many providers as part of our Conferencing Services featureset. One conferencing provider that differs from most is Google Meet. It's effectively a feature of Google Calendar itself, which has benefits (no additional authentication needed!) and drawbacks (it's not calendar agnostic). As a result, up to now, it's only been possible to get Google Meet conferencing on an event by relying on our default conferencing behaviour, which is dependent on user preferences; requesting Google Meet explicitly hasn't been possible.

We've added the concept of integrated conferencing to solve this. When creating an event, you can use this new keyword to explicitly ask for the conferencing service built into the destination calendar. Currently, we support Google Meet for Google Calendar events, but the model allows for supporting additional similar services in the future.

On calendars, we now expose a new property of calendar_integrated_conferencing_available:

{
    "calendars": [
        {
            "provider_name": "google",
            "profile_id": "pro_XpiPsafvvQBklzIg",
            "profile_name": "marty.mcfly@gmail.com",
            "calendar_id": "cal_XpiEasdgfBklzIg_ePxSn6rdfxdLHU-Q",
            "calendar_name": "marty.mcfly@gmail.com",
            "calendar_readonly": false,
            "calendar_deleted": false,
            "calendar_primary": true,
            "calendar_integrated_conferencing_available": true,
            "permission_level": "sandbox"
        }
    ]
}

When it's available, you can create events with the new conferencing profile keyword of integrated:

{
    "event_id": "ns5gua3jcb8",
    "start": "2020-11-22T12:00:00Z",
    "end": "2020-11-22T13:00:00Z",
    "summary": "Second stage interview",
    "conferencing": {
        "profile_id": "integrated"
    }
}

Read more in our Conferencing Services documentation.

Explicit Conferencing details

We've added the ability to explicitly set conferencing join details on events.

This expands the use cases where you can take advantage of Cronofy's and calendar providers' native understanding of conferencing. You may need to integrate with a conferencing service that we don't yet support conferencing creation for, or perhaps you have an existing integration that you wish to leverage.

This API call:

{
    "event_id": "i5ndr7orehwwyh",
    "summary": "One-to-one check-in",
    "start": "2020-07-23T09:00:00Z",
    "end": "2020-07-23T10:00:00Z",
    "tzid": "Etc/UTC",
    "conferencing": {
        "profile_id": "explicit",
        "provider_description": "Videotech virtual meeting",
        "join_url": "https://videotech.com/join-call/xyz"
    }
}

will give the following results in Google Calendar, for example:

Screenshot 2020-07-22 at 10.21.15.png

Read the Conferencing Services API documentation for more details.

Conferencing Services now in Beta

The Conferencing Services extensions to events have been moved into Beta today. This means that it moves into a monitoring phase as it is adopted more widely.

See the Conferencing Services documentation for more information on how to auto-generate conferencing for your calendar events.

Thank you to all of our customers who were early testers of this capability.

Availability API - query_periods

We've recently updated our Availability API to support query_periods as well as available_periods as a root attribute.

A new-style example API query looks like this:

{
  "participants": [
    {
      "members": [
        { "sub": "acc_567236000909002" },
        { "sub": "acc_678347111010113" }
      ],
      "required": "all"
    }
  ],
  "required_duration": { "minutes": 60 },
  "query_periods": [
    {
      "start": "2020-06-17T09:00:00Z",
      "end": "2020-06-17T18:00:00Z"
    },
    {
      "start": "2020-06-18T09:00:00Z",
      "end": "2020-06-18T18:00:00Z"
    }
  ]
}

After working with the API for a few years now and discussing with customers, we concluded that the term available_periods wasn't expressing the intent of the syntax explicitly enough. query_periods is a far clear description of the purpose of that parameter at that level in the query structure. We recommend using query_periods going forward.

This change will also be supported in anywhere an availability query is used, eg: Real Time Scheduling, Sequenced Availability and UI Elements like the Availability Viewer and Slot Picker.

We will continue to support available_periods so no existing implementations need to change.

Naming remains, as ever, one of the hard problems. However, not one to shy away from when we recognize the need to change.

See the updated Availability API documentation for more details.

Conferencing push notifications

Our Conferencing Services feature has been updated to add the ability to subscribe to notifications when conferencing details are created on an event.

Conferencing creation is an asyncronous process that happens after the initial API call to create or update the calendar event, and by using these notifications, you can avoid having to poll our API waiting for the conferencing URL to be generated.

By adding a new subscriptions attribute to an event, you can subscribe your webhook URL to events by referencing a new interaction type of conferencing_assigned.

{
  "event_id": "qwhpaprqzzgklulmpxsb",
  "summary": "Virtual interview",
  "start": "2020-07-21T15:30:00Z",
  "end": "2020-07-21T16:00:00Z",
  "conferencing": {
    "profile_id": "default"
  },
  "subscriptions": [
    {
      "type": "webhook",
      "uri": "https://example.com/notification",
      "interactions": [
        {
          "type": "conferencing_assigned"
        }
      ]
    }
  ]
}

As soon as conferencing details have been created for your event, we'll POST to your URL with the full event details, so you don't need to make follow-up requests to our API at all.

Read more in the Push Notifications documentation.

Your Profile

We've released a series of improvements recently focused around the management of your Cronofy account.

Your Profile

Your_Profile___Cronofy.png

From here you can update your account email, name, time zone and other settings.

Calendar Services

Calendar_Services___Cronofy.png

This allows you to see all the calendar services connected to your Cronofy account. You can also add and remove. Especially useful if you during testing you end up connecting calendars you don't want to.

Conferencing Services

Similarly to calendar services, this section allows you to manage the conferencing services linked to your account. You can choose which one is the default to use for API interactions.

Account Security

Here is where you can change your password. You can also set up multi-factor authentication to protect your account from unauthorized access.

Go to Your Profile to manage your account.

Browser extension markup detection

The Cronofy browser extension allows end-users to generate personalized scheduling links straight from their browser.

Whilst we've setup contact detection for some web sites, the extension will also look for appropriately formatted markup in any web page. This allows any app to work with the extension, allowing your users to quickly create personalized scheduling links base for the contact they are viewing.

For example:

  • Recruitment software can allow a recruiter to quickly generate a scheduling link for a specific candidate.
  • CRMs can allow a sales person to generate a personalized link for a prospect. Instead of a static link that forces the prospect to fill in their details when the sales person already knows who they are.
  • Support systems can allow an engineer to generate a one-time link for a customer to book a call without making their calendar public.

It provides a quick and easy way to give users access to powerful scheduling capabilities whilst remaining in your application.

  1. You add simple, hidden markup to your web application.
  2. User installs the extension and follows the instructions to create a Cronofy account.
  3. Whenever the user clicks the extension when on one of your application's pages, it's pre-filled and ready to go.

See how in the Browser extension documentation

Zoom conferencing now live

Zoom conferencing is now available as a conferencing service option alongside 8x8, Google Meet, GoTo Meeting and Microsoft Teams.

Review the Authorization documentation for instructions as to how to allow end users to authorize using their Zoom accounts.

Auto-generate conferencing service links when creating an event

Our new Conferencing Services feature has been released in to Alpha today and is available on all plans.

By adding an additional conferencing attribute to an event, you can request that Cronofy auto-generates conferencing links for all participants.

{
  "event_id": "qTtZdczOccgaPncGJaCiLg",
  "summary": "Board meeting",
  "description": "Discuss plans for the next quarter.",
  "start": "2020-04-22T15:30:00Z",
  "end": "2020-04-22T17:00:00Z",
  "conferencing": {
    "profile_id": "default"
  }
}

This format will also work when added an event object to a Real Time Scheduling request.

See the conferencing services docs for more detail.

Supported Conferencing Providers

By default this will generate a 8x8 video conferencing link that anyone can access from a WebRTC compatible browser like Google Chrome.

We are also supporting the ability for your application end-users to authorize their preferred conferencing service. Instead of an 8x8 link, a meeting will be generated with this provider and the appropriate links and details will be added. We're launching with support for Google Meet, Zoom, Microsoft Teams and GoToMeeting.

This authorization flow is very similar to the way end-users will authorize access to their calendars. Instructions in the Authorization docs.