Skip to content

forcedotcom/sf-skills / plugins/builder/integration/skills/integration-connectivity-generate

integration-connectivity-generate

Verified

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).

FileKindSize
README.mdmarkdown3.5 KB
SKILL.mdskill md8.8 KB
assets/callouts/callout-retry-handler.clsother6.0 KB
assets/callouts/http-response-handler.clsother8.5 KB
assets/callouts/rest-queueable-callout.clsother8.8 KB
assets/callouts/rest-sync-callout.clsother7.4 KB
assets/cdc/cdc-handler.clsother8.4 KB
assets/cdc/cdc-subscriber-trigger.triggerother5.3 KB
assets/endpoint-security/example.cspTrustedSite-meta.xmlconfig1.8 KB
assets/endpoint-security/example.remoteSite-meta.xmlconfig1.3 KB
assets/external-credentials/jwt-external-credential.externalCredential-meta.xmlconfig3.2 KB
assets/external-credentials/oauth-external-credential.externalCredential-meta.xmlconfig3.0 KB
assets/external-services/external-service-operations.mdmarkdown5.5 KB
assets/external-services/openapi-registration.externalServiceRegistration-meta.xmlconfig4.8 KB
assets/named-credentials/certificate-auth.namedCredential-meta.xmlconfig2.2 KB
assets/named-credentials/custom-auth.namedCredential-meta.xmlconfig2.2 KB
assets/named-credentials/oauth-client-credentials.namedCredential-meta.xmlconfig1.8 KB
assets/named-credentials/oauth-jwt-bearer.namedCredential-meta.xmlconfig2.2 KB
assets/platform-events/event-publisher.clsother6.4 KB
assets/platform-events/event-subscriber-action.clsother9.5 KB
assets/platform-events/event-subscriber-trigger.triggerother3.9 KB
assets/platform-events/platform-event-definition.object-meta.xmlconfig3.7 KB
assets/soap/soap-callout-service.clsother6.4 KB
assets/soap/wsdl2apex-guide.mdmarkdown6.2 KB
references/callout-patterns.mdmarkdown21.8 KB
references/cdc-guide.mdmarkdown8.2 KB
references/cli-reference.mdmarkdown2.9 KB
references/event-driven-architecture-guide.mdmarkdown10.1 KB
references/event-patterns.mdmarkdown27.2 KB
references/external-services-guide.mdmarkdown8.4 KB
references/messaging-api-v2.mdmarkdown17.9 KB
references/named-credentials-automation.mdmarkdown6.2 KB
references/named-credentials-guide.mdmarkdown7.1 KB
references/platform-events-guide.mdmarkdown6.6 KB
references/rest-callout-patterns.mdmarkdown8.8 KB
references/scoring-rubric.mdmarkdown2.4 KB
references/security-best-practices.mdmarkdown5.9 KB
scripts/README.mdmarkdown2.9 KB
scripts/configure-named-credential.shexecutablescript9.2 KB
scripts/set-api-credential.shexecutablescript4.9 KB
scripts/suggest_credential_setup.pyscript9.3 KB
scripts/templates/setup-credentials-with-csp.shexecutablescript5.9 KB
scripts/validate_integration.pyscript13.4 KB

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)
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: 471kUpdated Claude CodeCodexVerifiedInstall
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: 322kUpdated Claude CodeCodexVerifiedInstall
dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependenciesStars: 322kUpdated Claude CodeCodexVerifiedInstall
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 availableStars: 322kUpdated Claude CodeCodexVerifiedInstall