> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Avoma

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill and incremental read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.avoma.com`.

### Supported Objects

The Avoma connector supports reading to the following objects:

* [calls](https://dev694.avoma.com/#tag/Calls/paths/~1v1~1calls~1/get)
* [custom\_categories](https://dev694.avoma.com/#tag/Custom-Category/paths/~1v1~1custom_categories~1/get)
* [meetings](https://dev694.avoma.com/#tag/Meetings/paths/~1v1~1meetings~1/get)
* [notes](https://dev694.avoma.com/#tag/Notes/paths/~1v1~1notes~1/get)
* [scorecard\_evaluations](https://dev694.avoma.com/#tag/Scorecard-Evaluations/operation/scorecard_evaluations_list)
* [scorecards](https://dev694.avoma.com/#tag/Scorecards/operation/scorecards_list)
* [smart\_categories](https://dev694.avoma.com/#tag/Smart-Category/paths/~1v1~1smart_categories~1/get)
* [transcriptions](https://dev694.avoma.com/#tag/Transcriptions/paths/~1v1~1transcriptions~1/get)
* [template](https://dev694.avoma.com/#tag/Templates/paths/~1v1~1template~1/get)
* [users](https://dev694.avoma.com/#tag/Users/paths/~1v1~1users~1/get)

The Avoma connector supports writing to the following objects:

* [calls](https://dev694.avoma.com/#tag/Calls/operation/createExtCall)
* [smart\_categories](https://dev694.avoma.com/#tag/Smart-Category/paths/~1v1~1smart_categories~1/post)
* [template](https://dev694.avoma.com/#tag/Templates/paths/~1v1~1template~1/post)

### Example integration

For an example manifest file of a Avoma integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/avoma/amp.yaml).

## Using the connector

This connector uses **API Key authentication**, so you do not need to configure a Provider App before getting started. (Provider Apps are only required for providers using the **OAuth2 Authorization Code grant type**.)

To integrate with Avoma:
Create a manifest file similar to the example above.
Deploy it using the [amp CLI](/cli/overview).
Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component, which will prompt the customer for an API key.

* Start using the connector!
* If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
  * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
  * If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.

## Creating an API key for Avoma

See the Avoma documentation \[[https://help.avoma.com/api-integration-for-avoma](https://help.avoma.com/api-integration-for-avoma)] for instructions on how to create an API key.