Security

Access to RIH - Required Roles

To access RIH, you must have one of the following roles. Please contact your customer administrator to request either:

• ROLE_INTEGRATION_SPECIALIST, or
• ROLE_INTEGRATION_CUSTOMER_ADMIN.

On-Demand Users - Required Roles

To interact with ZoomInfo enrichment buttons on Organization or Individual profile pages, you'll need one of the following roles:

• ROLE_ZOOMINFO_CONNECTOR,
• ROLE_USER_RIH_INVOKER,
• ROLE_API, or
• an equivalent custom role.

Client Credential - Required Scope

A dedicated Client Credential is recommended for data extraction and writing back to the customer tenant. It's mandatory that you have assigned the ROLE_API.

Note: If metadata security is enabled for the tenant, the client credential must include additional scopes with permissions to CREATE/READ/UPDATE/DELETE/MERGE/UNMERGE for the Organization, Individual, and Location entity types. Additionally, these permissions must apply to the following relationships: ZoomInfoHierarchy, OrganizationHasAddress, and IndividualEmployer.

Example configuration:

   "clientId": "ZoomInfo_Enrichment_Process",
   "scope": [
      "ROLE_API",
      "CUSTOM_ROLE_WITH_METADATA_PERMISSIONS"
   ],
   "authorities": [],
   "resourceIds": [],
   "authorizedGrantTypes": [
      "client_credentials"
   ],
   "clientDescription": "Used in Clients' tenant for ZoomInfo Enrichment",
   "clientName": "Client",
   "clientEmail": "email@email.com",
   "redirectUri": [],
   "accessTokenValidity": 3600,
   "refreshTokenValidity": null,
   "clientAuthenticationMethods": [
      "client_secret_post",
      "client_secret_basic"
   ],
   "enabled": true
}

Key-Rotation

If these credentials or tokens are rotated, take the following action:

Rotated key/token	Action Required
Rotated Key/Token	Update in Connections
ZoomInfo Password
Client Credential Secret
SQS Secret
IAM Policy

If you've rotated API Platform client authentication tokens, ensure you update the RIH Profile and/or any calling applications as necessary. To update the RIH Profile you'll need to raise a support ticket. For more information, see topic Get help in Support Portal.

Configurable Enrichment and Environment Properties

The pre-built integration offers configurable settings within the ZoomInfo Recipe Properties lookup table and Environment Properties. These settings can be adjusted to meet business needs, such as modifying confidence code thresholds for automatic vs. suspect matches. Additionally, export filter criteria for batch mode can be customized, along with other options.

Job Observability

How to Monitor Job Status

Batch processing

Upon submission of a batch file, you'll receive an email notification with details like the number of Reltio entities exported and ZoomInfo jobs submitted.

Once the process completes, job statuses will be updated in the ZoomInfo Job Execution Statistics lookup table, accompanied by an email notification.

Error Logs

If you receive an error message in the email notification or Error Logs field, check the ZoomInfo Logs lookup table for detailed information.

Email notification example:

ZoomInfo Logs lookup table example:

Real-Time and On-Demand processing

Once the Recipe jobs are completed, the job status will be updated in the ZoomInfo Job Execution Statistics lookup table, and email notifications are sent. The processing mode determines how the status is displayed in both the statistics table and the email.

Access to Detailed Logs and Statistics

In the event of an error, users can check the ZoomInfo Logs lookup table for detailed logs and error messages related to the job. Job statistics will be recorded and stored in the ZoomInfo Job Execution Statistics lookup table for each job.

ZoomInfo Logs example:

ZoomInfo Job Execution Statistics example:

Email Notification(s)

After a job is completed, an email is sent to the addresses listed in the Email Notification property in the ZoomInfo Recipe Properties lookup table. The email includes details such as: date, filter, stats, processing mode, and duration. You can add multiple email addresses to receive notifications with job stats, and other information.

RIH Recipe Tasks

To view recipe task count information, go to the Dashboard menu in RIH. The details are displayed based on the filter you apply, as shown in the screenshot below:

Enable or Disable Enrichment Modes

Make sure you configure the necessary modes of operation correctly.

Near Real-Time mode

ZoomInfo | TRG | Real Time Enrichment - AWS SQS

Start or stop this recipe to enable or disable job triggering. Jobs will automatically trigger when records are created or updated for the Organization entity (or based on the Type filter in the SQS streaming destination).

ZoomInfo | TRG | Real Time Contact Enrichment - AWS SQS

Start or Stop this recipe. Jobs will be triggered when records are Created or Updated for Individual Entity (or based on the Type filer on the SQS streaming destination).

On-Demand mode

ZoomInfo | TRG | Real Time Enrichment - API Trigger

Start or stop this recipe. Jobs will be triggered when the On-Demand buttons are used on the Organization Entity profile page.

Contact ZoomInfo | TRG | Real Time Enrichment - API Trigger

Start or stop this recipe. Jobs will be triggered when the On-Demand buttons are used on the Individual Entity profile page.

Batch mode

