Restforce travis-ci Code Climate

Restforce is a ruby gem for the Salesforce REST api. It's meant to be a lighter weight alternative to the databasedotcom gem.

It attempts to solve a couple of key issues that the databasedotcom gem has been unable to solve:

  • Support for interacting with multiple users from different orgs.
  • Support for parent-to-child relationships.
  • Support for aggregate queries.
  • Remove the need to materialize constants.
  • Support for the Streaming API
  • Support for blob data types.
  • A clean and modular architecture using Faraday middleware
  • Support for decoding Canvas signed requests. (NEW!)



Add this line to your application's Gemfile:

gem 'restforce'

And then execute:

$ bundle

Or install it yourself as:

$ gem install restforce


Restforce is designed with flexibility and ease of use in mind. By default, all api calls will return Hashie::Mash objects, so you can do things like client.query('select Id, (select Name from Children__r) from Account').Children__r.first.Name.


Which authentication method you use really depends on your use case. If you're building an application where many users from different orgs are authenticated through oauth and you need to interact with data in their org on their behalf, you should use the OAuth token authentication method.

If you're using the gem to interact with a single org (maybe you're building some salesforce integration internally?) then you should use the username/password authentication method.

OAuth token authentication

client = :oauth_token => 'oauth token',
  :instance_url  => 'instance url'

Although the above will work, you'll probably want to take advantage of the (re)authentication middleware by specifying a refresh token, client id and client secret:

client = :oauth_token => 'oauth token',
  :refresh_token => 'refresh token',
  :instance_url  => 'instance url',
  :client_id     => 'client_id',
  :client_secret => 'client_secret'

Username/Password authentication

If you prefer to use a username and password to authenticate:

client = :username => 'foo',
  :password       => 'bar',
  :security_token => 'security token'
  :client_id      => 'client_id',
  :client_secret  => 'client_secret'

Sandbox Orgs

You can connect to sandbox orgs by specifying a host. The default host is '':

client = :host => ''

Global configuration

You can set any of the options passed into globally:

Restforce.configure do |config|
  config.client_id     = ENV['SALESFORCE_CLIENT_ID']
  config.client_secret = ENV['SALESFORCE_CLIENT_SECRET']


Performs a soql query and returns the result. The result will be a Restforce::Collection, which can be iterated over.

accounts = client.query("select Id, Something__c from Account where Id = 'someid'")
# => #<Restforce::Collection >

 = records.first
# => #<Restforce::SObject >

# => 'Account'

# => "someid"

.Name = 'Foobar'
# => true

# => true

See also:


Performs a sosl query and returns the result. The result will be a Restforce::Collection.

# Find all occurrences of 'bar''FIND {bar}')
# => #<Restforce::Collection >

# Find accounts match the term 'genepoint' and return the Name field'FIND {genepoint} RETURNING Account (Name)').map(&:Name)
# => ['GenePoint']

See also:

create(sobject, attrs)

Alias: insert

Takes an sobject name and a hash of attributes to create a record. Returns the Id of the newly created reocrd if the record was successfully created.

# Add a new account
client.create('Account', Name: 'Foobar Inc.')
# => '0016000000MRatd'

See also:

update(sobject, attrs)

Takes an sobject name and a hash of attributes to update a record. The 'Id' field is required to update. Returns true if the record was successfully updated.

# Update the Account with Id '0016000000MRatd'
client.update('Account', Id: '0016000000MRatd', Name: 'Whizbang Corp')
# => true

See also:

upsert(sobject, field, attrs)

Takes an sobject name, an external id field, and a hash of attributes and either inserts or updates the record depending on the existince of the record. Returns true if the record was updated or the Id of the record if the record was created.

# Update the record with external ID of 12
client.upsert('Account', 'External__c', External__c: 12, Name: 'Foobar')

See also:

destroy(sobject, id)

Takes an sobject name and an Id and deletes the record. Returns true if the record was successfully deleted.

# Delete the Account with Id '0016000000MRatd'
client.destroy('Account', '0016000000MRatd')
# => true

See also:


If no parameter is given, it will return the global describe. If the name of an sobject is given, it will return the describe for that sobject.

# get the global describe for all sobjects
# => { ... }

# get the describe for the Account object
# => { ... }

See also:,


Performs an authentication and returns the response. In general, calling this directly shouldn't be required, since the client will handle authentication for you automatically. This should only be used if you want to force an authentication before using the streaming api, or you want to get some information about the user.

response = client.authenticate!
# => #<Restforce::Mash access_token="..." id="" instance_url="" issued_at="1348465359751" scope="api refresh_token" signature="3fW0pC/TEY2cjK5FCBFOZdjRtCfAuEbK1U74H/eF+Ho=">

# Get the user information
info = client.get(
# => '005E0000001eM4LIAU'

File Uploads

Using the new Blob Data api feature (500mb limit):

client.create 'Document', FolderId: '00lE0000000FJ6H',
  Description: 'Document test',
  Name: 'My image',
  Body:'image.jpg', __FILE__), 'image/jpeg'))

Using base64 encoded data (37.5mb limit):

client.create 'Document', FolderId: '00lE0000000FJ6H',
  Description: 'Document test',
  Name: 'My image',
  Body: Base64::encode64('image.jpg'))

See also:


Restforce supports the Streaming API, and makes implementing pub/sub with Salesforce a trivial task:

# Initialize a client with your username/password/oauth token/etc.
client =

# Force an authentication request.

# Create a PushTopic for subscribing to Account changes.
client.create! 'PushTopic', {
  ApiVersion: '23.0',
  Name: 'AllAccounts',
  Description: 'All account records',
  NotifyForOperations: 'All',
  NotifyForFields: 'All',
  Query: "select Id from Account"
} {
  # Subscribe to the PushTopic.
  client.subscribe 'AllAccounts' do |message|
    puts message.inspect

Boom, you're now receiving push notifications when Accounts are created/updated.

See also:


The gem supports easy caching of GET requests (e.g. queries):

# rails example:
client = cache: Rails.cache

# or
Restforce.configure do |config|
  config.cache = Rails.cache

If you enable caching, you can disable caching on a per-request basis by using .without_caching:

client.without_caching do
  client.query('select Id from Account')


You can easily inspect what Restforce is sending/receiving by setting Restforce.log = true.

Restforce.log = true
client ='select Id, Name from Account')

Log Output

I, [2012-09-11T21:54:00.488991 #24032]  INFO -- : post
D, [2012-09-11T21:54:00.489078 #24032] DEBUG -- request: 
I, [2012-09-11T21:54:00.997295 #24032]  INFO -- Status: 200
D, [2012-09-11T21:54:00.997391 #24032] DEBUG -- response headers: server: ""
content-type: "application/json; charset=UTF-8"
transfer-encoding: "chunked"
date: "Wed, 12 Sep 2012 04:53:59 GMT"
connection: "close"
D, [2012-09-11T21:54:00.997431 #24032] DEBUG -- response body: { ... }
I, [2012-09-11T21:54:00.998985 #24032]  INFO -- : get
D, [2012-09-11T21:54:00.999040 #24032] DEBUG -- request: Authorization: "OAuth token"
I, [2012-09-11T21:54:01.622874 #24032]  INFO -- Status: 200
D, [2012-09-11T21:54:01.623001 #24032] DEBUG -- response headers: server: ""
content-type: "application/json; charset=UTF-8"
transfer-encoding: "chunked"
date: "Wed, 12 Sep 2012 04:54:00 GMT"
connection: "close"
D, [2012-09-11T21:54:01.623058 #24032] DEBUG -- response body: { ... }


  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request