sf-integration
jaganpro/sf-skills
Salesforce integration architecture: Named Credentials, External Services, REST/SOAP callouts, Platform Events, and CDC patterns.
What is sf-integration?
Expert guidance for designing and implementing Salesforce integrations using secure runtime-managed authentication, event-driven patterns, and best practices. Use this when setting up Named Credentials, External Services, outbound callouts, Platform Events, or Change Data Capture—not for OAuth app config, Apex-only logic, or data import/export.
- Design integration patterns: Named Credentials, External Services, REST/SOAP callouts, Platform Events, and CDC
- Choose secure auth models (OAuth, JWT via External Credentials) and avoid hardcoded secrets
- Generate templates for callouts, event publishing, and change-stream consumption
- Validate operational safety: timeouts, retries, async handling, and logging
- Identify anti-patterns: sync trigger callouts, missing retry logic, no observability
- Delegate to specialized skills (sf-apex, sf-flow, sf-deploy) for implementation and deployment
How to install sf-integration
npx skills add https://github.com/jaganpro/sf-skills --skill sf-integrationHow to use sf-integration
- 1.Gather required context: integration style (callout, event, External Service, CDC), auth method, sync vs async, endpoint details, and rate limits
- 2.Choose the integration pattern from the recommended workflow table (Named Credential, External Service, Platform Events, CDC, or async callout)
- 3.Select the auth model, preferring External Credentials for new development
- 4.Generate templates from the provided assets (named-credentials/, external-credentials/, external-services/, callouts/, platform-events/, cdc/)
- 5.Validate operational safety: define timeouts, plan retries, add logging, and ensure async handling for trigger-originated work
- 6.Report the chosen pattern, auth model, files created, safeguards, and next deployment step
Use cases
- Set up a Named Credential and External Service to call a third-party REST API with OAuth authentication
- Design an async callout pattern to avoid synchronous trigger callouts and handle retries
- Implement Platform Events for decoupled event publishing between Salesforce and external systems
- Configure Change Data Capture to stream Salesforce record changes to a downstream system
- Build event-driven architecture with proper timeout, retry, and dead-letter handling
- Salesforce architects designing integration solutions
- Integration engineers setting up callouts and event streams
- Developers implementing Named Credentials and External Services
- Teams building event-driven or asynchronous integration patterns
sf-integration FAQ
Use sf-integration for integration architecture and runtime plumbing (Named Credentials, External Services, callout patterns, events). Delegate to sf-connected-apps for OAuth app setup, sf-apex for Apex-only business logic, and sf-flow for declarative HTTP orchestration.
The skill evaluates integration designs across 6 categories with a total of 120 points. Scores 108+ indicate production-ready design, 90–107 is good with some hardening needed, 72–89 is workable but needs review, and <72 is unsafe for deployment.
No. The skill explicitly forbids synchronous callouts from triggers as a high-signal anti-pattern. Use async callout patterns or Platform Events instead to decouple the work.
Prefer secure runtime-managed auth: Named Credentials or External Credentials with OAuth or JWT. Never hardcode credentials in code.
Define timeout behavior explicitly, plan retries for transient failures, implement dead-letter strategies for high-volume outbound work, and add request/response logging for observability.
Full instructions (SKILL.md)
Source of truth, from jaganpro/sf-skills.
name: sf-integration description: > Salesforce integration architecture with 120-point scoring. TRIGGER when: user sets up Named Credentials, External Services, REST/SOAP callouts, Platform Events, CDC, or touches .namedCredential-meta.xml files. DO NOT TRIGGER when: Connected App/OAuth config (use sf-connected-apps), Apex-only logic (use sf-apex), or data import/export (use sf-data). license: MIT metadata: version: "1.2.0" author: "Jag Valaiyapathy" scoring: "120 points across 6 categories"
sf-integration: Salesforce Integration Patterns Expert
Use this skill when the user needs integration architecture and runtime plumbing: Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, CDC, and event-driven integration design.
When This Skill Owns the Task
Use sf-integration when the work involves:
.namedCredential-meta.xmlor External Credential metadata- outbound REST/SOAP callouts
- External Service registration from OpenAPI specs
- Platform Events, CDC, and event-driven architecture
- choosing sync vs async integration patterns
Delegate elsewhere when the user is:
- configuring the OAuth app itself → sf-connected-apps
- writing Apex-only business logic → sf-apex
- deploying metadata → sf-deploy
- importing/exporting data → sf-data
Required Context to Gather First
Ask for or infer:
- integration style: outbound callout, inbound event, External Service, CDC, platform event
- auth method
- sync vs async requirement
- system endpoint / spec details
- rate limits, retry expectations, and failure tolerance
- whether this is net-new design or repair of an existing integration
Recommended Workflow
1. Choose the integration pattern
| Need | Default pattern |
|---|---|
| authenticated outbound API call | Named Credential / External Credential + Apex or Flow |
| spec-driven API client | External Service |
| trigger-originated callout | async callout pattern |
| decoupled event publishing | Platform Events |
| change-stream consumption | CDC |
2. Choose the auth model
Prefer secure runtime-managed auth:
- Named Credentials / External Credentials
- OAuth or JWT via the right credential model
- no hardcoded secrets in code
3. Generate from the right templates
Use the provided assets under:
assets/named-credentials/assets/external-credentials/assets/external-services/assets/callouts/assets/platform-events/assets/cdc/assets/soap/
4. Validate operational safety
Check:
- timeout and retry handling
- async strategy for trigger-originated work
- logging / observability
- event retention and subscriber implications
5. Hand off deployment or implementation details
Use:
- sf-deploy for deployment
- sf-apex for deeper service / retry code
- sf-flow for declarative HTTP callout orchestration
High-Signal Rules
- never hardcode credentials
- do not do synchronous callouts from triggers
- define timeout behavior explicitly
- plan retries for transient failures
- use middleware / event-driven patterns when outbound volume is high
- prefer External Credentials architecture for new development when supported
Common anti-patterns:
- sync trigger callouts
- no retry or dead-letter strategy
- no request/response logging
- mixing auth setup responsibilities with runtime integration design
Output Format
When finishing, report in this order:
- Integration pattern chosen
- Auth model chosen
- Files created or updated
- Operational safeguards
- Deployment / testing next step
Suggested shape:
Integration: <summary>
Pattern: <named credential / external service / event / cdc / callout>
Files: <paths>
Safety: <timeouts, retries, async, logging>
Next step: <deploy, register, test, or implement>
Cross-Skill Integration
| Need | Delegate to | Reason |
|---|---|---|
| OAuth app setup | sf-connected-apps | consumer key / cert / app config |
| advanced callout service code | sf-apex | Apex implementation |
| declarative HTTP callout / Flow wrapper | sf-flow | Flow orchestration |
| deploy integration metadata | sf-deploy | validation and rollout |
| use integration from Agentforce | sf-ai-agentscript | agent action composition |
Reference Map
Start here
- references/named-credentials-guide.md
- references/external-services-guide.md
- references/callout-patterns.md
- references/security-best-practices.md
Event-driven / platform patterns
- references/event-patterns.md
- references/platform-events-guide.md
- references/cdc-guide.md
- references/event-driven-architecture-guide.md
- references/messaging-api-v2.md
CLI / automation / scoring
- references/cli-reference.md
- references/named-credentials-automation.md
- references/scoring-rubric.md
- assets/
Score Guide
| Score | Meaning |
|---|---|
| 108+ | strong production-ready integration design |
| 90–107 | good design with some hardening left |
| 72–89 | workable but needs architectural review |
| < 72 | unsafe / incomplete for deployment |
Related skills
More from jaganpro/sf-skills and the wider catalog.
sf-lwc
Lightning Web Components with PICKLES methodology and 165-point quality scoring.
sf-metadata
Generate and query Salesforce metadata with 120-point quality scoring.
sf-permissions
Permission Set analysis, hierarchy viewing, and access auditing for Salesforce orgs.
sf-soql
SOQL/SOSL query generation, optimization, and performance scoring for Salesforce.
sf-testing
Run Apex tests, analyze coverage, and fix failures with structured test-fix loops.
sf-vlocity-build-deploy
>