forcedotcom/sf-skills / plugins/builder/integration/skills/integration-connectivity-generate
integration-connectivity-generate
VerifiedSalesforce 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).
scripts/README.md
View on GitHub# integration-connectivity-generate Helper Scripts
Automation scripts for configuring Salesforce integrations without manual UI steps.
> **Mirror note:** These files mirror the canonical generic helpers in the repository root `scripts/` directory. Keep both locations aligned until the packaging layout is consolidated.
## Scripts
| Script | Purpose | Auth Type |
|--------|---------|-----------|
| `configure-named-credential.sh` | Set API keys via ConnectApi | Enhanced Named Credentials |
| `set-api-credential.sh` | Store keys in Custom Settings | Legacy (dev/test) |
## Quick Start
```bash
# Enhanced Named Credentials (recommended for production)
./configure-named-credential.sh <external-credential-name> <principal-name> <org-alias>
# Custom Settings (legacy, for dev/test)
./set-api-credential.sh <setting-name> - <org-alias>
```
## Prerequisites
- **Salesforce CLI v2+** (`sf` command)
- **Authenticated org** (`sf org login web -a <alias>`)
- **Deployed metadata** (External Credential, Named Credential, CSP)
## Usage Examples
### Configure Named Credential
```bash
# Interactive mode - prompts for API key securely
./configure-named-credential.sh VisualCrossingWeather weatherAPIKey MyDevOrg
# The script will:
# 1. Validate org connection
# 2. Check External Credential exists
# 3. Prompt for API key (hidden input)
# 4. Execute ConnectApi Apex to store encrypted
```
### Custom Settings (Legacy)
```bash
# Secure input (dash prompts for hidden input)
./set-api-credential.sh WeatherAPI - MyDevOrg
# Direct input (less secure, for CI/CD)
./set-api-credential.sh WeatherAPI sk_live_abc123 MyDevOrg
```
## Templates
The `templates/` directory contains customizable scripts for new integrations:
| Template | Purpose |
|----------|---------|
| `setup-credentials-with-csp.sh` | Full setup with CSP Trusted Sites |
### Using Templates
```bash
# Copy template for your integration
cp templates/setup-credentials-with-csp.sh my-integration-setup.sh
# Edit configuration variables
# - SKILL_NAME
# - CSP_NAME
# - API_KEY_URL
```
## Auto-Run Behavior
When you create credential metadata files, Claude will automatically suggest running these scripts:
| File Pattern | Suggested Script |
|--------------|------------------|
| `*.namedCredential-meta.xml` | `configure-named-credential.sh` |
| `*.externalCredential-meta.xml` | `configure-named-credential.sh` |
## Troubleshooting
**"sf: command not found"**
- Install Salesforce CLI: `npm install -g @salesforce/cli`
**"Not authenticated"**
- Run: `sf org login web -a <alias>`
**"External Credential not found"**
- Deploy External Credential first
- Check developer name matches
## Related Documentation
- [Named Credentials Automation Guide](../references/named-credentials-automation.md)
- [Named Credentials Template Reference](../references/named-credentials-guide.md)
- [Security Best Practices](../references/security-best-practices.md)
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |