Salesforce

Configuration

Salesforce source connector integrates with the Salesforce REST API to extract CRM data.

Synchronizes comprehensive data from your Salesforce org including:

Accounts (companies, organizations)
Contacts (people, leads)
Opportunities (deals, sales prospects)

It provides access to all major Salesforce objects with proper OAuth2 authentication.

View Source Code

Explore the Salesforce connector implementation

Authentication

This connector uses OAuth 2.0 with custom credentials. You need to provide your OAuth application’s Client ID and Client Secret, then complete the OAuth consent flow.

OAuth Setup Required

Create an OAuth application in your provider’s developer console
Enter your Client ID and Client Secret when configuring the connection
Complete the OAuth consent flow

Configuration Options

The following configuration options are available for this connector:

Configuration Parameters

Salesforce configuration schema.

instance_url

strRequired

Your Salesforce instance domain only (e.g. ‘mycompany.my.salesforce.com’)

Data Models

The following data models are available for this connector:

SalesforceAccountEntity

Schema for Salesforce Account entities.

https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm

Field	Type	Description
name	Optional[str]	Account name
account_number	Optional[str]	Account number
website	Optional[str]	Account website URL
phone	Optional[str]	Account phone number
fax	Optional[str]	Account fax number
industry	Optional[str]	Account industry
annual_revenue	Optional[float]	Annual revenue
number_of_employees	Optional[int]	Number of employees
ownership	Optional[str]	Account ownership type
ticker_symbol	Optional[str]	Stock ticker symbol
description	Optional[str]	Account description
rating	Optional[str]	Account rating
parent_id	Optional[str]	ID of parent account
type	Optional[str]	Account type
billing_street	Optional[str]	Billing street address
billing_city	Optional[str]	Billing city
billing_state	Optional[str]	Billing state/province
billing_postal_code	Optional[str]	Billing postal code
billing_country	Optional[str]	Billing country
shipping_street	Optional[str]	Shipping street address
shipping_city	Optional[str]	Shipping city
shipping_state	Optional[str]	Shipping state/province
shipping_postal_code	Optional[str]	Shipping postal code
shipping_country	Optional[str]	Shipping country
created_date	Optional[datetime]	Date and time when the account was created
last_modified_date	Optional[datetime]	Date and time when the account was last modified
last_activity_date	Optional[datetime]	Date of the last activity on the account
last_viewed_date	Optional[datetime]	Date when the account was last viewed
last_referenced_date	Optional[datetime]	Date when the account was last referenced
is_deleted	bool	Indicates whether the account has been deleted
is_customer_portal	bool	Indicates whether this account has customer portal access
is_person_account	bool	Indicates whether this is a person account
jigsaw	Optional[str]	Data.com ID
clean_status	Optional[str]	Clean status from Data.com
account_source	Optional[str]	Source of the account
sic_desc	Optional[str]	SIC description
duns_number	Optional[str]	D-U-N-S number
tradestyle	Optional[str]	Tradestyle
naics_code	Optional[str]	NAICS code
naics_desc	Optional[str]	NAICS description
year_started	Optional[str]	Year the account was started
metadata	Dict[str, Any]	Additional metadata about the account

SalesforceContactEntity

Schema for Salesforce Contact entities.

https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm

Field	Type	Description
first_name	Optional[str]	Contact’s first name
last_name	Optional[str]	Contact’s last name
name	Optional[str]	Full name (computed field)
email	Optional[str]	Contact’s email address
phone	Optional[str]	Contact’s phone number
mobile_phone	Optional[str]	Contact’s mobile phone number
fax	Optional[str]	Contact’s fax number
title	Optional[str]	Contact’s job title
department	Optional[str]	Contact’s department
account_id	Optional[str]	ID of the associated account
lead_source	Optional[str]	Source of the lead
birthdate	Optional[datetime]	Contact’s birthdate
description	Optional[str]	Contact description
owner_id	Optional[str]	ID of the user who owns the contact
created_date	Optional[datetime]	Date and time when the contact was created
last_modified_date	Optional[datetime]	Date and time when the contact was last modified
last_activity_date	Optional[datetime]	Date of the last activity on the contact
last_viewed_date	Optional[datetime]	Date when the contact was last viewed
last_referenced_date	Optional[datetime]	Date when the contact was last referenced
is_deleted	bool	Indicates whether the contact has been deleted
is_email_bounced	bool	Indicates whether emails to this contact bounce
is_unread_by_owner	bool	Indicates whether the contact is unread by the owner
jigsaw	Optional[str]	Data.com ID
jigsaw_contact_id	Optional[str]	Data.com contact ID
clean_status	Optional[str]	Clean status from Data.com
level	Optional[str]	Contact level
languages	Optional[str]	Languages spoken
has_opted_out_of_email	bool	Indicates whether the contact has opted out of email
has_opted_out_of_fax	bool	Indicates whether the contact has opted out of fax
do_not_call	bool	Indicates whether the contact should not be called
mailing_street	Optional[str]	Mailing street address
mailing_city	Optional[str]	Mailing city
mailing_state	Optional[str]	Mailing state/province
mailing_postal_code	Optional[str]	Mailing postal code
mailing_country	Optional[str]	Mailing country
other_street	Optional[str]	Other street address
other_city	Optional[str]	Other city
other_state	Optional[str]	Other state/province
other_postal_code	Optional[str]	Other postal code
other_country	Optional[str]	Other country
assistant_name	Optional[str]	Assistant’s name
assistant_phone	Optional[str]	Assistant’s phone number
reports_to_id	Optional[str]	ID of the contact this contact reports to
email_bounced_date	Optional[datetime]	Date when email bounced
email_bounced_reason	Optional[str]	Reason why email bounced
individual_id	Optional[str]	ID of the associated individual
metadata	Dict[str, Any]	Additional metadata about the contact

SalesforceOpportunityEntity

Schema for Salesforce Opportunity entities.

https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm

Field	Type	Description
name	Optional[str]	Opportunity name
account_id	Optional[str]	ID of the associated account
amount	Optional[float]	Opportunity amount
close_date	Optional[datetime]	Expected close date
stage_name	Optional[str]	Sales stage
probability	Optional[float]	Probability percentage
forecast_category	Optional[str]	Forecast category
forecast_category_name	Optional[str]	Forecast category name
campaign_id	Optional[str]	ID of the associated campaign
has_opportunity_line_item	bool	Indicates whether the opportunity has line items
pricebook2_id	Optional[str]	ID of the associated pricebook
owner_id	Optional[str]	ID of the user who owns the opportunity
created_date	Optional[datetime]	Date and time when the opportunity was created
last_modified_date	Optional[datetime]	Date and time when the opportunity was last modified
last_activity_date	Optional[datetime]	Date of the last activity on the opportunity
last_viewed_date	Optional[datetime]	Date when the opportunity was last viewed
last_referenced_date	Optional[datetime]	Date when the opportunity was last referenced
is_deleted	bool	Indicates whether the opportunity has been deleted
is_won	bool	Indicates whether the opportunity is won
is_closed	bool	Indicates whether the opportunity is closed
has_open_activity	bool	Indicates whether the opportunity has open activities
has_overdue_task	bool	Indicates whether the opportunity has overdue tasks
description	Optional[str]	Opportunity description
type	Optional[str]	Opportunity type
lead_source	Optional[str]	Source of the lead
next_step	Optional[str]	Next step in the sales process
metadata	Dict[str, Any]	Additional metadata about the opportunity