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 such as: 
  • Workflows for deactivating and deleting Intercom users
  • Workflows for getting a SaaS user's role and deactivating SaaS users in Oomnitza

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. Log into Oomnitza.
2. Click Configuration > Security > Credentials, and then click Add new credential (+).
3. Add the information details.
4. Click the AUTHORIZATION tab.
5. As authorization type, select API Key.
6. Enter Authorization as the token name.
7. Enter Bearer, press the space bar, and enter the value of your API key.
8. Ensure that Add to Header is selected.
9. 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. From the menu, click Configuration > Integrations.
2. Click Integrations List View .
3. On the Integrations page, scroll down to the Extended section for User Integrations.
4. Click NEW INTEGRATION.
5. In the New User Integration sidebar, click Intercom.
6. Click APPLY and then click NEXT twice.

Connect page

Best practice
To ensure that only live user records are streamed to Oomnitza, choose Update only as your integration preference. When you run the integration, you can check the error logs to see which user records weren't uploaded and why they weren't uploaded. You can then decide whether to upload the user records that were skipped by changing your integration preference to create and upload. See Access error logs.

1. Enter a descriptive name for the integration such as Intercom Users. That'll be the name of the user integration that is shown on the Integrations page.
2. From the User Selection list, select User plus SaaS User or User only.
3. If you select User plus SaaS User and you have multiple instances of the same SaaS application, select the application from the SaaS Selection list. If you have a single instance of the SaaS application, skip this step.
4. From the installation type list, select Cloud.
5. From the Credentials list, select your credentials.
6. From the Integration Preferences list, select Update only.   
7. Enter the name of the user of the integration.
8. Click Next.

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 MAPPINGS.
2. Create custom mappings to map the Intercom fields that you want to add to Oomnitza:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field. For example, you can change the name of the Name field to Intercom Name.
   4. Click CREATE. 
3. Assign an Oomnitza role to the users such as Employee.
4. Assign a sync key to one of the fields such as the Email field.
5. Click NEXT.   

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

Want to map more fields to Oomnitza?
Contact Support, or see Mapping extended connectors.

When you've completed mapping the Intercom to Oomnitza fields, click NEXT.

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Configure your schedule.
2. Click FINISH.

Result

A new tile is created for the integration on the Integrations page. 

What to do next

If you want to see the information that is collected now, click the tile on the Integrations page and click RUN.

Figure: Mock-up for illustration purposes

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings. 

Create workflows

To reduce your workload and automate complex and repetitive tasks, you can use the following API presets:   

• Intercom Deactivate User
• Intercom Delete User

1. From the menu, click Configuration > Workflows > SaaS Users.
2. Click Add (+). The Begin and End blocks are automatically added to the sandbox.
3. Enter the name and a description of the workflow. 
4. Edit the Begin block by choosing a schedule and adding the rules that will trigger the workflow. For example, add the rule Name equals Intercom, and a rule to trigger the workflow.
5. Click the Blocks tab, and  drag and drop the API block onto the canvas.
6. Click the Edit button.
7. Enter Intercom in the search field and and choose one of the following presets:
   • Intercom Deactivate User
   • Intercom Delete User
8. Click SAVE.
9. Connect the blocks.
10. Validate, launch, and save your workflow.

Use the SaaS User Role Retrieval block to deactivate users

1. From the menu, click Configuration > Workflows > SaaS Users.  
2. Click Add workflow (+).  The Begin and End blocks are automatically added to the canvas.
3. Enter the name of the workflow and a description.
4. Edit the Begin block.
   • Create a schedule for running the workflow.
   • Use a rule to identify the SaaS software 
   • Add rules to trigger the workflow . For example, you can add a rule to deactivate users who haven't logged in for a number of days. 
5. From the Integrations section, drag and drop the SaaS User Role Retrieval block onto the canvas.
6. Edit the SaaS User Role Retrieval block.
   1. To find the preset, type Intercom.
   2. Click the right arrow (>) next to Intercom SaaS User Role.
   3. Select your credentials. By default, the Deactivate User checkbox is selected. 
7. Connect the workflows.
8. Validate, save, and launch the workflow.

Result

If Deactivate is enabled, the SaaS users who aren't found in Intercom are deactivated in Oomnitza.

SaaS user role workflow

 Understanding workflows

 Workflow block overview 

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