jeffersongoncalves / laravel-salesforce

1.0.0 2026-09-08 01:30 UTC

Requires

• php: ^8.2
• illuminate/http: ^12.0|^13.0
• illuminate/support: ^12.0|^13.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^3.0
• laravel/pint: ^1.21
• orchestra/testbench: ^10.0|^11.0
• pestphp/pest: ^3.0|^4.0
• pestphp/pest-plugin-laravel: ^3.0|^4.0

MIT

• Jefferson Gonçalves

• php
• salesforce
• composer
• laravel
• API-Client
• laravel-package

Published on Packagist.org on 2026-09-08 01:30 UTC

README

Laravel Salesforce

A PHP/Laravel client for the Salesforce REST API. Run SOQL queries, SOSL searches, and CRUD any sobject, authenticated via the OAuth2 username-password flow with automatic token caching and re-authentication.

Features

• SOQL queries (/query)
• SOSL search (/search)
• Sobject CRUD: find, create, update, delete (/sobjects/{name})
• Sobject describe (/sobjects/{name}/describe)
• OAuth2 password grant with cached access token, transparent re-auth on a 401
• Throws SalesforceException (with the original API error body) on any non-2xx response

Installation

You can install the package via composer:

composer require jeffersongoncalves/laravel-salesforce

Publish the config file:

php artisan vendor:publish --tag=salesforce-config

Set your Salesforce connected-app and user credentials in .env:

SALESFORCE_LOGIN_URL=https://login.salesforce.com
SALESFORCE_CLIENT_ID=your-connected-app-client-id
SALESFORCE_CLIENT_SECRET=your-connected-app-client-secret
SALESFORCE_USERNAME=your-username
SALESFORCE_PASSWORD=your-password
SALESFORCE_SECURITY_TOKEN=your-security-token
SALESFORCE_API_VERSION=v59.0

Use https://test.salesforce.com for sandbox orgs. Reset the security token under Settings > My Personal Information > Reset My Security Token.

Configuration

// config/salesforce.php
return [
    'login_url' => env('SALESFORCE_LOGIN_URL', 'https://login.salesforce.com'),
    'client_id' => env('SALESFORCE_CLIENT_ID', ''),
    'client_secret' => env('SALESFORCE_CLIENT_SECRET', ''),
    'username' => env('SALESFORCE_USERNAME', ''),
    'password' => env('SALESFORCE_PASSWORD', ''),
    'security_token' => env('SALESFORCE_SECURITY_TOKEN', ''),
    'api_version' => env('SALESFORCE_API_VERSION', 'v59.0'),
];

Usage

The package is resolved via the Salesforce facade or by injecting JeffersonGoncalves\Salesforce\Salesforce.

Query (SOQL)

use JeffersonGoncalves\Salesforce\Facades\Salesforce;

$result = Salesforce::query('SELECT Id, Name FROM Account LIMIT 10');
// $result['records']

Search (SOSL)

$result = Salesforce::search('FIND {Jane} IN ALL FIELDS RETURNING Contact(Id, Name)');
// $result['searchRecords']

Find a record

$account = Salesforce::sobject('Account')->find('001XX000003DHPh', ['Id', 'Name', 'Industry']);

Create a record

$result = Salesforce::sobject('Contact')->create([
    'FirstName' => 'Jane',
    'LastName' => 'Doe',
    'Email' => '[e-mail]',
]);
// $result['id']

Update a record

Salesforce::sobject('Contact')->update('003XX0000012345', [
    'Title' => 'Senior Developer',
]);

Delete a record

Salesforce::sobject('Contact')->delete('003XX0000012345');

Describe an sobject

$fields = Salesforce::sobject('Contact')->describe();

Error handling

Any non-2xx API response throws JeffersonGoncalves\Salesforce\Exceptions\SalesforceException, which exposes the decoded error body:

use JeffersonGoncalves\Salesforce\Exceptions\SalesforceException;

try {
    Salesforce::sobject('Account')->find('unknown-id');
} catch (SalesforceException $e) {
    logger()->error($e->getMessage(), $e->errorBody());
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email the author instead of using the issue tracker.

Credits

• Jefferson Gonçalves
• All Contributors

License

The MIT License (MIT). Please see License File for more information.