Circleback

​

What’s supported

​

Supported actions

• Read Actions, including full historic backfill. Incremental reading is supported for the objects listed below. For all other objects, a full read of the Circleback instance will be done per scheduled read.
• Proxy Actions, using the base URL https://circleback.ai/api.

​

Supported objects

• action-items
• companies
• meetings (supports incremental read)
• people
• tag

​

Example integration

# amp.yaml
specVersion: 1.0.0
integrations:
  - name: circlebackIntegration
    displayName: My Circleback Integration
    provider: circleback
    read:
      objects:
        - objectName: meetings
          destination: meetingWebhook
        - objectName: people
          destination: meetingWebhook
    proxy:
      enabled: true

​

Before you get started

​

Creating an API key for Circleback

1. Log in to Circleback and go to Settings → API keys.
2. Create an API key.
3. Copy the key, which looks like cb_<secret>. Circleback shows it only once, at creation.

​

Using the connector

• Create a manifest file like the example above.
• Deploy it using the amp CLI.
• If you are using Read Actions, create a destination.
• Embed the InstallIntegration UI component. The UI component will prompt the consumer for their API key.
• Start using the connector!
  • If your integration has Read Actions, you’ll start getting webhook messages.
  • If your integration has Proxy Actions, you can start making Proxy API calls.

​

Notes

• Access is per user. A Circleback API key belongs to one user. The connector reads what that user can access in Circleback, including every meeting they can access, not only the meetings they own.
• Meetings carry their notes, attendees and transcript as fields of meetings:
  • notes holds the meeting notes in Markdown, and privateNotes holds the connected user’s private notes.
  • attendees lists each participant’s name, email, profileId and companyName.
  • transcript holds the transcript as a list of segments, each with speaker, text and timestamp (seconds from the start of the meeting). Ampersand fetches each meeting’s transcript from Get meeting transcript, only when you select the transcript field. A meeting with no transcript has transcript: null.
• Recording links expire. Circleback’s recordingUrl is valid for 24 hours, and is only set when the consumer has enabled saving meeting recordings.
• action-items covers every assignee and both states. The connector reads action items assigned to anyone, not only the connected user, both pending (PENDING) and done (DONE).
• Companies are identified by domain. Use domain as the stable identifier of a companies record.