Instance API Key

The Instance API Key enables you to securely integrate your Instance with external systems by acting as the digital credential for trusted third-party applications. This feature allows authorized systems to create, read, and update core data in your Instance entirely without human intervention, ensuring the seamless synchronization of essential records across your tech stack. For example, suppose a customer completes an action on a separate, legacy database. In that case, that system can instantly use the Instance API Key to automatically create or update a customer record in your Insites CRM, eliminating manual data entry and ensuring all sales and support teams have immediate, up-to-date information.

The following topics are included in this document:

• Regenerating the Instance API Key
• Retrieving the Instance API Key

Regenerating the Instance API Key

The ability to regenerate the Instance API Key enables robust security and risk management. It allows you to instantly revoke access from unauthorized users if a key is exposed or compromised. Additionally, API key regeneration supports proactive key rotation to minimize exploit exposure time and is necessary for effectively managing access control when team members or contractors leave the organization.

To regenerate the Instance API Key:

1. Navigate to Integrations from the main menu.
2. Select Instance API Key.
3. Select EDIT.
4. Select GENERATE KEY.

Retrieving the Instance API Key

To retrieve the Instance API Key

1. Navigate to Integrations from the main menu.
2. Select Instance API Key.
3. Select 'Copy' () on the field displaying the Instance API Key.
4. You can now use the Instance API key on a third-party system.