Recall.ai ^ALPHA

Recall.ai allows you to add customizable conferencing bots to video conferencing calls.

Our partnership means it’s easy to add a Recall.ai bot to events created with the Cronofy API. We automatically keep Recall.ai in sync with any changes to the event like reschedules. Meaning you don’t have to build anything to ensure that the bot will join at the right time.

As this is an alpha feature it currently needs to be enabled for your organization.

Please contact support@cronofy.com or click on the “Support” widget in the bottom right of this page and ask for Whereby to be enabled so that you can get started.

Setting up your Recall.ai integration #

You will need to generate a Recall.ai API key and add it to Cronofy:

Provision a Recall.ai API key #

Log in to your Recall.ai dashboard for the appropriate region
From the menu, choose your API Keys page
Select “Generate API key”
Give your key a meaningful name such as “Cronofy Integration”
Save your new key

Add the key to your Recall.ai Integration in Cronofy #

Sign in to your Cronofy Dashboard
From the menu, choose your Organization Settings page
Select “Manage Integrations” and choose to “Set Up New Integration”
Select “Recall.ai”
Choose the matching region and paste in the key from your Recall.ai dashboard
Save the configuration
Choose which applications you want to use Recall.ai with

Adding Recall.ai to your calendar events #

Recall.ai is added to a calendar event through the extensions attribute when creating or updating the event.

The profile_id to use is shown as the Cronofy Extension Profile ID on your Recall.ai integration configuration page:

This is then used as the profile_id in the extension object when creating an event.

{
  "event_id": "2024-10-09-recall",
  "summary": "Recall test",
  "start": "2024-11-18T16:00:00Z",
  "end": "2024-11-18T17:00:00Z",
  "tzid": "Europe/Berlin",
  "conferencing": {
      "profile_id": "default"
  },
  "extensions": [
      {
          "provider": "recall",
          "profile_id": "int_YOUR-ID-FROM-THE-DASHBOARD-HERE_0000000000"
      }
  ]
}

Also on the configuration page you can set default options for the bot name and the recording mode.

Recall.ai metadata #

One the bot is provisioned Cronofy will add metadata to the event to allow you to reference the associated bot via the Recall.ai API.

event.metadata.recall - will contain Recall.ai specific values.

{
  ...,
  "metadata": {
      "recall": {
          "bot_id": "02263898-51b1-43ff-8649-2ac71251ea83"
      }
  }
}

Cancelling an already scheduled bot #

In situations where you want cancel a scheduled bot, for example when someone decides they don’t want the session recorded you can update the calendar event by setting the Recall.ai extension profile_id to none.

{
  ...,
  "extensions": [
    {
      "provider": "recall",
      "profile_id": "none"
    }
  ]
}

This will then cancel the bot with Recall.ai.

Recall.ai ALPHA