Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Package Installation Guide

Guide to install the Salesforce integration package and sync with Kernel

Kernel Salesforce integration installation and setup guide

The Kernel team will create an environment and logins for you. You can access this via app.kernel.ai.

Upgrade an existing installation

Use this path when the Kernel SF Connected App package is already installed and you want the latest features.

  1. In Salesforce, go to Setup → Installed Packages and note the installed Kernel SF Connected App version.

  2. In the Kernel Platform, open your Salesforce integration and select the current package install link.

  3. Salesforce recognises the existing package and opens the upgrade flow. Review the package details and continue.

  4. Choose Install for All Users. This makes the packaged Kernel components, including the structured feedback form, available to end users.

  5. Wait for the Install Complete confirmation.

  6. Return to Setup → Installed Packages and confirm the new version.

  7. Assign Kernel Readonly PermissionSet (Kernel_Readonly_PermissionSet) to every user who should access Kernel features in Salesforce, then review any feature-specific page-layout steps in the relevant guide.

For structured feedback, upgrade to version 3.11.4 or later, choose Install for All Users, assign Kernel Readonly PermissionSet to every intended user, and add the Send Kernel Feedback action to the Account page. See Send Kernel Feedback for the complete setup and test flow.

Before upgrading, follow Upgrade and preserve customisations to record and preserve your team's permissions, pages, mappings and schedules.

Package upgrades preserve your existing Kernel connection. You do not need to recreate the integration user or repeat the authorization flow unless Salesforce or the Kernel Platform prompts you to reconnect.

Step 1: Your instance

You will need to select your CRM and then input your instance URL. This can be a production or sandbox environment. Then press continue.

This will provide you with the install link for the Kernel package in your CRM. Click to open the install.

Step 2: Package configuration

Prerequisites

  • Salesforce System Administrator access in your target org

  • Package version: Use the install link generated in Kernel. The link points to the current released package for your org.

Select installation options:

  • Install for: All Users

Choose Install for All Users, even if only a selected group will use Kernel. This makes the packaged forms and components visible to end users. You will control which users can access them by assigning the appropriate Kernel permission set after installation.

  • Review the Kernel API access prompt during installation. You will choose and authorize the integration user in the later setup steps. Its Salesforce profile, permission sets and record access determine the data available to the enabled workflows. See the Salesforce Integration User Permission Matrix.

  • Click Install

  • Wait for "Install Complete" confirmation

Verify installation:

  • Navigate to Setup → Installed Packages

  • Confirm "Kernel SF Connected App" appears with status "Installed"

Assign end-user access

Assign Kernel Readonly PermissionSet to every user who should access Kernel features, including the structured feedback form.

  1. In Salesforce Setup, go to Permission Sets.

  2. Open Kernel Readonly PermissionSet (Kernel_Readonly_PermissionSet).

  3. Select Manage Assignments, then Add Assignments.

  4. Select the users who should have access and click Assign.

The permission set includes the Kernel: Submit Feedback permission and the access required to open the feedback form. Installing for all users makes the packaged components available; the permission set controls who can use them.

Open App Launcher (9-dot grid icon)

  1. Select "Kernel Integration" app

  2. Click the "Kernel Setup" tab

Step 3: Create integration user

The integration user is the dedicated Salesforce user Kernel uses for API access. The package's create-user flow starts with a System Administrator profile for setup. After connecting, review the profile and all permission assignments so ongoing access matches your enabled workflows.

Creating the user

  1. In the Kernel Setup tab, locate the Integration User panel

  2. Review default settings:

    • Email: [email protected]

    • First Name: Kernel

    • Last Name: Integration

    • Username Prefix: kernel-integration

  3. Click "Create Integration User"

    • The system creates a unique username: kernel-integration@{OrgId}.kernel.ai

    • A password reset email is sent to the specified email address

    • The user is created with the System Administrator profile. This is for authorizing the app/user and can be changed to minimum access after a successful connection.

  4. Verify user creation:

    • You'll see a success message with the user details

Permission set assignment

Object
Read
View-All
Edit

Account

✓ (All or select fields)

✓ (All or select fields)

✓ (Kernel fields)

Lead*

✓ (All or select fields)

✓ (All or select fields)

