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

# ChiliPiper

## 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 Chilipiper instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://fire.chilipiper.com`.

### Supported Objects

The Chilipiper connector supports reading from the following objects:

* [workspace](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Read%20all%20workspaces)
* [team](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Read%20all%20teams)
* [distribution](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/List%20all%20distributions)
* [workspace/users](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Read%20all%20users%20\(or%20in%20a%20workspace\))

The Chilipiper connector supports writing to the following objects:

* [distribution](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Update%20distribution%20and%20publish%20it)
* [user/invite](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Invites%20new%20user%20to%20the%20organization)
* [user/licenses](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Updates%20licenses%20for%20users)
* [team/users/add](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Add%20users%20to%20a%20team)
* [team/users/remove](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Remove%20users%20from%20a%20team)
* [workspace/users/add](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Add%20users%20to%20a%20workspace)
* [workspace/users/remove](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Remove%20users%20from%20a%20workspace)
* [workspace/users/remove-from-all](https://fire.chilipiper.com/api/fire-edge/public/org/docs/index.html#operation/Remove%20users%20from%20all%20workspaces)

### Example integration

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

## Before You Get Started

### Creating an API key for ChiliPiper

* Log in to your chilipiper instance
* Go to Integrations
* Click on the *API Access Tokens*
* Click On *Generate Token*

<img src="https://mintcdn.com/ampersand-24eb5c1a/i4a56x-Fmj6u7jdE/images/provider-guides/chilipiper.gif?s=96e7090334bd72cc8ef8b268f7b06f23" alt="ChiliPiper API Key Creation" width="2560" height="1294" data-path="images/provider-guides/chilipiper.gif" />

## 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 ChiliPiper:

* Create a manifest file like the [example](https://github.com/amp-labs/samples/blob/main/chilipiper/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. The UI component 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.