Skip to main content

Databook Salesforce Integration: Installation guide

This guide helps you through setting up your Salesforce org to work with Databook using an External Client App.

Written by Geetanjali Sharma

Before you begin connecting Databook to your Salesforce instance, please complete the steps below to ensure a successful configuration.
​

Checklist before installing

Complete these checks before installing or connecting Databook. If any of them fail, the connection won't work.
​

1. Confirm your Salesforce edition has API access

Your Salesforce edition must include API access. Without it, the integration cannot connect. Check Salesforce's API access by edition. If your edition does not include API access, contact your Salesforce account representative to upgrade.
​

A quick glossary

A few Salesforce terms come up throughout this guide:

  • License — Purchased from Salesforce; sets the maximum permissions a user can receive. Which license you need depends on who's connecting Databook — see Choose credentials and grant access below.

  • Profile — Controls object, field, and feature access. Each user has exactly one profile (standard or custom), tied to one license. System Administrator is a profile, not a license.

  • Permission set — Extra permissions layered on top of a profile. Users can have multiple permission sets, and each set is tied to a license.

Setting up the integration

Install the Databook package

The developer will provide a **package install URL**. Install the package **before** connecting Salesforce inside Databook, or OAuth will fail.

  1. Open the package install URL provided by your Databook contact.

  2. Log in to your Salesforce org if prompted.

  3. Select **Install for All Users**.

  4. Check the acknowledgement checkbox.

  5. Click **Install**.

You will see a progress screen while the installation completes.

Once complete, you should see a confirmation screen:

To verify, go to **Setup**, search for **Installed Packages**, and confirm the package appears in the list.


​

Choose credentials and grant access

Pick one of the two options below for connecting Databook, then grant the required permissions.

Required system permissions (enable these on the profile or permission set you configure):

  • API Enabled

  • If your Databook setup includes real-time Subscribe Actions, also enable the Subscribe Action permissions

  • If you want quota optimization enabled, also enable the Quota optimazation permissions

See this article for a list of the required Salesforce permissions

Option A: Human user

Use one of the following:

  • System Administrator — Already on a supported license (System Administrator is a profile on the Salesforce license). You'll still need to grant the correct object and field permissions, since they aren't always included by default.

  • Sales team member or other human user — Must have the Salesforce User License. The Salesforce Platform User License is not sufficient. This user can have a standard profile (such as Standard User) or a custom profile.

1. Configure system permissions

In Setup, search for Profiles in the Quick Find box and open it.

  1. Select the profile you'd like to view and edit.

  2. Click Edit at the top of the page.
    ​

    Edit profile

  3. Ensure the checkboxes for the required system permissions (listed above) are checked.

  4. Click Save.

2a. Field permissions for a standard profile

If the user has a standard profile (such as Standard User):

  1. Click the gear icon in the top-right corner and select Setup.

  2. In the left-hand search bar, type Object Manager and open it.
    ​

    Setup Object Manager

  3. Choose the object Databook needs (for example, Account), then select Fields & Relationships from the left navbar.
    ​

    Setup Object Manager Account

  4. Find the field you want to adjust and click it.

  5. Click Set Field-Level Security.
    ​

    Set Field Level Security

  6. Ensure Visible is selected for the profile. If the profile isn't in the list, it doesn't have access to the object, and that can't be changed here.
    ​

    Check Visible for profile

  7. Repeat steps 4–6 for every field Databook needs to read, especially custom fields.

2b. Object and field permissions for a custom profile

If the user has a custom profile:

  1. Click the gear icon in the top-right corner and select Setup.

  2. In the left-hand search bar, type Object Manager and open it.
    ​

    Setup Object Manager

  3. Choose the object Databook needs (for example, Account) and go to Object Access in the left navbar. Select the Profiles tab, click Edit, and grant the necessary permissions for your custom profile.

    • If the integration needs to read data, ensure Read, View All Records, and View All Fields are checked.

    • If the integration needs to write data, ensure all boxes are checked.
      ​

    Edit Object Access


Option B: Salesforce Integration user

Use a Salesforce Integration user when you want an API-only identity with no Salesforce UI access. Create the user with the Salesforce Integration license (steps below).

1. Create a new user

  1. Click the gear icon in the top-right corner and select Setup.

  2. In the left-hand search bar, type Users and open it.

  3. Create a new user:

    • For User License, select Salesforce Integration.

    • For Profile, select Minimum Access - API Only Integrations.

2. Create a permission set

  1. Click the gear icon in the top-right corner and select Setup.

  2. In the left-hand search bar, type Permission Sets and open it.

  3. Click New.
    ​

  4. Create the permission set:

    • Name it something general (for example, "Integration User Permission Set") or describe the access (for example, "Account and Contact Access").

    • In the License dropdown, select Salesforce API Integration.
      ​

3. Configure object permissions

  1. Click Object Settings.
    ​

  2. For each object Databook needs (for example, Accounts), open it.
    ​

  3. Check the relevant boxes under Object Permissions and Field Permissions, then click Save.
    ​

  4. Repeat for every object Databook needs to access.

4. Configure system permissions

  1. Select System Permissions.
    ​

  2. Ensure the required system permissions (listed at the start of this section) are selected, then click Save.
    ​


5. Assign the permission set to the integration user

  1. Click Manage Assignments.
    ​

  2. Click Add Assignment.
    ​

  3. Select the integration user you created in step 1.
    ​

  4. Set Expires On to Never Expires, then click Assign.
    ​


After installing the integration

After installing Databook, configure OAuth policies so the integration can maintain a stable connection.

  1. Log in to Salesforce

  2. Go to Setup.

  3. In the Quick Find box, search for External Client App Manager.

  4. Click the name of the installed External Client App.

  5. Go to the Policies tab and click Edit.

  6. Under OAuth Policies, set Permitted Users to All users may self-authorize.

  7. Under App Authorization:

    • Set Refresh Token Policy to Refresh token is valid until revoked.

    • Set IP Relaxation to Relax IP restrictions.

  8. Click Save.



Subscribe Action permissions

If your Databook setup includes Subscribe Actions, enable these permissions on the profile (Option A) or permission set (Option B) you configured above.


Explicitly enable:

  • Modify Metadata Through Metadata API Functions — configures event channels and memberships through the Metadata API

  • Customize Application — configures artifacts like Named Credentials so Databook can connect to event channels securely

Salesforce auto-enables these dependent permissions when you enable the ones above:

  • View Setup and Configuration — access to setup configuration to create webhook subscription settings

  • View Roles and Role Hierarchy — gives correct visibility context so Salesforce can deliver events (without this, events may be generated but not delivered)

  • Manage Custom Permissions — create and manage dedicated event channels and channel memberships for the installation


Enable these on the profile (Option A, step 1) or permission set (Option B, step 4) you configured above.
​

Quota optimization permissions

Quota optimization requires these permissions in addition to the Subscribe Action Permissions above, enabled on the same profile or permission set:

  • Author Apex — required to write and deploy an Apex trigger used by the optimization

  • Manage Profiles and Permission Sets and Assign Permission Sets — required so Databook can create a dedicated permission set to manage field access and field-level security for a custom checkbox field

Enable these on the profile (Option A, step 1) or permission set (Option B, step 4) you configured above.

Related Articles
Did this answer your question?