Overview
API Key Connection
How the Integration Works
Data Permissions, Objects & Retention
Rate Limiting & Throttling
API Key Connection
Nook users can connect their Nooks account to Apollo via API. This is done by creating a new API Key and providing it to Nooks.
Nooks uses a Master Key, as it is the simplest way for admins to grant access to the multiple APIs that are needed for Nooks to function with Apollo prospects, tasks and sequences.
This is necessary until Apollo provides other methods for deploying API access profiles.
For details on how to create a Master Key, scroll all the way to the bottom of this page
How the Integration Works
Just-in-time Access
In order to ensure data is up-to-date from Apollo, Nooks adopts a “just-in-time” access model to Apollo data.
The below diagram shows how Nooks uses this access model to load sequences from a report, retrieve tasks and log calls
Data Objects & Retention
List of Apollo APIs / Objects
Nooks interacts with the following standard objects in Apollo. Nooks does not support custom objects at this time.
Object | Documentation Link |
Contact | |
Account | |
Task | |
Sequence |
What data does Nooks store?
Nooks generally uses a Just-In-Time model for interactions with Apollo. As a result, no data from Apollo is stored on Nooks servers with 2 exceptions.
Nooks maintains a list of Apollo Users to support User Mapping settings.
These are not Contacts or Accounts, only Users of the integrated team.
Three fields are stored: UserId, Email and Name.
Nooks keeps track of Apollo Tasks created via its call logging microservices.
Rate Limiting & Throttling
Apollo has multiple rate limits for different APIs. These limits are set based on your Apollo plan, and may need to be raised depending on how many users are actively dialing from Nooks.
For more details, contact your Apollo administrator.
Appendix
How to generate an Apollo Master Key
Head to Apollo.io and login
Click on the Settings gear icon on the lower left at the very bottom, and on the new bar that opens up scroll down to Integrations
Scroll all the way down until you see an API option and click connect
Once on the API configuration page, on the left hand side under API Management go to the section titled API Keys and click on it
Click on create new key, and feel free to name and label it whatever your heart desires. You must set the key as a master key; don’t select any APIs to associate the key with.
Enter this key into Nooks