ZoomInfo | TRG | Company - Scheduler for Batch Enrichment

Start or stop the recipe. Organization Data will be exported based on the defined Export Filter recipe property and sent to ZoomInfo for enrichment.

Trigger jobs by scheduling Cron expressions using a Custom schedule, or by selecting Daily, Weekly, or Monthly from the Time Unit dropdown.

ZoomInfo | TRG | Company - Process ZoomInfo Trigger Recipe

Start or stop the recipe. When an Enriched Company file is placed in ZoomInfo Outbound File path, the job will be triggered automatically. After job is started this recipe will be stopped and once all process is completed, then this recipe will be started.

ZoomInfo | TRG | Contact - Scheduler for Batch Enrichment

Start or stop the recipe. Individual data will be exported based on the defined Export Filter recipe property and sent to ZoomInfo for enrichment.

Trigger jobs by scheduling Cron expressions using a Custom schedule, or by selecting Daily, Weekly, or Monthly from the Time Unit dropdown.

Enable or Disable API Endpoints

To manage API endpoints, follow these steps:

1. Navigate to Tools > API Platform
2. Navigate to API collections
3. Select ZoomInfo Rest API Collections.
4. Choose either ZoomInfo | API | REST API for Batch Enrichment or ZoomInfo | API | Real Time Enrichment - REST API.
5. Activate or deactivate the endpoints as needed.

External Applications / Manual API Requests

Use the Near Real-Time and Batch by making requests through external applications or or manually through an API client. To do this, generate an authorization token and include it with the correct API parameters.

Create an access token for APIs

To create an access token for using the APIs, follow these steps:

1. Go to Tools > API Platform
2. Navigate to Clients and select +New Client
3. Name the client (e.g., API Client) and select Add Client.
4. Select the new client and select +Create access profile.
5. Name the profile and select the ZoomInfo REST API Collections for API collections to include. Select Authentication method Auth Token. Optionally, configure IP whitelisting.
6. Select Save.

Store and share the Auth token as needed.

ZoomInfo | TRG | Near Real-Time Enrichment - API Trigger

Use the below endpoints to trigger the Near Real-Time Enrichment via REST API:

Request URL

Method	URL
POST	https://apim.workato.com/xxxxxxxxxxxx/zoominfo-rest-api-vv1/company-real-time-enrichment?doNotMerge={{flag}}&entityURI={{entityURI}}

Required Headers

Key	Value
api-token	Auth Token
Content-Type	application/json

Required Parameters

Key	Value
doNotMerge	If the flag is 'true', the match record will be created as a potential match. If the flag is 'false' the match record will be created based on the confidence code. By default, 'false' will be selected if this property is left blank.
entityURI	The Entity ID of Reltio Profile which must be enriched.

Contact ZoomInfo | TRG | Real Time Enrichment - API Trigger

Use the below endpoints to trigger the Near Real-Time Enrichment via REST API.

Request URL

Method	URL
POST	https://apim.workato.com/xxxxxxxxxxx/zoominfo-rest-api-vv1/contact-real-time-enrichment?doNotMerge={{flag}}&entityURI={{entityURI}}

Required Headers

Key	Value
api-token	Auth Token
Content-Type	application/json

Required Parameters

Key	Value
doNotMerge	If the flag is 'true', the match record will be created as a potential match. If the flag is 'false' the match record will be created based on the confidence code. By default, 'false' will be selected if this property is left blank.
entityURI	The Entity ID of Reltio Profile which must be enriched.

ZoomInfo | API | Company - Batch Enrichment API Trigger for Batch Enrichment

Use the below endpoints to trigger the Batch Enrichment via REST API.

Request URL

Method	URL
POST	https://apim.workato.com/xxxxxxxxxxxx/zoominfo-rest-api-vv1/company-batch-enrichment?filter={{filter}}&doNotMerge={{flag}}

Required Headers

Key	Value
api-token	Auth Token
Content-Type	application/json

Required Parameters

Key	Value
Filter	Populate the Reltio attributes/audit-based filter, to enrich the filtered dataset.
doNotMerge	True or false. If the flag is 'true', the match record will be created as a potential match. If the flag is 'false' the match record will be created based on the confidence code. By default, 'false' will be selected if this property is left blank.

ZoomInfo | API | Contact - Batch Enrichment API Trigger for Batch Enrichment

Use the below endpoints to trigger the Batch Enrichment via REST API.

Request URL

Method	URL
POST	https://apim.workato.com/xxxxxxxxxxxx/zoominfo-rest-api-vv1/contact-batch-enrichment?filter={{filter}}&doNotMerge={{flag}}

Required Headers

Key	Value
api-token	Auth Token
Content-Type	application/json

Required Parameters

Key	Value
Filter	Populate the Reltio attributes/audit-based filter, to enrich the filtered dataset.
doNotMerge	True or false. If the flag is 'true', the match record will be created as a potential match. If the flag is 'false' the match record will be created based on the confidence code. By default, 'false' will be selected if this property is left blank.