Creating an extended integration for Intercom Admins

Create an integration to sync Intercom Admins with Oomnitza to gain visibility of user data and manage user data. 

Before you start

To easily find the records that are uploaded to Oomnitza, it's best practice to create a dedicated user account for each integration. This will make it easier for you to retrieve the records that are uploaded to Oomnitza from the vendor application. 

Creating integration users 

The name of the global variable is Intercom.Version. The current version  is 2.11

You need the following information to create credentials in Oomnitza and to connect to the vendor application's API:

• Intercom version. 
• API token. Intercom: Authentication.

Adding credentials to Oomnitza

Two modes are available for adding credentials to Oomnitza - basic and advanced. When you add credentials, you search for the vendor application and if it is listed you use the basic mode. If the vendor application isn't listed, you must use the advanced mode.

Using the advanced mode to add credentials

1. Click Configuration > Security > Credentials.
2. Click ADD.
3. Search for Intercom.
4. Click the arrow > next to Intercom Admins user load.
5. Click ADVANCED.  
6. Add the information details.
7. Click the AUTHORIZATION tab.
8. Ensure that API Key is selected as the Authorization type.
9. Ensure that the Token Name is Authorization.
10. Enter Bearer, press the spacebar, and enter the value of your API key.
11. Ensure that Add to Header is selected.
12. Click CREATE.

 Adding credentials to Oomnitza

1. In Oomnitza, click Configuration > Integrations > Overview.
2. Click Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. In the sidebar, search for the integration.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

• User only. Add user records.
• User plus SaaS user. Add user and SaaS user records. 

The benefit of adding SaaS user records is that you can run a workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that can be retrieved depends on whether SaaS user workflows are available for the integration. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Editing the integration details

When you edit the Integration details section, you can select the name or names of integration contacts.  Integration contacts will receive an in-app notification and an email, when the integration fails, when the integration fails to complete within 24 hours, or when the scheduled integration fails to run.

1. Click Edit .
2. Make your changes.

Editing the credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Select Edit integration to add rules for syncing data. Filtering integration results.  
 

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

Custom mappings

Avatar
Away Mode Enabled?
Away Mode Reassign?
Connect: Intercom Version
Connector Sync Time
Email
Has Inbox Seat?
Intercom ID
Job Title
Name
Primary Team IDs
Type

Tracking information

When the integration is run, you can track the sync time and the version. To do this, you map the following fields to Oomnitza:   

• Connect: Intercom Version
• Connector: Sync Time

To do this, you map the fields to custom Oomnitza fields. 

Mapping fields to Oomnitza

1. Right-click the field, and select Add new Oomnitza field.
2. Change the name of the field.
3. Save your changes.

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations