Outreach
Version
This integration utilizes the Outreach REST API v2.
Base URL
The base URL used for all Outreach API endpoints:https://api.outreach.io/api/v2
Authentication & Authorization
The DataGrail Outreach integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.
Scopes
The Outreach integration requires specific scopes that must be granted in order to function for a given capability.
Scope | Base | Access | Deletion |
---|---|---|---|
accounts.read | ✅ | ||
calls.read | ✅ | ||
callDispositions.read | ✅ | ||
callPurposes.read | ✅ | ||
complianceRequests.read | ✅ | ✅ | |
complianceRequests.write | ✅ | ||
events.read | ✅ | ||
mailboxes.read | ✅ | ||
mailings.read | ✅ | ||
personas.read | ✅ | ||
phoneNumbers.read | ✅ | ||
prospects.all | ✅ | ✅ | ✅ |
sequences.read | ✅ | ||
sequenceStates.read | ✅ | ||
sequenceSteps.read | ✅ | ||
sequenceTemplates.read | ✅ | ||
snippets.read | ✅ | ||
stages.read | ✅ | ||
tasks.read | ✅ | ||
teams.read | ✅ | ||
templates.read | ✅ | ||
users.read | ✅ |
Endpoints Utilized
DataGrail uses the following endpoints to authorize and test the connection:
Limits
Limits in Outreach are calculated using the leaky
bucket algorithm. All requests that are made after rate limits have been
exceeded are throttled and an HTTP 429 Too Many Requests
error is returned.
Requests succeed again after enough requests have emptied out of the bucket.
- DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
- DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).
Capabilities
Access
DataGrail's Outreach integration provides Synchronous Access capabilities for the following supported identifier category: Email.Data Interactions
For Access requests, DataGrail will take the following actions:
- Fetch a Collection of Resources using the Data Subject email as a filter.
- For each identified prospect object, extract the following associated objects:
Match Found
- account
- persona
- stage
- calls
- mailings
- opportunities
- phone numbers
- sequence states
- tasks
- For creator, owner, updater objects, DataGrail only returns user IDs to protect privacy of internal users.
Endpoints Utilized
Deletion
DataGrail's Outreach integration provides Asynchronous (Whole Record) Deletion capabilities for the following supported identifier category: Email.Data Interactions
For Deletion requests, DataGrail will take the following actions:
- Fetch a Collection of Resources using the Data Subject email as a filter.
- Create a Compliance Request for all identified objects.
- Check the status of the submitted request to confirm deletion.
Endpoints Utilized
Method | Endpoint | Purpose | Docs |
---|---|---|---|
GET | /complianceRequests | View the status of the submitted request | |
POST | /complianceRequests | Create Compliance Requests | |
GET | /prospects | Fetch a Collection of Resources |
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.