About sf-integration
sf-integration is a Salesforce skill for planning integration architecture and runtime patterns. It covers credential design, API callouts, and event-driven options, with operational safeguards such as retries and timeout handling.
Key features
- 01Choose sync or async patterns
- 02Plan REST and SOAP callouts
- 03Configure credential architecture
- 04Use Platform Events and CDC
- 05Review retries, timeouts, and logging
Use cases
- 01Design an authenticated outbound API call
- 02Register an API from an OpenAPI spec
- 03Choose an event-driven change stream
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ jaganpro/ sf-skills --skill sf-integrationAfter installing, type/sf-integrationin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
CREDITS.mdREADME.mdassets/callouts/callout-retry-handler.clshttp-response-handler.clsrest-queueable-callout.clsrest-sync-callout.clsassets/cdc/cdc-handler.clscdc-subscriber-trigger.triggerassets/endpoint-security/example.cspTrustedSite-meta.xmlexample.remoteSite-meta.xmlassets/external-credentials/jwt-external-credential.externalCredential-meta.xmloauth-external-credential.externalCredential-meta.xmlassets/external-services/external-service-operations.mdopenapi-registration.externalServiceRegistration-meta.xmlassets/named-credentials/certificate-auth.namedCredential-meta.xmlcustom-auth.namedCredential-meta.xmloauth-client-credentials.namedCredential-meta.xmloauth-jwt-bearer.namedCredential-meta.xmlassets/platform-events/event-publisher.clsevent-subscriber-action.clsevent-subscriber-trigger.triggerplatform-event-definition.object-meta.xmlassets/soap/soap-callout-service.clswsdl2apex-guide.mdhooks/scripts/suggest_credential_setup.pyvalidate_integration.pyreferences/callout-patterns.mdcdc-guide.mdcli-reference.mdevent-driven-architecture-guide.mdDetails
From the project READMEsf-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 |