✓ (Kernel fields)

Contact

✓ (All or select fields)

✓ (All or select fields)

Opportunity

✓ (All or select fields)

✓ (All or select fields)

Task/Activity

✓ (All or select fields)

✓ (All or select fields)

SystemUser

✓ (Limited fields)

The system automatically assigns the Kernel_SF_Connected_App_PermissionSet to the integration user, which provides:

  • API access

  • Read access to standard and custom objects

  • Access to Kernel-specific settings

You can also choose to assign your own custom permission set

Step 4: Authorize Kernel connection

Before authorizing the connection, you need your Kernel API credentials. These will now be shown in the Kernel Platform via the original page:

  • Tenant ID: Your unique organization identifier (e.g., tenant_abc123xyz)

  • API Key: Your secure API key for authentication

  1. In the Kernel Setup tab, locate the Authorize Access panel

  2. Enter your Kernel credentials:

  3. Click "Sync with Kernel"

Finally, back in the Kernel Platform you will need to log in to the Salesforce instance to authorize the connection. On completion you will see our default fields to be mapped to your CRM. This means the installation is complete.

You can now proceed to set up the Kernel Custom Object.

Configuration options

Custom permission sets

By default, Kernel uses its standard permission set. For custom requirements:

  1. In the Permission Sets panel:

    • Select "Choose Custom Permission Sets"

    • Select your organization's permission sets

    • Click "Save"

  2. The selected permission sets will be assigned to the integration user

For full compatibility we recommend using the default Kernel permission set.

Non-admin sync access

Admins can enable Allow Non-Admin Sync to let users with Kernel_Readonly_PermissionSet run, configure, and schedule syncs through Kernel_Sync_User_PermissionSet, without granting the broader Kernel_Admin_PermissionSet. Sync schedules can run all active sync configs or only selected configs.

Because sync configuration requires Salesforce Metadata API permissions, only enable this for users who should be allowed to manage sync configuration.

Security and compliance

OAuth scopes

The Kernel Connected App requests these OAuth scopes:

  • api - Access and manage your data

  • refresh_token - Perform requests while you're offline

  • openid - Access unique user identifier

  • profile - Access basic profile information

  • email - Access email address

Data access

  • Access is logged and auditable

  • All API calls are tracked in Setup Audit Trail

  • Data transmission is encrypted via TLS 1.2+

Troubleshooting

Common issues and solutions

Issue
Solution

App not visible in App Launcher

Assign the Kernel Integration app to your user profile via Setup → App Manager

"Authorize" button disabled

Ensure Tenant ID and API Key are entered correctly

Permission Set assignment failed

Check if integration user is active; manually assign via Setup → Permission Sets

Managing the integration

Revoking access

To temporarily or permanently disconnect:

  1. Revoke OAuth Token:

    • Setup → Connected Apps OAuth Usage

    • Find "Kernel SF Connected App"

    • Click "Revoke"

  2. Deactivate Integration User:

    • Setup → Users

    • Find the kernel-integration user

    • Uncheck "Active"

    • Click Save

Re-establishing connection

  1. Reactivate the integration user (if deactivated)

  2. Return to Kernel Setup tab

  3. Click "Authorize Kernel" again

  4. Complete OAuth flow

Updating credentials

If your Kernel API credentials change:

  1. Obtain new credentials from Kernel

  2. In Salesforce Kernel Setup:

    • Click "Disconnect" (if connected)

    • Enter new Tenant ID and API Key

    • Click "Authorize Kernel"

    • Complete OAuth flow

Support

Getting help

  • Email: [email protected]

  • Include in your support request:

    • Organization ID

    • Environment type (Sandbox/Production)

    • Integration user username

    • Error messages or screenshots

    • Sync job IDs (from Kernel Portal)

Package components reference

What gets installed

Component
Purpose

Connected App

OAuth 2.0 authentication with Kernel

Lightning App

Kernel Integration application container

Custom Tab

Kernel Setup configuration interface

Apex Classes

Integration logic and API handlers

LWC Components

User interface for setup and management

Permission Set

Default access configuration

Custom Settings

Store integration configuration

Static Resources

Application icons and assets

PreviousSalesforce integration
NextCustom Object

Last updated