Envoy

This documentation for the Envoy integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Envoy, visit our connection instructions.

Version

This integration utilizes the Envoy REST API v1.

Base URL

The base URL used for all Envoy API endpoints:

https://api.envoy.com/v1

---

Authentication & Authorization

The DataGrail Envoy integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Envoy API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The Envoy integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Base	Access	Deletion
token.refresh	✅
employees.read		✅
entries.read		✅
invites.read		✅
invites.write			✅

Base Scopes

All base scopes must be granted in order to connect the integration with DataGrail. The remaining scopes are only required if enabling those capabilities

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/employees	Validate credentials
GET	https://app.envoy.com/a/auth/v0/authorize	Request authorization
POST	https://app.envoy.com/a/auth/v0/token	Get and refresh access token

---

Limits

Limits in Envoy are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Envoy integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search employees by the configured identifiers.
2. Search entries by the configured identifiers.
3. Search invites by the configured identifiers.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/employees	Search employees
GET	/entries	Search entries
GET	/invites	Search invites

---

Deletion

DataGrail's Envoy integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Search invites by the configured identifiers.
2. Delete all selected invites.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/invites	Search invites
DEL	/invites/id	Delete an invite

---