Event Stream API Key

Insites enables you to integrate your Instance's Event Stream with third-party systems using the Event Stream API Key. This feature allows you to publish a real-time, continuous stream of data about events (such as user logins, record updates, or custom activity logs) to other applications.

This capability allows you to update external systems about changes on your Instance without polling the API, reducing the load on your core database and operational API and improving the performance and stability of your Instance. You can also ensure that every connected system operates on the absolute latest information, eliminating delays and data inconsistencies often found with scheduled batch syncs.

This feature's data consistency allows easy integration with specialized services like data lakes (e.g., AWS Kinesis, Google Cloud Pub/Sub) or dedicated Business Intelligence platforms for highly advanced reporting, trend analysis, and predictive modeling.

Furthermore, Event Stream integration via API enables real-time automation and a decoupled architecture. You can easily connect external services that instantly fire off notifications, such as triggering a Slack message or a Salesforce task the moment a new lead is created in your Instance. More broadly, this flexible, decoupled architecture allows you to create entirely new features or microservices—like a specialized reporting engine—that can react to existing system events without requiring any complex changes or reconfigurations to the core Insites Instance itself.

Integrating the Event Stream to your external systems is a strategic move that turbocharges your Instance by turning it into a real-time data source. The integration optimizes performance, powers advanced analytics and automation across your tech stack, and enables external services to trigger instant actions without requiring code changes to the Insites application itself.

This article includes the following topics:

• Regenerating the Event Stream API key
• Using the Event Stream API key

Regenerating the Event Stream API key

Insites enables you to regenerate the Event Stream API Key for security and risk management. You can instantly revoke access to the system if a key is accidentally exposed (e.g., posted on a public site) or potentially compromised, immediately cutting off any unauthorized users. Furthermore, key regeneration facilitates proactive security hygiene through regular key rotation, dramatically limiting the time window an attacker has to exploit a stolen credential, and is crucial for access control when team members or contractors who once held the key leave the organization.

To regenerate the Event Stream API key:

1. Navigate to Integrations from the main menu.
2. Select Event Stream API Key.
3. Select REGENERATE API KEY.
4. Finalize the Event Stream API Key regeneration using the confirmation modal.

Retrieving the Event Stream API key

To retrieve the Event Stream API key so that you can use it on a third-party system:

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