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

# Clarify

## What's supported

### Supported actions

This connector supports:

* [Read Actions](https://docs.ampersand.ai/read-actions.md), including full historic backfill and incremental read for all supported objects.
* [Proxy Actions](https://docs.ampersand.ai/proxy-actions.md), using the base URL `https://api.clarify.ai`.

### Supported objects

The Clarify connector supports reading from the following objects:

* [`c_<name>`](https://developer.clarify.ai/docs/guides/schemas-and-relationships#custom-objects): any custom object in the workspace, by its Clarify name (for example `c_sales_order`)
* [company](https://developer.clarify.ai/docs/api-reference/resources/getResources)
* [deal](https://developer.clarify.ai/docs/api-reference/resources/getResources)
* [meeting](https://developer.clarify.ai/docs/api-reference/resources/getResources)
* [person](https://developer.clarify.ai/docs/api-reference/resources/getResources)
* [task](https://developer.clarify.ai/docs/api-reference/resources/getResources)
* [users](https://developer.clarify.ai/docs/api-reference/users/getUsers)

### Example integration

To define an integration for Clarify, create a manifest file that looks like this:

```YAML theme={"dark"}
# amp.yaml
specVersion: 1.0.0
integrations:
  - name: clarifyIntegration
    displayName: My Clarify Integration
    provider: clarify
    read:
      objects:
        - objectName: company
          destination: myWebhook
    proxy:
      enabled: true
```

## Before you get started

To connect Clarify with Ampersand, you will need a [Clarify account](https://www.clarify.ai).

### Creating an API key for Clarify

1. Sign in to Clarify and open [**Settings → API Keys**](https://app.clarify.ai/redirect/settings/api-keys).
2. Create a key. Pick its type:
   * A **personal** key acts as you and can read everything you can, including meeting content shared with you. Any workspace member can create one.
   * A **workspace** key is shared and limited to public data in the workspace. Only workspace admins can create one.
3. Copy the key.
4. Note your workspace slug. It appears in your Clarify login URL and under the user avatar menu, and proxy paths include it: `/v1/workspaces/<your workspace slug>/...`. See [Clarify's workspace docs](https://developer.clarify.ai/docs/getting-started/key-concepts#workspace).

## Using the connector

This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with Clarify:

* Create a manifest file like the [example above](#example-integration).
* Deploy it using the [amp CLI](https://docs.ampersand.ai/cli/overview.md).
* If you are using Read Actions, create a [destination](https://docs.ampersand.ai/destinations).
* Embed the [InstallIntegration](https://docs.ampersand.ai/embeddable-ui-components.md#install-integration) UI component. The UI component will prompt the consumer for their API key and workspace slug.
* Start using the connector!
  * If your integration has [Read Actions](https://docs.ampersand.ai/read-actions.md), you'll start getting webhook messages.
  * If your integration has [Proxy Actions](https://docs.ampersand.ai/proxy-actions.md), you can start making Proxy API calls.

## Notes

* **Workspace scope.** Every Clarify request is scoped to one workspace, so the consumer gives their workspace slug when they connect. Proxy paths start with the API version and the workspace: `/v1/workspaces/<workspace slug>`, for example `GET /v1/workspaces/<workspace slug>/objects/person/resources`.
* **Custom objects.** Read a custom object by its Clarify name, which always starts with `c_`. For example, an object named "Sales Order" is read as `c_sales_order`.
* **Relationships.** Records include links to one other record as ID fields, such as `company_id`, `owner_id` and `deal_id`. Meetings include their attendees in a `participants` field.
* **Meeting content.** Clarify marks these meeting fields as secure: `title`, `description`, `location`, `conferencing`, `notes`, `summary`, `external_summary`, `prep` and `external_prep`.
  * They are filled in only when the API key's user can see that meeting; the meeting's `_has_access` field says whether they can.
  * A personal key can see everything its creator can; a workspace key sees only public workspace data.
* **Merged records.** When records are merged in Clarify, the records merged away stop appearing in reads, as deleted records do. The surviving record lists their IDs in `_merged_ids`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.