Before You Begin
Before you begin installing the Copper CRM subscription, obtain authentication information from Copper CRM.
Copper CRM APIs support two types of authentication:
Authentication by API Key and API Email
Authentication by OAuth 2.0 (Recommended)
To Authenticate by API Key and API Email:
Log in to Copper CRM using your credentials.
Click Settings in the sidebar menu.
On the settings page, click Integrations > API Keys.
Click Generate API Key.
Copy the generated API Key and store it in a safe location. You will need this key when installing the Copper CRM subscription.
NOTE: For enhanced security, we recommend using the OAuth 2.0 method for all types of requests except Webhooks request by following the steps outlined in the Operational Configuration – OAuth 2.0 Flow Initialization section below. |
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Copper CRM Integration title.
On the Subscription Detail page, click the Subscribe button.
Enter the Name of the subscription and select a Version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: Copper CRM – Release
Select Create Default Mappings (recommended). If you don’t want to create default mappings and want to create all mappings from scratch by yourself, then uncheck this box.
Provide the API endpoint for your Copper CRM instance. The Copper CRM API URL is the same for all instances and is not instance-based.
Environment URLs:
Test/Sandbox:
https://api.copper.comProduction:
https://api.copper.com
Enter the API Email. This is the email account you use to sign in to Copper CRM.
Enter the API Key you generated in Copper CRM. An API Key is required to subscribe to Copper CRM Webhooks from iPaaS. OAuth may be used for all other types of requests.
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Copper CRM can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the settings.
OAuth 2.0 Flow Initialization requires additional steps.
Operational Configuration – OAuth 2.0 Flow Initialization
To initiate the OAuth 2.0 Flow and generate an access token:
Go to your Copper CRM Subscription Settings.
Click the Authentication icon:
A new browser window opens, requesting permissions for the application.
While logged into Copper CRM, click Authorize when prompted.
Click Close Page.
Refresh the subscription, and the access token value should now be present.
NOTE: The Copper CRM OAuth 2.0 access token is a permanent access token and does not expire. |
You can also confirm the subscription within Copper CRM on the Settings > Integrations > Integrations page under Active Connections.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation:
Data Sync Test
Initiate a sample data pull. (To iPaaS.com)
Initiate a sample data push. (From iPaaS.com)
Functionality Test
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.