Ada

Authentication & Authorization

Credentials

• Ada APIs use API keys for authorization.

• You can generate self-serve tokens through the Ada dashboard (see the DataGrail Help Docs).

• These tokens do not expire and are invalidated if you generate a new one.

• Publicly exposing your API credentials can allow unauthorized access to the Ada API endpoints, and your Ada data by a third party. DataGrail stores your API credentials encrypted and protected.

Base URL

Base URL consists of the Subdomain and API URL:

• https://{SUBDOMAIN}.ada.support/api/v2

Example of BASE URL:

• https://your-subdomain.ada.support/api/v2

Subdomain can be identified from the account's URL (see the DataGrail Help Docs).

Endpoints Utilized

DataGrail uses the following endpoint to validate that credentials are good based on a successful response:

Get all conversations:

• GET {BASE_URL}/export/conversations

Version

DataGrail integration currently supports Ada API version 2 (v2).

Limits

DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

Access

For an access request, DataGrail will take the following actions:

• Returns a list of conversation objects.

• Select conversations related to the requested person using Data Subject email or Service ID for the filtering. Service ID is used as the “chatter_id” in Ada system.

• For all objects found, DataGrail will return all available fields. You can edit which objects and fields you want to provide to the Data Subject via our Portal Requests.

DataGrail also supports the Direct Contact Access workflow for Ada.

Endpoints Utilized

• GET {BASE_URL}/export/conversations

Deletion

For a deletion request, DataGrail will take the following actions:

• Submit a Bulk End-User Deletion request by email and Service ID using Subject Identifiers.

• Poll the returned deletion job until Ada reports it as complete. It may take up to 30 days for downstream erasure to complete.

DataGrail also supports the Direct Contact Deletion workflow for Ada.

Endpoints Utilized

• POST {BASE_URL}/end-users/delete
• GET {BASE_URL}/jobs/{JOB_ID}