Creating an extended integration for Intercom users

Let Oomnitza be your single source of truth!

You'll get complete visibility of your users as data from Intercom is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and Intercom in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about users with your colleagues and management
• Configurable workflows that you can easily create for: 
  • Retrieving SaaS user roles
  • Offboarding users

Navigation

Add credentials

Create the user integration

Create workflows

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

To stream Intercom user data into Oomnitza, you must add your API connection credentials to the Oomnitza vault.

Useful links

Intercom provides customers with an access token when they create an app in their workspace. To find your access token, go to the Configure> Authentication section in your app in the Developer Hub.

Intercom authentication

Add credentials to the vault in Oomnitza

To authorize connections between Oomnitza and Intercom, complete these steps:

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Add your API key.
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. Add the information details.
2. Click the AUTHORIZATION tab.
3. Ensure that API Key is selected as the Authorization type.
4. Ensure that the Token Name is Authorization
5. Enter Bearer, press the space bar, and enter the value of your API key.
6. Ensure that Add to Header is selected.
7. Click CREATE.

Next

You use the credentials that you added to create and customize your integration with Oomnitza.

Create the user integration

Info and connect details

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

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 .

  Selecting 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. 

Creating custom mappings

Map the Intercom fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Click Smart Mapping to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. Create a custom mapping for the Intercom User ID. Complete the following steps:
   1. Click the down arrow on the ID field.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field to User External ID.
   4. Click CREATE. 
3. Ensure that the Email is mapped to the
   1. Username field on the Oomnitza side (required for integration).
   2. Email field on the Oomnitza side (required for integration).
4. Select the Role field on the Oomnitza mapping side.
5. Choose a suitable role from the list (a defined role is necessary for the integration)
6. Assign a sync key to a unique field, such as the Email.
7. Click UPDATE.

Custom Intercom to Oomnitza mappings

The following Intercom fields can be mapped to Oomnitza:

• Connector Sync Time
• Created at Timestamp
• Email
• Id
• Last seen at Timestamp
• Name
• User's role
• User type

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

Create workflows

SaaS user role

The Intercom SaaS user role information uses the Contacts API to return Intercom role information. The role of the contact can either beuserorlead. See Intercom API Documentation: Contacts API.

Prerequisites

Before you create a SaaS user workflow, you should have already run your extended user integration and selected User plus SaaS User to populate the software entry in the Software > SaaS menu.

Creating the SaaS user workflow

1. Click Configuration > Workflows 
2. Click Add (+) and select Software SaaS Users from the list.
3. Enter the name of the workflow.

Editing the begin block

The begin block is the workflow’s trigger. 

1. Click Edit.
2. Enter the name of the begin block. 
3. Configure the schedule so that the user information is streamed to Oomnitza when your system is least busy.
4. Select run for Active records.
5. Click Add Rule and add this rule: SaaS name = Intercom.
6. Click Save.

Tip
Learn more about the Begin block

Editing the SaaS User Role block

1. Drag and drop the SaaS User Role retrieval block onto the Sandbox, and then click Edit.
2. Search for your SaaS integration, such as Intercom, and click the arrow (>).
3. Supply the required information including your Credentials.
4. By default, the Deactivate User checkbox is selected. This means that if the users listed in SaaS > Intercom > Users do not exist in your SaaS application, they will be deactivated once the workflow is run. 

Connecting the blocks

To complete the workflow, you connect the blocks.

1. Link the boxes as shown in the diagram.
2. Click Save, Validate, and Launch.

Workflow result

Depending on the schedule that you configured in the Begin block, the SaaS user role information is streamed to Oomnitza and presented in the SaaS > Intercom > Users tab.

Delete & Deactivate users 

You can add the API block to a workflow to delete and deactivate users in Intercom.

Add the API block for Intercom

1. Click Configuration > Workflows 
2. Click Add (+) and select Software SaaS Users from the list.
3. Enter the name of the workflow and a description.
4. Edit the Begin block by adding the rules that will trigger the workflow. Make sure the following sections are populated:
   1. Actions: Set the actions to schedule to have it run at a fixed time. Alternatively, you can trigger your workflow to run when a record has been created (Assign User) or deactivated in the SaaS user list (Deactivate user).
   2. Rule criteria: Set a rule to trigger the workflow. For example, you could create a rule to delete a user with the last login date of greater than one year.
5. Drag and drop the API block in the sandbox.
6. Click Edit, and enter Intercom as the search criteria.
7. Select a preset from the list below. To choose a preset, click the forward arrow (>).
   
   • Intercom Delete User
   • Intercom Deactivate User
8. Select the credentials that you created for Intercom.
9. Click SAVE.

Next

Link the blocks together and validate, launch, and save the workflow.

Result
When the workflow is run, the user is deleted or deactivated in Intercom.

SaaS user role workflow

 Workflows section

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

 Getting started