Outreach
What’s Supported
Supported Actions
The Outreach connector supports:
- Read Actions, including full historic backfill and incremental read for most of the supported objects.
- Write Actions.
- Proxy Actions, using the base URL
https://api.outreach.io.
Supported Objects
The Outreach connector supports reading and writing to and from the following objects:
- accounts
- calls
- callDispositions
- callPurposes
- contentCategories
- contentCategoryMemberships
- contentCategoryOwnerships
- complianceRequests(only supports a full read each time, not incremental read)
- currencyTypes
- datedConversionRates
- emailAddresses
- favorites
- mailboxes
- mailings
- opportunities
- opportunityProspectRoles
- opportunityStages
- personas
- phoneNumbers
- products
- profiles
- prospects
- purchases
- recipients(only supports a full read each time, not incremental read)
- roles
- rulesets
- sequences
- sequenceStates
- sequenceSteps
- sequenceTemplates(only supports a full read each time, not incremental read)
- snippets
- stages
- tasks
- taskDispositions
- taskPurposes
- teams
- templates
- users
- webhooks(only supports a full read each time, not incremental read)
The Outreach connector only supports reading from the following objects:
- auditLogs(only supports a full read each time, not incremental read)
- duties(only supports a full read each time, not incremental read)
- events(only supports a full read each time, not incremental read)
- mailAliases
- taskPriorities
The Outreach connector only supports writing to the following objects:
Example Integration
For an example manifest file of an Outreach integration, visit our samples repo on Github.
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
-
Log in to your Ampersand Dashboard.
-
Select the project where you want to add the Outreach App.
-
Select Provider apps.
-
Select Outreach from the Provider list.
-
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.
-
Enter the scopes defined for the Outreach application.
-
Click Save Changes.
Using the connector
To start integrating with Outreach:
- Create a manifest file like the example.
- Deploy it using the amp CLI.
- If you are using Read Actions, create a destination.
- Embed the InstallIntegration UI component.
- Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has 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.
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 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.