SalesForce Pre-Requisites

Setting Up the Salesforce Environment

Pre-requisites for your Salesforce environment before setting up the Zykrr integration.

If a user with the necessary license and permissions is available, that account should be used; otherwise, a new user must be created using the steps given below.

Confirm License Availability
  1. You’ll ideally need a “Salesforce Integration” user license. Salesforce provides a limited number of these with certain editions.
  2. If you don’t have an available “Salesforce Integration” license:
    – You may need to purchase additional licenses from Salesforce. – Alternatively, you can use a standard “Salesforce” license. If using this license, you will need to assign either the “System Administrator” profile or, preferably, a custom profile with the minimum required permissions.

Create a Salesforce Integration User

  1. Login to Salesforce as an administrator.
  2. Navigate to Setup (gear icon) > Users > Users.
  3. Click New User.
  4. Follow your company’s naming conventions. It’s recommended to include the integration name in the username for clarity.

nu_sf1 5. Fill in the user details:
- First Name: (Optional) - Last Name: (e.g., Integration - User-Zykrr) - Email: Use a dedicated email address (e.g., integration_user_zykrr@yourdomain.com) - Username: Must be unique (e.g., integration_user_zykrr@yourdomain.com) - User License: Select “Salesforce Integration” if available. If not, select Salesforce”. - Profile:
- If using the “Salesforce Integration” license, select “Salesforce API Only System Integrations”. - If using the “Salesforce” license, assign the “System Administrator” profile or a custom profile created specifically for this integration (cloned from “System Administrator” but with reduced privileges – see permission set details below).

  • Role: Assign an appropriate role based on your hierarchy, or create a new one (eg., “Integration User”).
  1. Click- Save.

Assign Permissions (Choose ONE Method)

Method 1: Assign the “Salesforce API Integration” Permission Set License (If using “Salesforce Integration” User License) This license grants the necessary API access automatically.

nu_sf2

  1. On the newly created user’s detail page, navigate to the “Permission Set License Assignments” section.
  2. Click “Edit Assignments”.

nu_sf3 3. Find “Salesforce API Integration” in the list. 4. Check the box next to it to enable it. 5. Click Save.

Method 2: Create and Assign a Custom Permission Set (Recommended, Especially if using “Salesforce” User License) Using a custom permission set provides more granular control and follows the principle of least privilege.

nu_sf4

  1. Navigate to Setup > Users > Permission Sets.
  2. Click New.

nu_sf5 3. Enter details:

  • Label: Give it a descriptive name (e.g., Zykrr_Integration_Access).
  • License: Select “Salesforce API Integration” if available and applicable based on the user license chosen. If not available or needed, leave as “–None–”.
  1. Click Save.

nu_sf7 5. Configure the necessary permissions within the newly created Permission Set:

  • Object Settings: Define object-level permissions (Read, Create, Edit) for all objects the Zykrr integration needs access to (e.g., Account, Contact, Lead, Case, etc.). Grant the minimum necessary permissions:
    • Read Access: For any objects/fields to be pulled from Salesforce into Zykrr.
    • Create Access: For any objects Zykrr needs to insert into Salesforce.
    • Edit Access: For any objects Zykrr needs to update in Salesforce. (Note: The original document mentioned “Modify All”, but “Edit Access” on the object combined with field-level edit permissions is generally sufficient and safer unless mass updates are truly required).
    • View All/Modify All: Grant these cautiously. “View All” might be needed for related objects during inserts/updates, if Zykrr logic requires broad visibility. “Modify All” grants extensive update permissions.
  • Field Permissions: Within each object specified in Object Settings, set Field-Level Security. Grant Read or Edit access only to the specific fields the integration needs to interact with. Follow the principle of least privilege.

nu_sf8

  • System Permissions: Grant necessary system-level permissions. Critically, ensure the following is enabled:
    -“API Enabled”: Essential for any integration user.
  1. Click Save after configuring permissions.
  2. Assign the Permission Set to the Integration User:
    • Go back to the Integration User’s detail page.
    • In the “Permission Set Assignments” section, click “Edit Assignments”.
    • Find custom permission set (e.g., Zykrr_Integration_Access) in the “Available Permission Sets” list and add it to the “Enabled Permission Sets” list using the Add arrow.
    • Click Save.

Create a Connected App for Zykrr Integration

This allows Zykrr to authenticate and connect to your Salesforce instance via the API.

  1. Login to Salesforce as an administrator.
  2. Navigate to Setup (gear icon) > Apps > External Client App > External Client App Manager.

nu_sf9 3. Click New Client App. 4. Fill in Basic Information:

  • External Client App Name: Enter Zykrr Integration or a similar descriptive name.
  • API Name: This should auto-populate based on the name.
  • Contact Email: Enter an appropriate administrative email address.

nu_sf10 5. Configure API (Enable OAuth Settings):

  • Check Enable OAuth Settings.
  • Callback URL: Enter https://login.salesforce.com/services/oauth2/callback (or verify if Zykrr requires a different specific callback URL).
  • Selected OAuth Scopes: Select the permissions Zykrr needs. Choose either:
    • Full Access (full) - Grants broad access.
    • Perform requests at any time (refresh_token, offline_access) - Allows Zykrr to maintain connection.
    • OR (Recommended - Least Privilege): Select specific scopes. Minimally include:
      • Access and manage your data (api)
      • Perform requests on your behalf at any time (refresh_token, offline_access)
      • Add other scopes only if explicitly required by Zykrr features.

nu_sf11

  • Require Secret for Web Server Flow: Keep this checked (Recommended).
  • Require Secret for Refresh Token Flow: Keep this checked (Recommended).
  1. Click Save. You might see a message that changes can take a few minutes to take effect; click Continue.

Create Remote Site Settings

If Zykrr needs to make calls back into Salesforce from its servers, configure Remote Site Settings.

nu_sf12

  1. Navigate to Setup (gear icon) > Security > Remote Site Settings.
  2. Click New Remote Site.
  3. Enter details for the first site:
  4. Click Save & New.

nu_sf13 5. Enter details for the second site:

  1. Click Save.

Check Network Access (If Applicable)

If your organization restricts Salesforce access based on IP address ranges:

  1. Navigate to Setup (gear icon) > Security > Network Access.
  2. Check if Zykrr’s server IP addresses are listed as Trusted IP Ranges.
  3. If not, you will need to obtain the correct IP addresses or range(s) from Zykrr support or documentation and add them here.

Updated on 14 Aug 2025