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

# Outreach

## What's Supported

### Supported Actions

The Outreach connector supports:

* [Read Actions](/read-actions), including full historic backfill and incremental read for most of the supported objects. Note: Incremental reads are only supported on a per-day basis
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.outreach.io`.
* [Subscribe Actions](/subscribe-actions).

### Supported Objects

export const Check = () => <span>✅</span>;
export const Cross = () => <span>🚫</span>;

<div style={{ width: '100%', overflowX: 'auto' }}>
  <table style={{ width: '100%', minWidth: '100%', tableLayout: 'fixed', textAlign: 'center', borderCollapse: 'collapse' }}>
    <thead>
      <tr style={{ width: '100%' }}>
        <th style={{ textAlign: 'left', width: '40%' }}>Object</th>
        <th style={{ width: '20%' }}>Read</th>
        <th style={{ width: '20%' }}>Write</th>
        <th style={{ width: '20%' }}>Subscribe</th>
      </tr>
    </thead>

    <tbody>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Account/#tag/Account">accounts</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Audit-Log/#tag/Audit-Log/paths/~1auditLogs/get">auditLogs</a> \*</td><td><Check /></td><td><Cross /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Call/#tag/Call">calls</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Call-Disposition/#tag/Call-Disposition">callDispositions</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Call-Purpose/#tag/Call-Purpose">callPurposes</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Compliance-Request/#tag/Compliance-Request">complianceRequests</a> \*</td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Content-Category">contentCategories</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Content-Category-Membership">contentCategoryMemberships</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Content-Category-Ownership/#tag/Content-Category-Ownership">contentCategoryOwnerships</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Currency-Type/#tag/Currency-Type">currencyTypes</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Custom-Duty/#tag/Custom-Duty/paths/~1customDuties/post">customDuties</a></td><td><Cross /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Dated-Conversion-Rate/#tag/Dated-Conversion-Rate">datedConversionRates</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Duty/#tag/Duty/paths/~1duties/get">duties</a> \*</td><td><Check /></td><td><Cross /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Email-Address/#tag/Email-Address">emailAddresses</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Event/#tag/Event/paths/~1events/get">events</a> \*</td><td><Check /></td><td><Cross /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Favorite/#tag/Favorite">favorites</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}>import</td><td><Cross /></td><td><Cross /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Mail-Alias/#tag/Mail-Alias/paths/~1mailAliases/get">mailAliases</a></td><td><Check /></td><td><Cross /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Mailbox/#tag/Mailbox">mailboxes</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Mailing/#tag/Mailing">mailings</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Opportunity/#tag/Opportunity/paths">opportunities</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Opportunity-Prospect-Role/#tag/Opportunity-Prospect-Role">opportunityProspectRoles</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Opportunity-Stage/#tag/Opportunity-Stage">opportunityStages</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Persona/#tag/Persona">personas</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Phone-Number/#tag/Phone-Number">phoneNumbers</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Product/#tag/Product">products</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Profile/#tag/Profile">profiles</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Prospect/#tag/Prospect">prospects</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Purchase/#tag/Purchase">purchases</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Recipient/#tag/Recipient">recipients</a> \*</td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Role/#tag/Role">roles</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Ruleset/#tag/Ruleset">rulesets</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Sequence/#tag/Sequence">sequences</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Sequence-State/#tag/Sequence-State">sequenceStates</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Sequence-Step/#tag/Sequence-Step">sequenceSteps</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Sequence-Template/#tag/Sequence-Template">sequenceTemplates</a> \*</td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Snippet/#tag/Snippet">snippets</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Stage/#tag/Stage">stages</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Task/#tag/Task">tasks</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Task-Disposition/#tag">taskDispositions</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Task-Priority/#tag/Task-Priority/paths/~1taskPriorities/get">taskPriorities</a></td><td><Check /></td><td><Cross /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Task-Purpose/#tag/Task-Purpose">taskPurposes</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Team/#tag/Team">teams</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Template/#tag/Template">templates</a></td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/User/#tag/User">users</a></td><td><Check /></td><td><Check /></td><td><Check /></td></tr>
      <tr><td style={{ textAlign: 'left' }}><a href="https://developers.outreach.io/api/reference/tag/Webhook/#tag/Webhook">webhooks</a> \*</td><td><Check /></td><td><Check /></td><td><Cross /></td></tr>
    </tbody>
  </table>
</div>

*\* Only supports a full read each time, not incremental read.*

### Example Integration

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

## Before You Get Started

Before creating an **Outreach** app, you must complete the Outreach partnership process to obtain a sandbox instance. Please ensure that you add `https://api.withampersand.com/callbacks/v1/oauth` as a callback URL for the Outreach app.

After your account is set up, you will need to acquire the following credentials from your Outreach app:

* Client ID
* Client Secret
* Scopes

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

## Add Outreach App Details in Ampersand

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

2. Select the project where you want to add the Outreach App.

3. Select **Provider apps**.

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

5. Enter the Outreach Application ID in the **Client ID** field, the Outreach Application Secret in the **Client Secret** field, and the requested scopes in the **Permissions** field.

6. Enter the scopes defined for the *Outreach* application.

<Note>
  For each object that you want to read, you need to add a scope for it, for example: `accounts.all`.
  If your integration uses Subscribe Actions, you also need to add the `webhooks.all` scope.
</Note>

<br />

<img src="https://mintcdn.com/ampersand-24eb5c1a/i4a56x-Fmj6u7jdE/images/provider-guides/9c1fda8-outreach.gif?s=00de8ef2eb5791d914493da5b7a9fe42" alt="Alt text" width="540" height="488" data-path="images/provider-guides/9c1fda8-outreach.gif" />

7. Click **Save Changes**.

## Using the connector

To start integrating with Outreach:

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

## Publish your Outreach app

When you are ready to publish your Outreach app to the Outreach Marketplace, follow the instructions on the [Outreach documentation](https://developers.outreach.io/guides/managing-apps/#publishing-apps).

## Limitations of development credentials

Please note that until you publish your app, there are limitations on the credentials you obtain via your Ampersand integration. While an unpublished app can be used to connect to other Outreach workspaces, such as those of your customers, Outreach will expire those credentials weekly. This means that your customers will need to re-install their integrations weekly. Refer to the [Outreach documentation](https://developers.outreach.io/api/oauth/#limitations-of-development-credentials) for more details.

Even after you publish your Outreach app, be sure to select the "Production" tab and use the Application ID and Secret from that tab for your Ampersand Provider App.

<img width="70%" src="https://mintcdn.com/ampersand-24eb5c1a/xjDXN-Vr1QbdihBU/images/provider-guides/outreach-creds.png?fit=max&auto=format&n=xjDXN-Vr1QbdihBU&q=85&s=e1f792726713fabe37a88dd0cea5c5ca" data-path="images/provider-guides/outreach-creds.png" />