Integrations
Last updated
Last updated
Polarity integrations connect to third-party data sources and provide real-time awareness of information relevant to recognized entities. Community Edition users can subscribe to any number of available integrations when setting up their Polarity client.
These settings can be edited directly via the Overlay Window, by navigating to the Advanced Settings Page or via the Polarity website using your web browser.
On the integrations page you will see all integrations that have been installed on your server.
Each integration row contains the following information and actions:
Integration Name -The integration name is color-coordinated with the color that you have selected for the integration.
Integration Description - Brief description of what the integration does.
Color Picker & Identifier - The Color picker allows you to select a color to represent the integration. An abbreviated version of the integration name is used as an identifier. This same abbreviation is displayed in the Polarity Overlay along with the chosen color.
Subscription Status -This toggle represents subscription status and allows to you subscribe/unsubscribe from an integration by clicking on it.
You can subscribe to and unsubscribe from integrations directly from the Overlay or from the Integrations page of the web browser interface by toggling the On/Off subscribe button.
If you are unsubscribed from an integration you will not receive notifications for it.
You can change an Integration's colors directly from the Overlay or from the Integrations page of the web browser interface.
The color set for an integration will be the color displayed for its notifications that show up in the Polarity Overlay or onscreen highlights.
Select the appropriate color from the drop-down menu to change the Integration color.
Some Integrations require specific configurations such as an API Key, a Username/Password, or a hostname/URL.
Required options can vary depending on the integration. If an integration is missing required options, you cannot be subscribed to the integration.
To configure an integration, navigate to the integrations tab of the Overlay window and click on the green gear icon next to the integration. Alternatively, you can navigate to the Integrations in the Advanced Settings Page or via your web browser interface and click on the Settings button for the appropriate integration.
Once you have made the necessary configurations, click the Apply Changes button to save the changes.
Users can manage which entity types an integration receives.
For example, even if an integration supports recognition for IPv4 and Emails you can set it to only receive IPv4 addresses using the Manage Integration Data option.
The types of data an integration can receive is dependent on the integration itself.
To manage integration data:
In the Overlay, click on the green gear Settings icon for the desired integration
Under Manage Integration Data click the Click Here button. This shows all entity types that the integration supports and which entity types the integration is currently receiving.
This page is only available via the the Advanced Settings page.
To view the integration metrics click on the Metrics button located at the top of the main integration page.
Here you will be able to see the health statistics of your installed integrations measured using Response Time in Seconds. This information is useful for troubleshooting integration issues as it lets you know how well an integration is communicating with our servers.
