Airbyte connectors
Salesforce

Salesforce

Overview

Setting up the Salesforce source connector involves creating a read-only Salesforce user and configuring the Salesforce connector through the Y42 UI.

This page guides you through the process of setting up the Salesforce source connector.

Features

FeatureSupportedNotes
Full Refresh SyncYes
Incremental SyncYes

Getting started

Requirements

Setting up the Salesforce source

  1. (Optional, Recommended) Create a read-only Salesforce user.

    To create a dedicated read only Salesforce user:

    1. Log into Salesforce (opens in a new tab) with an admin account.
    2. On the top right of the screen, click the gear icon and then click Setup.
    3. In the left navigation bar, under Administration, click Users > Profiles. The Profiles page is displayed. Click New profile.
    4. For Existing Profile, select Read only. For Profile Name, enter Y42 Read Only User.
    5. Click Save. The Profiles page is displayed. Click Edit.
    6. Scroll down to the Standard Object Permissions and Custom Object Permissions and enable the Read checkbox for objects that you want to replicate via Y42.
    7. Scroll to the top and click Save.
    8. On the left side, under Administration, click Users > Users. The All Users page is displayed. Click New User.
    9. Fill out the required fields:
      1. For License, select Salesforce.
      2. For Profile, select Y42 Read Only User.
      3. For Email, make sure to use an email address that you can access.
    10. Click Save.
    11. Copy the Username and keep it accessible.
    12. Log into the email you used above and verify your new Salesforce account user. You'll need to set a password as part of this process. Keep this password accessible.

  2. Set up Salesforce as a Source

    1. Create a new Source of type Salesforce (Airbyte)
    2. Add a new secret (or use an existing one).
      • Toggle whether your Salesforce account is a Sandbox account (opens in a new tab) or a production account.
      • For Start Date, enter the date in YYYY-MM-DD format. The data added on and after this date will be replicated. If this field is blank, Y42 will replicate the data for last two years.

Performance considerations

The Salesforce connector is restricted by Salesforce’s Daily Rate Limits (opens in a new tab). The connector syncs data until it hits the daily rate limit, then ends the sync early with success status, and starts the next sync from where it left off. Note that picking up from where it ends will work only for incremental sync, which is why we recommend using the Incremental Sync.

Supported Objects

The Salesforce connector supports reading both Standard Objects and Custom Objects from Salesforce. Each object is read as a separate stream. See a list of all Salesforce Standard Objects here (opens in a new tab).

Y42 fetches and handles all the possible and available streams dynamically based on:

  • If the authenticated Salesforce user has the Role and Permissions to read and fetch objects

  • If the stream has the queryable property set to true. Y42 can fetch only queryable streams via the API. If you don’t see your object available via Y42, check if it is API-accessible to the Salesforce user you authenticated with in Step 2.

Note: BULK API (opens in a new tab) cannot be used to receive data from the following streams due to Salesforce API limitations. The Salesforce connector syncs them using the REST API which will occasionally cost more of your API quota:

  • AcceptedEventRelation
  • Attachment
  • CaseStatus
  • ContractStatus
  • DeclinedEventRelation
  • FieldSecurityClassification
  • KnowledgeArticle
  • KnowledgeArticleVersion
  • KnowledgeArticleVersionHistory
  • KnowledgeArticleViewStat
  • KnowledgeArticleVoteStat
  • OrderStatus
  • PartnerRole
  • RecentlyViewed
  • ServiceAppointmentStatus
  • ShiftStatus
  • SolutionStatus
  • TaskPriority
  • TaskStatus
  • UndecidedEventRelation
S3Shopify