Skip to main content
skill CX Codex

integration-connectivity-generate — Claude Code skill: setup

Designs Salesforce runtime integrations with credentials, API callouts, External Services, Platform Events and CDC. Use it when connecting Salesforce to an external system.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add forcedotcom/sf-skills --skill integration-connectivity-generate -a claude-code
Open on GitHub

What integration-connectivity-generate does

This skill guides Salesforce integration design for outbound API calls, event-driven flows and change streams. It covers Named Credentials, External Credentials, External Services, REST/SOAP callouts, Platform Events, CDC and .namedCredential-meta.xml files.

It includes templates for credentials, callouts, events, CDC and SOAP, plus references for security, event architecture and CLI work. The skill gathers the authentication method, sync or async requirement, endpoint or specification, rate limits and retry expectations. Trigger-originated callouts use an async pattern.

It rejects hardcoded credentials and calls for explicit timeout, retry and logging behaviour. For new work, it advises External Credentials where supported. OAuth app configuration belongs to integration-connectivity-connected-app-configure, so keep that task separate from runtime integration design. Listed tools are jq from 1.6.0, npm from 9.0.0, python3 from 3.10.0 and sf from 2.0.0; the minimum API version is 61.0.

What it helps with

  • configure a Named Credential for an outbound API call
  • register an External Service from an OpenAPI specification
  • move a trigger-originated callout to an async pattern
  • design Platform Event publishing
  • consume a Change Data Capture stream

Example prompts for the agent

  • Set up a Named Credential for outbound REST calls and define timeout and retry behaviour.
  • Create an External Service from an OpenAPI specification and prepare its metadata.
  • Design a Platform Events integration instead of a synchronous trigger callout.

How to install integration-connectivity-generate

1Skills CLI (Vercel)

npx skills add forcedotcom/sf-skills --skill integration-connectivity-generate -a claude-code

2Manually: put the files in place

~/.claude/skills/integration-connectivity-generate/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/integration-connectivity-generate/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about integration-connectivity-generate

How do I install integration-connectivity-generate in Claude Code?

Run npx skills add forcedotcom/sf-skills --skill integration-connectivity-generate -a claude-code, then run npx skills add forcedotcom/sf-skills --skill integration-connectivity-generate -a claude-code again. The skill file is at ~/.claude/skills/integration-connectivity-generate/SKILL.md.

What does integration-connectivity-generate do?

It designs Salesforce runtime integrations for credentials, outbound REST/SOAP callouts, External Services, Platform Events and CDC. It also checks timeout, retry, async and logging decisions.

What does the skill require?

The listed CLI tools are jq from 1.6.0, npm from 9.0.0, python3 from 3.10.0 and Salesforce CLI sf from 2.0.0. Its minimum Salesforce API version is 61.0.

Source text

SKILL.md · Apache-2.0
---
name: integration-connectivity-generate
description: "Salesforce integration architecture and runtime plumbing with 120-point scoring. Use this skill to set up Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, and Change Data Capture. 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 integration-connectivity-connected-app-configure), Apex-only logic (use platform-apex-generate), data import/export (use platform-data-manage), or CDC channel-membership metadata such as PlatformEventChannel, PlatformEventChannelMember, or EnrichedField (use integration-eventing-cdc-configure)."
metadata:
  version: "1.1"
  domains: ["Integration"]
  minApiVersion: "61.0"
  relatedSkills:
    - "agentforce-generate"
    - "automation-flow-generate"
    - "integration-connectivity-connected-app-configure"
    - "integration-eventing-cdc-configure"
    - "platform-apex-generate"
    - "platform-data-manage"
    - "platform-metadata-deploy"
  cliTools:
    - tool: ["jq"]
      semver: ">=1.6.0"
    - tool: ["npm"]
      semver: ">=9.0.0"
    - tool: ["python3"]
      semver: ">=3.10.0"
    - tool: ["sf"]
      semver: ">=2.0.0"
---

# integration-connectivity-generate: 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 `integration-connectivity-generate` when the work involves:
- `.namedCredential-meta.xml` or 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 → [integration-connectivity-connected-app-configure](../integration-connectivity-connected-app-configure/SKILL.md)
- writing Apex-only business logic → the `platform-apex-generate` skill
- deploying metadata → the `platform-metadata-deploy` skill
- importing/exporting data → the `platform-data-manage` skill

---

## 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:
- the `platform-metadata-deploy` skill for deployment
- the `platform-apex-generate` skill for deeper service / retry code
- the `automation-flow-generate` skill 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:
1. **Integration pattern chosen**
2. **Auth model chosen**
3. **Files created or updated**
4. **Operational safeguards**
5. **Deployment / testing next step**

Suggested shape:

```text
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 | [integration-connectivity-connected-app-configure](../integration-connectivity-connected-app-configure/SKILL.md) | consumer key / cert / app config |
| advanced callout service code | `platform-apex-generate` skill | Apex implementation |
| declarative HTTP callout / Flow wrapper | `automation-flow-generate` skill | Flow orchestration |
| deploy integration metadata | `platform-metadata-deploy` skill | validation and rollout |
| use integration from Agentforce | `agentforce-generate` skill | agent action composition |

---

## Reference Map

### Start here
- [references/named-credentials-guide.md](references/named-credentials-guide.md)
- [references/external-services-guide.md](references/external-services-guide.md)
- [references/callout-patterns.md](references/callout-patterns.md)
- [references/rest-callout-patterns.md](references/rest-callout-patterns.md)
- [references/security-best-practices.md](references/security-best-practices.md)

### Event-driven / platform patterns
- [references/event-patterns.md](references/event-patterns.md)
- [references/platform-events-guide.md](references/platform-events-guide.md)
- [references/cdc-guide.md](references/cdc-guide.md)
- [references/event-driven-architecture-guide.md](references/event-driven-architecture-guide.md)
- [references/messaging-api-v2.md](references/messaging-api-v2.md)

### CLI / automation / scoring
- [references/cli-reference.md](references/cli-reference.md)
- [references/named-credentials-automation.md](references/named-credentials-automation.md)
- [references/scoring-rubric.md](references/scoring-rubric.md)
- [scripts/README.md](scripts/README.md) — automation scripts overview (configure-named-credential.sh, set-api-credential.sh)

### Asset templates
- `assets/named-credentials/` — Named Credential XML templates (OAuth, JWT, Certificate, Custom auth)
- `assets/external-credentials/` — External Credential XML templates (OAuth, JWT)
- `assets/external-services/` — External Service registration template and operations guide
- `assets/callouts/` — REST sync, Queueable, retry handler, and HTTP response handler Apex templates
- `assets/platform-events/` — Platform Event definition, publisher, and subscriber templates
- `assets/cdc/` — CDC handler and subscriber trigger templates
- `assets/soap/` — SOAP callout service template and wsdl2apex guide
- `assets/endpoint-security/` — Remote Site Setting and CSP Trusted Site XML templates

### Automation hooks
- `scripts/suggest_credential_setup.py` — auto-suggests credential configuration steps when integration files are detected
- `scripts/validate_integration.py` — validates integration patterns before agent responses

---

## Output Expectations

When this skill completes an integration task, it produces:

1. **Credential metadata** — one or more files in `assets/named-credentials/` or `assets/external-credentials/` filled with org-specific values
2. **Callout Apex class** — a `.cls` file using the Named Credential pattern, with async/sync pattern chosen based on context
3. **Event/CDC artifacts** — Platform Event `.object-meta.xml`, subscriber trigger, or CDC config (when event-driven pattern is chosen)
4. **Endpoint security metadata** — Remote Site Setting and/or CSP Trusted Site XML files
5. **Scoring report** — 120-point score across 6 categories (Security, Error Handling, Bulkification, Architecture, Best Practices, Documentation)
6. **Next step** — a deployment or testing instruction for the generated artifacts

---

## 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 |

---

## Pre-Delivery Checklist

- [ ] Never hardcode credentials — all secrets stored in Named Credentials or External Credentials

© forcedotcom · Apache-2.0 · forcedotcom/sf-skills

Similar skills

Everything for Backend and APIs →

From the same set167

dx-org-switch Switches the active Salesforce org via sf config set target-org. Useful when CLI commands keep hitting the wrong org. CX Codex +1 5,700installs platform-lightning-app-coordinate Builds deployable Salesforce Lightning Experience apps from natural-language requests. Use it when an app needs connected metadata components. CX Codex +1 5,600installs design-systems-slds2-migrate Runs the SLDS linter over your components and walks you through fixing violations while moving Lightning Web Components from SLDS 1 to SLDS 2. CX Codex +1 5,600installs external-diagram-mermaid-generate Turns Salesforce architecture into Mermaid diagrams: OAuth flows, ERDs, integration sequences, Agentforce structure. Ships an ASCII fallback for plain-text use. CX Codex +1 5,500installs integration-connectivity-connected-app-configure A skill for Salesforce OAuth setup: Connected Apps, External Client Apps, JWT bearer and PKCE. Useful when you touch .connectedApp-meta.xml or .eca-meta.xml. CX Codex +1 5,400installs experience-ui-bundle-frontend-generate A skill that governs UI edits in an existing Salesforce UI bundle: pages, components, layout, navigation, branding. CX Codex +1 5,300installs agentforce-d360-analyze Reconstructs Agentforce sessions from Salesforce Data Cloud audit logs. Useful for tracing conversation turns and diagnosing why an interaction escalated or failed. CX Codex +1 5,300installs experience-ui-bundle-file-upload-generate Guides file uploads in Salesforce React UI bundle apps. Helps track transfer progress and attach uploads directly to ContentVersion records. CX Codex +1 5,200installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor