Integrating Envoy

Capabilities

DataGrail's Envoy integration provides the following capabilities:

Product	Capability
Request Manager	Request Types Access, Deletion Identifier Categories Email

Before You Start

To successfully configure this integration, please ensure you have sufficient privileges:

• DataGrail User Role: Super Admin, Connections Manager
• Envoy User Role: Admin

Create Envoy API Credentials

1. Log in to Envoy.
2. In the menu under Apps, select Dev Dashboard.
3. Select Create New and enter the following information:

Application Configuration

App Name: DataGrail (You can use any value)

Category: Build your own

API Scopes:

• employees.read
• entries.read
• invites.read
• invites.write
• token.refresh

Externally using OAuth2: enabled (checked)

Domain: https://datagrail.io

Redirect URL: https://datagrail.io/oauth/envoy

4. Select Save.
5. Copy the newly created Client ID and Client Secret. Store them in a secure, temporary location.
6. In the menu, navigate to Apps.
7. Select the My custom apps tab.
8. For the newly created App, select Install and wait for the successfully installed pop-up message.

Connect to DataGrail

1. In DataGrail, navigate to Integrations and select Configure New Integration to search for Envoy.
2. Enter the Client ID and Client Secret.
3. Select Login to Configure.

Next Steps

Now that you've successfully connected the integration, check out the following resources:

• Access Request Lifecycle
• Deletion Request Lifecycle
• Request Manager Overview
• Customizing Intake Forms

Troubleshooting

If you are unable to successfully connect the integration, review these common troubleshooting steps:

Ensure Required Permissions Are Granted on API Keys/Resources

DataGrail checks required permissions and scopes on API keys/resources used by each integration. If all necessary permissions are not granted, new connections will fail.

Review Required Account Types and User Roles

If users do not have the necessary permissions or the minimum required user role in the connecting system, the connection to DataGrail will fail. Additionally, connections will fail if your account type does not match the one required by the integration.

See Before You Start to review these requirements.

Technical Details

The Envoy integration uses the REST API v1:

Access Type	Synchronous
Deletion Type	Synchronous

API Documentation

Learn more about this API implementation and DataGrail functionality in our API Integration Documentation.