What are Private Integrations?
Private Integrations allows you to build powerful custom integrations between your CRM account and any other third party app.
If you are looking to integrate your CRM account with a third party app, you have two options:
1. Find and install relevant app from the App Marketplace
2. Build your own private integration by yourself or with the help of a developer using APIs.
Private Integrations helps you achieve #2 securely.
The key advantages of using Private Integrations are:
- Simple: Generate Private Integration tokens from your account settings and manage them with ease.
- Secure: You get to restrict the scopes/permissions that a developer can access on your account
Private Integrations are available for both Agencies and Sub-Accounts.
What's the difference between Private Integrations and API Keys?
Private Integrations, to put it simply, is a more powerful yet secure alternative to API Keys.
| Private Integrations | API Keys |
| More Secure: You get to restrict the scopes/permissions that a developer can access on your account | Less Secure: A developer gets unrestricted access to all your account data |
| State-of-art: Private Integrations allows you to access API v2.0 which is state of the art. | Out-dated: API Keys work on API v1.0 which has reached end-of-life and is no longer maintained. |
| More Features: API v2.0 has more powerful APIs and supports webhooks(ability for third party apps to get notified when specific events occur on your account). | Less Features: API v1.0 has limited APIs and does not support webhooks. |
What's the difference between Private Integrations and OAuth2 Access Tokens?
Private Integrations, to put it simply, are static/fixed OAuth2 Access Tokens.
| Private Integrations | Access Tokens |
| Generated from the UI: Private Integration token can be generated easily from the UI. | Programmatic Generation: API Tokens are generated by exchanging OAuth access code for the tokens using Get Access Token API. |
| Static/Fixed: Private Integration Tokens are static/fixed and do not automatically refresh unless you rotate them from the UI. | Refreshed Daily: Access Tokens expire daily and need to be refreshed. |
How do I use Private Integrations?
Private Integration Tokens function similarly to other Access Tokens and are included in the Authorization header. For instance, to retrieve details about a specific location, you can call the Get Sub-account API while using the Agency's Private Integration Token in the Authorization header.
curl --request GET \ --url https://services.leadconnectorhq.com/locations/ve9EPM428h8vShlRW1KT \ --header 'Accept: application/json' \ --header 'Authorization: <YOUR PRIVATE INTEGRATION TOKEN>' \ --header 'Version: 2021-07-28'
Generic
How do I manage Private Integrations?
Who can create Private Integrations?
By default, all agency admins can create and manage Private Integrations.
However, you can restrict this permission at a user level. To do this, Navigate to Settings > Team > Edit the specific agency admin > Roles & Permissions, and enable/disable Private Integrations for the agency admin.
You may apply the restrictions at two levels:
- Allow the agency admin to view and manage the agency's private integrations
- Allow the agency admin to view and manage the sub-accounts' private integrations
Where can I find Private Integrations?
You can find Private Integrations under agency settings. If you don't find it under settings, please make sure that you have enabled the feature on Labs.
How do I create a new Private Integration?
Step 1: Click on "Create new Integration"
Step 2: Give your Private Integration a name and description to help you and your team identify what it's for.
Step 3: Select the scopes/permissions that you want the private integration to have access to on your agency account. Ensure that you are selecting only the required scopes for better data security.
Step 4: Copy the token generated and share it with your third-party app developer.
Please ensure that you are sharing the token with trusted parties only. Do not share it publicly.
Note: Don't forget to copy the token generated as you won't be able to do it again later.
What are some best practices to maintain security of my private integration token?
We recommend that you rotate your Private Integration tokens every 90 days.
Here's how you can do it.
Step 1: Navigate to Private Integrations under settings, and click on the Private Integration you have created.
Step 2: Click on "Rotate and expire this token later".
Step 3: Click "Continue" in response to the warning message if you are sure that you want to proceed with rotation.
Step 4: Copy the new token and update it on your third-party app. You will have a 7 day window where both the old and the new tokens will continue to work. After 7 days, the old token will expire. In this 7 day window, you will have the option to:
1. "Cancel rotation" if, for example, your developer needs more time to update the token on the third-party app.
2. "Expire Now", if, for example, the third party app has been updated with the new token.
Note: Don't forget to copy the token generated as you won't be able to do it again later.
Has my token been compromised? What should I do?
Step 1: Navigate to Private Integrations under settings, and click on the Private Integration you have created.
Step 2: Click on "Rotate and expire this token now".
Step 3: Click "Continue" in response to the warning message if you are sure that you want to proceed with rotation.
Step 4: Copy the new token and update it on your third-party app.
Note: Don't forget to copy the token generated as you won't be able to do it again later.
Can I edit the Private Integration permissions without updating the token?
Yes, you can edit the Private Integration name, description and scopes/permissions any time after you've created it.
Here's how you can do it.
Step 1: Navigate to Private Integrations under settings, and select "Edit" from the three-dot menu.
Step 2: Update the Private Integration name and description if required. Click on "Next".
Step 3: If required, update the scopes/permissions that you want the private integration to have access to on your account. Ensure that you are selecting only the required scopes for better data security. Click on "Update" to save the updates made.
Note: Updating the Private Integration details does not generate a new token. The existing token will continue to work.
How do I delete the Private Integration once I no longer need it?
You can delete the Private Integration once you no longer are using the third-party app.
To do so, navigate to Private Integrations under settings, and select "Delete" from the three-dot menu.