Using The Polarity Developer Guide

About this Guide‌

This guide teaches you about how the Polarity integration framework works and gives you the tools to build your own custom integrations.

Other Available Guides‌

If this guide is not what you're looking for, we also have two other guides that may be helpful:‌

  1. The Polarity Enterprise Guide - Focuses on everything you need to know to install, configure, use, and customize Polarity Enterprise.

  2. ​The Polarity Community Edition Guide - Focuses on everything you need to know to install, configure, use and customize Polarity Community Edition.

For a list of changes, deprecations, and new features please see the the What's New page.

The Polarity Integration Framework

The Polarity Integration Framework gives you the tools to build your own custom integrations. Integrations can connect to existing data to increase your data awareness as well as interact with existing tools to streamline your workflows.

There are three steps to building an integration:

  1. Define the type of data you wish to recognize in a user's active application window.

  2. Choose what to do with the recognized data. Typically you will enrich or transform the recognized data to create relevant contextual intelligence.

  3. Decide how you want to display the contextual intelligence.

If this is your first time writing a Polarity integration we suggest starting with the Quick Start Guide which will walk you through creating your first integration.

Last updated