🎁 Get the FREE AI Skills Starter Guide β€” Subscribe β†’
BytesAgainBytesAgain
πŸ¦€ ClawHub

Salesforce

by @byungkyu

Salesforce CRM API integration with managed OAuth. Install only if you need Salesforce CRM administration. Connect with the narrowest Salesforce permissions...

Versionv1.0.7
Downloads19,245
Stars⭐ 8
Comments3
TERMINAL
clawhub install salesforce-api

πŸ“– About This Skill


name: salesforce description: | Salesforce CRM API integration with managed OAuth. Install only if you need Salesforce CRM administration. Connect with the narrowest Salesforce permissions available, prefer sandbox orgs for destructive or batch work, verify the intended connection ID before each request, and revoke unused connections promptly. This integration can mutate CRM records β€” approve only specific write actions after checking the exact sObject, record IDs, and consequence. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). compatibility: Requires network access and valid Maton API key metadata: author: maton version: "1.0" clawdbot: emoji: 🧠 requires: env: - MATON_API_KEY

Salesforce

Access the Salesforce REST API with managed OAuth authentication. Query records using SOQL, manage sObjects, and perform CRUD operations on your Salesforce data.

Quick Start

# Query contacts
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/salesforce/services/data/v59.0/query?q=SELECT+Id,Name,Email+FROM+Contact+LIMIT+10')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Base URL

https://api.maton.ai/salesforce/{endpoint-path}

The gateway proxies requests to {instance}.salesforce.com (automatically replaced with your connection config) and injects your access token. Only the endpoints documented in the API Reference section below are supported β€” always use specific endpoint paths from that section rather than constructing arbitrary paths.

Authentication

All requests require the Maton API key in the Authorization header:

Authorization: Bearer $MATON_API_KEY

Environment Variable: Set your API key as MATON_API_KEY:

export MATON_API_KEY="YOUR_API_KEY"

Getting Your API Key

1. Sign in or create an account at maton.ai 2. Go to maton.ai/settings 3. Copy your API key

Connection Management

Manage your Salesforce OAuth connections at https://api.maton.ai.

List Connections

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections?app=salesforce&status=ACTIVE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Create Connection

