Installing and configuring the “Contractbook app” package in Salesforce
Installing the "Contractbook App" package in Salesforce is required to use the Flow is completed trigger in Contractbook's Automation Builder.
Once configured, this package adds two key features to your Salesforce environment:
"Create contract in Contractbook" Quick Action:
Allows users to generate contracts from predefined automations directly from standard Salesforce objects (Opportunity, Account, Contact, Order, Quote, or Quote CPQ).
"Contractbook contracts" Widget:
A Lightning Web Component that displays the status and creation date of all contracts generated from a specific Salesforce record.
Here is how to set up the package in your Salesforce organization.
Configuration steps
Install the Salesforce package:
Ensure your organizations match.
Follow the installation link for the Contractbook App package.
When prompted, select Install for all users. You must install this package in the exact same Salesforce organization that you authenticated when connecting via the Integrations tab in Contractbook.
Generate a Contractbook API key:
Log into Contractbook, navigate to Profile Settings, and select Contractbook's API.
Click Add.
Give the integration a recognizable name like "Salesforce" and leave the Callback URL blank.
Copy the generated API access key value to your clipboard.
Configure Named Credentials in Salesforce:
In Salesforce, go to Setup, navigate to Security, and select Named Credentials.
Open the Contractbook Named credential. Next, find External Credential and click on Contractbook External Credentials.
Under the Principals section, locate Contractbook API and choose Edit from the Actions menu.
Under Authentication Parameters, click Add.
Enter apikey for the Name, paste your Contractbook API access key into the Value field, and click Save.
Assign user permissions:
The package includes a Contractbook User permission set.
Assign this to any user or group that needs to use the contract creation flow.
Additionally, ensure the primary user's profile has Read permissions for the User External Credentials setting, and that any user accessing the flow has the Flow user option checked in their Salesforce User settings.
Update page layouts:
Navigate to the Edit Page settings in Salesforce for every object type you want to generate contracts from.
Add the Create contract in Contractbook quick action and the Contractbook Contracts widget to the layout.
The quick action is pre-installed for Opportunity, Account, Contact, and Order objects
Missing the Quick Action for Quotes?
The package automatically pre-creates the quick action for Opportunities, Accounts, Contacts, and Orders. If you need this button on a Quote or Quote CPQ object, you must configure it manually.
Go to Setup and open the Object Manager.
Search for and select Quote.
Click Buttons, Links, and Actions in the left sidebar.
Click New action.
Set the Action Type to Flow.
Set the Flow to Execute Contractbook Automation.
In the Label field, type Create contract in Contractbook.
Leave the remaining default settings and click Save.
The quick action is now available to be added to your Quote page layouts.
Helpful guides: