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

# Mixmax

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

### Supported Objects

The Mixmax connector supports reading from the following objects:

* [appointmentlinks/me](https://developer.mixmax.com/reference/appointmentlinksme)
* [userpreferences/me](https://developer.mixmax.com/reference/userpreferencesme)
* [users/me](https://developer.mixmax.com/reference/user)
* [codesnippets](https://developer.mixmax.com/reference/codesnippets)
* [filerequests](https://developer.mixmax.com/reference/filerequests)
* [insightsreports](https://developer.mixmax.com/reference/insightsreports)
* [integrations/commands](https://developer.mixmax.com/reference/integrationscommands)
* [integrations/enhancements](https://developer.mixmax.com/reference/integrationsenhancements)
* [integrations/linkresolvers](https://developer.mixmax.com/reference/integrationslinkresolvers)
* [integrations/sidebars](https://developer.mixmax.com/reference/integrationssidebars)
* [livefeed](https://developer.mixmax.com/reference/livefeed)
* [meetinginvites](https://developer.mixmax.com/reference/meetinginvites-1)
* [meetingtypes](https://developer.mixmax.com/reference/meetingtypes)
* [messages](https://developer.mixmax.com/reference/messages)
* [polls](https://developer.mixmax.com/reference/polls)
* [qa](https://developer.mixmax.com/reference/qa)
* [rules](https://developer.mixmax.com/reference/rules)
* [sequences](https://developer.mixmax.com/reference/sequences)
* [sequencefolders](https://developer.mixmax.com/reference/sequencefolders)
* [snippets](https://developer.mixmax.com/reference/snippets)
* [snippettags](https://developer.mixmax.com/reference/snippettags)
* [teams](https://developer.mixmax.com/reference/teams)
* [unsubscribes](https://developer.mixmax.com/reference/unsubscribes)
* [yesno](https://developer.mixmax.com/reference/yesno)

The Mixmax connector supports writing to the following objects:

* [codesnippets](https://developer.mixmax.com/reference/codesnippets-1)
* [insightsreports](https://developer.mixmax.com/reference/insightsreports-1)
* [integrations/commands](https://developer.mixmax.com/reference/integrationscommands-1)
* [integrations/enhancements](https://developer.mixmax.com/reference/integrationsenhancements-1)
* [integrations/linkresolvers](https://developer.mixmax.com/reference/integrationslinkresolvers-1)
* [integrations/sidebars](https://developer.mixmax.com/reference/integrationssidebars-1)
* [livefeedsearches](https://developer.mixmax.com/reference/livefeedsearches-1)
* [meetingtypes](https://developer.mixmax.com/reference/meetingtypes-1)
* [meetinginvites](https://developer.mixmax.com/reference/meetinginvitesid-1)
* [messages](https://developer.mixmax.com/reference/messages-create)
* [messages/test](http://developer.mixmax.com/reference/messagestest)
* [reports/data/table](https://developer.mixmax.com/reference/reportsdatatable)
* [rules](https://developer.mixmax.com/reference/rules-1)
* [send](https://developer.mixmax.com/reference/send-post)
* [sequences/cancel](https://developer.mixmax.com/reference/sequencescancel)
* [sequencefolders](https://developer.mixmax.com/reference/sequencefolders-1)
* [snippettags](https://developer.mixmax.com/reference/snippettags-post)
* [teams](https://developer.mixmax.com/reference/teams-post)
* [unsubscribes](https://developer.mixmax.com/reference/unsubscribes-2)
* [userpreferences/me](https://developer.mixmax.com/reference/userpreferencesme-1)

### Example integration

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

## Before You Get Started

### Creating an API key for Mixmax

[Click here](https://developer.mixmax.com/reference/getting-started-with-the-api) for more information about generating an API key for Mixmax. The UI components will display this link, so that your users can successfully create API keys.

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

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