python <<'EOF'
import urllib.request, os, json
data = json.dumps({'app': 'salesforce'}).encode()
req = urllib.request.Request('https://api.maton.ai/connections', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Get Connection

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Response:

{
  "connection": {
    "connection_id": "{connection_id}",
    "status": "ACTIVE",
    "creation_time": "2025-12-08T07:20:53.488460Z",
    "last_updated_time": "2026-01-31T20:03:32.593153Z",
    "url": "https://connect.maton.ai/?session_token=...",
    "app": "salesforce",
    "metadata": {}
  }
}

Open the returned url in a browser to complete OAuth authorization.

Delete Connection

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Specifying Connection

If you have multiple Salesforce connections, specify which one to use with the Maton-Connection header:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/salesforce/services/data/v59.0/sobjects')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Maton-Connection', '{connection_id}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Always include the Maton-Connection header to ensure requests go to the intended Salesforce org, especially before any write operation. If you have multiple connections and omit this header, the gateway uses a default connection, which may not be the intended org.

Security & Permissions

  • IMPORTANT: Treat MATON_API_KEY as a secret β€” do not log it, include it in chats or prompts visible to others, or expose it in shared files or outputs. The key authenticates with Maton, and the Salesforce connection is independently scoped via OAuth. Use the narrowest Salesforce permissions available, rotate the key if exposed at maton.ai/settings, and revoke unused connections promptly.
  • Access is scoped to the Salesforce resources permitted by the connected account's OAuth scopes. Only install if you need Salesforce CRM administration. Prefer sandbox orgs for destructive or batch testing.
  • Default to read-only operations. Always start with SOQL queries or GET requests to confirm record IDs and field values before proposing any changes.
  • All write operations require explicit user approval with specific details. Before executing any POST, PATCH, DELETE, or composite/batch call:
  • 1. Retrieve and display the target resource (sObject type, record ID, record name) so the user can verify. 2. Clearly describe the intended effect (e.g., "This will delete Opportunity 'Acme Deal' (ID: 006xx) β€” this cannot be undone"). 3. Wait for explicit user confirmation before proceeding.
  • Batch and composite operations require extra caution. These can modify multiple records in a single call. List every affected record and confirm before execution.
  • API Reference

    SOQL Query

    GET /salesforce/services/data/v59.0/query?q=SELECT+Id,Name+FROM+Contact+LIMIT+10
    

    Complex query:

    GET /salesforce/services/data/v59.0/query?q=SELECT+Id,Name,Email+FROM+Contact+WHERE+Email+LIKE+'%example.com'+ORDER+BY+CreatedDate+DESC
    

    Get Object

    GET /salesforce/services/data/v59.0/sobjects/{objectType}/{recordId}
    

    Example:

    GET /salesforce/services/data/v59.0/sobjects/Contact/003XXXXXXXXXXXXXXX
    

    Create Object

    POST /salesforce/services/data/v59.0/sobjects/{objectType}
    Content-Type: application/json

    { "FirstName": "John", "LastName": "Doe", "Email": "john@example.com" }

    Update Object

    PATCH /salesforce/services/data/v59.0/sobjects/{objectType}/{recordId}
    Content-Type: application/json

    { "Phone": "+1234567890" }

    Delete Object

    DELETE /salesforce/services/data/v59.0/sobjects/{objectType}/{recordId}
    

    Describe Object (get schema)

    GET /salesforce/services/data/v59.0/sobjects/{objectType}/describe
    

    List Objects

    GET /salesforce/services/data/v59.0/sobjects
    

    Search (SOSL)

    GET /salesforce/services/data/v59.0/search?q=FIND+{searchTerm}+IN+ALL+FIELDS+RETURNING+Contact(Id,Name)
    

    Composite Request (batch multiple operations)

    POST /salesforce/services/data/v59.0/composite
    Content-Type: application/json

    { "compositeRequest": [ { "method": "GET", "url": "/services/data/v59.0/sobjects/Contact/003XXXXXXX", "referenceId": "contact1" }, { "method": "GET", "url": "/services/data/v59.0/sobjects/Account/001XXXXXXX", "referenceId": "account1" } ] }

    Composite Batch Request

    POST /salesforce/services/data/v59.0/composite/batch
    Content-Type: application/json

    { "batchRequests": [ {"method": "GET", "url": "v59.0/sobjects/Contact/003XXXXXXX"}, {"method": "GET", "url": "v59.0/sobjects/Account/001XXXXXXX"} ] }

    sObject Collections Create (batch create)

    POST /salesforce/services/data/v59.0/composite/sobjects
    Content-Type: application/json

    { "allOrNone": true, "records": [ {"attributes": {"type": "Contact"}, "FirstName": "John", "LastName": "Doe"}, {"attributes": {"type": "Contact"}, "FirstName": "Jane", "LastName": "Smith"} ] }

    sObject Collections Delete (batch delete)

    DELETE /salesforce/services/data/v59.0/composite/sobjects?ids=003XXXXX,003YYYYY&allOrNone=true
    

    Get Updated Records

    GET /salesforce/services/data/v59.0/sobjects/{objectType}/updated/?start=2026-01-30T00:00:00Z&end=2026-02-01T00:00:00Z
    

    Get Deleted Records

    GET /salesforce/services/data/v59.0/sobjects/{objectType}/deleted/?start=2026-01-30T00:00:00Z&end=2026-02-01T00:00:00Z
    

    Get API Limits

    GET /salesforce/services/data/v59.0/limits
    

    List API Versions

    GET /salesforce/services/data/
    

    Common Objects

  • Account - Companies/Organizations
  • Contact - People associated with accounts
  • Lead - Potential customers
  • Opportunity - Sales deals
  • Case - Support cases
  • Task - To-do items
  • Event - Calendar events
  • Code Examples

    JavaScript

    const response = await fetch(
      'https://api.maton.ai/salesforce/services/data/v59.0/query?q=SELECT+Id,Name+FROM+Contact+LIMIT+5',
      {
        headers: {
          'Authorization': Bearer ${process.env.MATON_API_KEY}
        }
      }
    );
    const data = await response.json();
    

    Python

    import os
    import requests

    response = requests.get( 'https://api.maton.ai/salesforce/services/data/v59.0/query', headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'}, params={'q': 'SELECT Id,Name FROM Contact LIMIT 5'} )

    Notes

  • Use URL encoding for SOQL queries (spaces become +)
  • Record IDs are 15 or 18 character alphanumeric strings
  • API version (v59.0) can be adjusted; latest is v65.0
  • Update and Delete operations return HTTP 204 (no content) on success
  • Dates for updated/deleted queries use ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  • Use allOrNone: true in batch operations for atomic transactions
  • IMPORTANT: When using curl commands, use curl -g when URLs contain brackets (fields[], sort[], records[]) to disable glob parsing
  • IMPORTANT: When piping curl output to jq or other commands, environment variables like $MATON_API_KEY may not expand correctly in some shell environments. You may get "Invalid API key" errors when piping.
  • Error Handling

    | Status | Meaning | |--------|---------| | 400 | Missing Salesforce connection | | 401 | Invalid or missing Maton API key | | 429 | Rate limited (10 req/sec per account) | | 4xx/5xx | Passthrough error from Salesforce API |

    Troubleshooting: API Key Issues

    1. Check that the MATON_API_KEY environment variable is set:

    echo $MATON_API_KEY
    

    2. Verify the API key is valid by listing connections:

    python <<'EOF'
    import urllib.request, os, json
    req = urllib.request.Request('https://api.maton.ai/connections')
    req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
    print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
    EOF
    

    Troubleshooting: Invalid App Name

    1. Ensure your URL path starts with salesforce. For example:

  • Correct: https://api.maton.ai/salesforce/services/data/v59.0/query
  • Incorrect: https://api.maton.ai/services/data/v59.0/query
  • Resources

  • REST API Developer Guide
  • List sObjects
  • Describe sObject
  • Get Record
  • Create Record
  • Update Record
  • Delete Record
  • Query Records (SOQL)
  • Composite Request
  • sObject Collections
  • SOQL Reference
  • SOSL Reference
  • Maton Community
  • Maton Support
  • πŸ’‘ Examples

    # Query contacts
    python <<'EOF'
    import urllib.request, os, json
    req = urllib.request.Request('https://api.maton.ai/salesforce/services/data/v59.0/query?q=SELECT+Id,Name,Email+FROM+Contact+LIMIT+10')
    req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
    print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
    EOF
    

    πŸ“‹ Tips & Best Practices

  • Use URL encoding for SOQL queries (spaces become +)
  • Record IDs are 15 or 18 character alphanumeric strings
  • API version (v59.0) can be adjusted; latest is v65.0
  • Update and Delete operations return HTTP 204 (no content) on success
  • Dates for updated/deleted queries use ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
  • Use allOrNone: true in batch operations for atomic transactions
  • IMPORTANT: When using curl commands, use curl -g when URLs contain brackets (fields[], sort[], records[]) to disable glob parsing
  • IMPORTANT: When piping curl output to jq or other commands, environment variables like $MATON_API_KEY may not expand correctly in some shell environments. You may get "Invalid API key" errors when piping.