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/set-api-credential.sh

View on GitHub
#!/bin/bash
#
# set-api-credential.sh
#
# Simple script to set API credentials programmatically using Custom Settings
# Alternative to Named Credentials that allows full automation
#
# Usage:
#   ./set-api-credential.sh <setting-name> <api-key> <org-alias>
#
# Example:
#   ./set-api-credential.sh BlandAI sk_live_abc123 AIZoom
#
# For Named Credentials, use this to store the API key in a Custom Setting,
# then reference it in your Apex code
#

set -e

# Colors
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
NC='\033[0m'

usage() {
    echo -e "${BLUE}Usage:${NC}"
    echo "  $0 <setting-name> <api-key> <org-alias>"
    echo ""
    echo -e "${BLUE}Example:${NC}"
    echo "  $0 BlandAI sk_live_abc123xyz AIZoom"
    echo ""
    echo -e "${BLUE}Or use secure input (recommended):${NC}"
    echo "  $0 BlandAI - AIZoom"
    echo "  (Script will prompt for API key securely)"
    exit 1
}

if [ $# -ne 3 ]; then
    usage
fi

SETTING_NAME=$1
API_KEY=$2
ORG_ALIAS=$3

# Validate SETTING_NAME to prevent SOQL injection
if [[ ! "$SETTING_NAME" =~ ^[a-zA-Z0-9_]+$ ]]; then
    echo -e "${RED}Error: Invalid setting name '$SETTING_NAME'. Only alphanumeric and underscores allowed.${NC}" >&2
    exit 1
fi

# If API key is "-", prompt securely
if [ "$API_KEY" = "-" ]; then
    echo -e "${YELLOW}Enter API key (input hidden):${NC}"
    read -s API_KEY
    echo ""
fi

# Validate inputs
if [ -z "$API_KEY" ]; then
    echo -e "${RED}Error: API key cannot be empty${NC}"
    exit 1
fi

# Escape single quotes in API_KEY for safe interpolation
API_KEY_ESCAPED="${API_KEY//\'/\\\'}"

# Validate org
echo -e "${BLUE}Validating org connection...${NC}"
if ! sf org display --target-org "$ORG_ALIAS" &> /dev/null; then
    echo -e "${RED}Error: Cannot connect to org '$ORG_ALIAS'${NC}"
    exit 1
fi

echo -e "${GREEN}✓ Connected to org: $ORG_ALIAS${NC}"

# Check if Custom Setting exists
echo -e "${BLUE}Checking for API_Credentials__c Custom Setting...${NC}"

SETTING_CHECK=$(sf data query \
    --query "SELECT Id FROM API_Credentials__c WHERE Name = '$SETTING_NAME' LIMIT 1" \
    --target-org "$ORG_ALIAS" \
    --json 2>&1 || echo '{"status":1}')

if echo "$SETTING_CHECK" | grep -q "sObject type 'API_Credentials__c' is not supported"; then
    echo -e "${YELLOW}⚠️  API_Credentials__c Custom Setting not found${NC}"
    echo ""
    echo -e "${BLUE}Creating Custom Setting...${NC}"

    # Create the Custom Setting metadata
    mkdir -p force-app/main/default/objects/API_Credentials__c

    cat > force-app/main/default/objects/API_Credentials__c/API_Credentials__c.object-meta.xml << 'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
    <customSettingsType>Hierarchy</customSettingsType>
    <enableFeeds>false</enableFeeds>
    <label>API Credentials</label>
    <visibility>Protected</visibility>
</CustomObject>
EOF

    cat > force-app/main/default/objects/API_Credentials__c/fields/API_Key__c.field-meta.xml << 'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName>API_Key__c</fullName>
    <label>API Key</label>
    <type>Text</type>
    <length>255</length>
    <required>false</required>
</CustomField>
EOF

    echo -e "${BLUE}Deploying Custom Setting...${NC}"
    sf project deploy start \
        --source-dir force-app/main/default/objects/API_Credentials__c \
        --target-org "$ORG_ALIAS" \
        --wait 10

    echo -e "${GREEN}✓ Custom Setting created${NC}"
fi

# Insert or update the credential
EXISTING_ID=$(echo "$SETTING_CHECK" | jq -r '.result.records[0].Id // empty' 2>/dev/null)

if [ -z "$EXISTING_ID" ]; then
    echo -e "${BLUE}Creating new credential record...${NC}"
    sf data create record \
        --sobject API_Credentials__c \
        --values "Name='$SETTING_NAME' API_Key__c='$API_KEY_ESCAPED'" \
        --target-org "$ORG_ALIAS"
    echo -e "${GREEN}✓ Credential created${NC}"
else
    echo -e "${BLUE}Updating existing credential...${NC}"
    sf data update record \
        --sobject API_Credentials__c \
        --record-id "$EXISTING_ID" \
        --values "API_Key__c='$API_KEY_ESCAPED'" \
        --target-org "$ORG_ALIAS"
    echo -e "${GREEN}✓ Credential updated${NC}"
fi

echo ""
echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
echo -e "${GREEN}✓ API Credential configured successfully!${NC}"
echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
echo ""
echo -e "${BLUE}How to use in Apex:${NC}"
echo ""
echo -e "${YELLOW}API_Credentials__c cred = API_Credentials__c.getInstance('$SETTING_NAME');${NC}"
echo -e "${YELLOW}String apiKey = cred.API_Key__c;${NC}"
echo -e "${YELLOW}req.setHeader('Authorization', apiKey);${NC}"
echo ""
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