Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Salesforce Service Cloud

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

Version

This integration utilizes the Salesforce Service Cloud REST API v49.0.

Base URL

The base URL used for all Salesforce Service Cloud API endpoints contains the Instance URL:
https://INSTANCE_URL.salesforce.com/services/data/v49.0

Endpoints Utilized

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


Authentication & Authorization

The DataGrail Salesforce Service Cloud 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 Salesforce Service Cloud API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Limits

Limits in Salesforce Service Cloud 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 Salesforce Service Cloud 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 Contacts by configured identifiers.
  2. Fetch associated objects for each of the found Contacts. By default, search for Account, Cases, Events, Opportunities and Tasks, but this list can be extended through configuration by DataGrail Support (support@datagrail.io).
  3. Search Leads by configured identifiers.
  4. Search Campaigns by configured identifiers.
  5. Retrieve records for each of the Contacts, Leads and Campaigns objects by the specified object ID.

Endpoints Utilized

MethodEndpointPurposeDocs
POST/parameterizedSearchExecute parameterized search
GET/sobjects/Campaign/object_idRetrieve Campaigns
GET/sobjects/Contact/object_idRetrieve Contacts
GET/sobjects/Contact/object_id/CasesRetrieve Cases
GET/sobjects/Contact/object_id/EventsRetrieve Events
GET/sobjects/Contact/object_id/OpportunitiesRetrieve Opportunities
GET/sobjects/Contact/object_id/TasksRetrieve Tasks
GET/sobjects/Contact/object_id/accountRetrieve Account
GET/sobjects/Lead/object_idRetrieve Leads

Deletion

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

Data Interactions

For Deletion requests, DataGrail will take the following actions:

  1. Run all data access steps to find objects that can be deleted (See Access).
  2. Delete associated contact objects, if any. By default, delete only Cases, Events, Opportunities and Tasks, but this list can be extended through configuration by DataGrail Support (support@datagrail.io).
  3. DataGrail utilizes deletion and anonymization, depending on the contact type:
  • Deletion for the regular contacts.
  • Anonymization for the personal account contacts.
  1. Delete contact sub-objects or do sub-objects anonymization.
  • By default, delete Cases, Events, Opportunities and Tasks, but this list can be extended through configuration by DataGrail Support (support@datagrail.io).
  • By default, anonymize dependent objects Cases and Tasks, but this list can be extended through configuration by DataGrail Support (support@datagrail.io).
  1. Delete or anonymize the Contact.
  2. Delete a Lead.

Endpoints Utilized

MethodEndpointPurposeDocs
PATCH/sobjects/Cases/object_idAnonymize Cases
DEL/sobjects/Cases/object_idDelete Cases
PATCH/sobjects/Contact/object_idAnonymize Contacts
DEL/sobjects/Contact/object_idDelete Contacts
DEL/sobjects/Events/object_idDelete Events
DEL/sobjects/Lead/object_idDelete Leads
DEL/sobjects/Opportunities/object_idDelete Opportunities
PATCH/sobjects/Tasks/object_idAnonymize Tasks
DEL/sobjects/Tasks/object_idDelete Tasks

 

Need help?
If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.