> ## 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.

# Kit

## What's Supported

### Supported Actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported. A full read of the Kit instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.kit.com`.

### Supported Objects

The Kit connector supports reading from the following objects:

* [Broadcasts](https://developers.kit.com/v4#list-broadcasts)
* [CustomFields](https://developers.kit.com/v4#list-custom-fields)
* [Forms](https://developers.kit.com/v4#list-forms)
* [Subscribers](https://developers.kit.com/v4#list-subscribers)
* [Tags](https://developers.kit.com/v4#list-tags)
* [EmailTemplates](https://developers.kit.com/v4#list-email-templates)
* [Purchases](https://developers.kit.com/v4#list-purchases)
* [Segments](https://developers.kit.com/v4#list-segments)
* [Sequences](https://developers.kit.com/v4#list-sequences)
* [Webhooks](https://developers.kit.com/v4#list-webhooks)

The Kit connector supports writing to the following objects:

* [Broadcasts](https://developers.kit.com/v4#create-a-broadcast)
* [CustomFields](https://developers.kit.com/v4#create-a-custom-field)
* [Subscribers](https://developers.kit.com/v4#create-a-subscriber)
* [Tags](https://developers.kit.com/v4#create-a-tag)
* [Purchases](https://developers.kit.com/v4#create-a-purchase)
* [Webhooks](https://developers.kit.com/v4#create-a-webhook)

### Example integration

To define an integration for Kit, create a manifest file that looks like this: [https://github.com/amp-labs/samples/blob/main/kit/amp.yaml](https://github.com/amp-labs/samples/blob/main/kit/amp.yaml)

## Before You Get Started

To connect Kit with Ampersand, you will need [a Kit Account](https://app.kit.com/users/signup).

Once your account is created, you'll need to create an app in Kit and obtain the following credentials from your app:

* Client ID
* Client Secret

You will then use these credentials to connect your application to Ampersand.

### Create a Kit Account

Here's how you can sign up for a Kit account:

* Go to the [Kit Sign Up page](https://app.kit.com/users/signup).
* Sign up using your preferred method.

### Creating a Kit App

Follow the steps below to create a Kit app and add the Ampersand redirect URL.

1. Log in to your [Kit](https://app.kit.com/users/login) account.

2. Click the **Profile** icon, then click on **Settings** and go to **Developer**.

3. Click on **Create a new app**.

4. In the **Create a new app** pop-up window, enter the **App name**.

5. You can also add:

* **Summary**
* **Logo**
* **Website URL**
* **Support URL**
* **Knowledge base URL**
* **Privacy policy URL**
* **Images**
* **Access required**
* **Categories**

6. Click **Save**. Next, you will need to **Configure** the app.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/kit_OAuth.gif?s=a9b6afcdb86409464032000aa9244c14" alt="Kit App Creation" width="800" height="523" data-path="images/provider-guides/kit_OAuth.gif" />

7. Enter the Authorization URL: `https://app.kit.com/oauth/authorize` in the **Authorization URL** section.

8. Enter `https://api.withampersand.com/callbacks/v1/oauth` in the **Redirect URIs** section.

9. Click **Continue**.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/kit_configure.gif?s=a6702f74e8dcf1865afe5c490cf45139" alt="Kit App Creation" width="600" height="488" data-path="images/provider-guides/kit_configure.gif" />

## Add Your Kit App Info to Ampersand

1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).

2. Select the project where you want to create a Kit integration.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/Bx3tggG51e0liOp-/images/provider-guides/31a6a12-Ampersand.png?fit=max&auto=format&n=Bx3tggG51e0liOp-&q=85&s=7ebd893fd2a976ebe7cf8af53f8581b8" alt="Ampersand Project Selection" width="2244" height="442" data-path="images/provider-guides/31a6a12-Ampersand.png" />

3. Select **Provider Apps**.

4. Select *Kit* from the **Provider** list.

5. Enter the previously obtained *Client ID* in the **Client ID** field and the *Client Secret* in the **Client Secret** field.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/kit.gif?s=434f861dbea81c33f7cef97e9c2f86e6" alt="Ampersand Integration" width="548" height="326" data-path="images/provider-guides/kit.gif" />

## Using the connector

To start integrating with Kit:

* Create a manifest file using the [example](https://github.com/amp-labs/samples/blob/main/kit/amp.yaml).
* Deploy it using the [amp CLI](/cli/overview).
* If you are using Read Actions, create a [destination](/destinations).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component.
* 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.