Skip to main content

​
Integration Specifications

​
Prerequisites

​
Getting your API key

  1. After logging in to Avoma, select Developer under ORGANIZATION in Settings. Avoma menu with Developer highlighted
  2. On the Add API Key screen, enter any name in Name, and select Organization - limited access in Scope.
  3. Click Add API Key. Store the API key that appears in a safe place, because you use it to set up the integration. Avoma Add API Key screen with Organization - limited access in Scope and the Add API Key button highlighted

​
Setting up the integration

  1. On the integration screen, search for Avoma.
  2. Enter any string into Workspace key. Enter the API key you saved in the previous step into API key, and click Connect. Workspace name is optional. Avoma integration setup screen showing the Workspace name, Workspace key, and API key fields
  3. Once the integration with Avoma succeeds, registered user information appears in the account list. If it doesn’t complete successfully, first try the steps in Troubleshoot SaaS integration errors. If that doesn’t resolve it, check Information to provide and contact support.
Last modified on October 21, 2026