Creating a button on the page layout to launch Chili Piper's Instant Booker is an easy way to take advantage of Chili Piper inside of Salesforce.
While "Links" can be created and used in some situations as well for booking or sharing via email or API, this article will focus on the instructions for creating a Custom Button within Salesforce Setup that loads the internal-only Instant Booker and/or the Hot Handoff module.
It is also possible to use a Salesforce Screenflow to load Chili Piper, should you need the User to take some action or update fields before the User loads Chili Piper to book a meeting. The URLs for the buttons listed below will also work and be supported via Screenflows as well.
Once setup, the End User must have a logged in session with Chili Piper access the Instant Booker Interface
This article will cover:
- Instructions for creating a Custom Button in Salesforce to book meetings via the Chili Piper Instant Booker
- Considerations and details for the following objects:
- Lead
- Contact
- Opportunity
- Case
- Account
- PersonAccount
- Custom Objects
- How to add the Custom Button to your Page Layout in Salesforce
Creating Salesforce Custom Button
- Navigate to "Object Manager" in Salesforce Setup
- Search for the Object you wish to create the button
- Click Into "Buttons, Links, and Actions" → "Add Button or Link"
- Name the Label, add a description (optional), select:
- Display Type: "Detail Page Button"
- Behavior: "Display in a new window"
- Content Source: "URL"
Choose the Correct URL to add into Salesforce
Chili Piper requires 1 of 3 types of values from within Salesforce for finding an email address to be able to schedule a meeting on the calendar:
- Lead Id
- Contact Id
- Email Address
Chili Piper accepts both 15-digit (classic) and 18-digit (lightning) Salesforce Id's for passing the value.
Lead Object
Instant Booker - Handoff (most common)
https://api.chilipiper.com/calendar/lead/{!Lead.Id}
Hot Handoff (Fire Icon) - reference
https://api.chilipiper.com/handoff/lead/{!Lead.Id}
Salesforce Events related to Lead records cannot also be related to other Objects, meaning passing an opportunityId, caseId, or objectId will not result in an Event created related to the record passed in the URL.
Contact Object
Instant Booker - Handoff (most common)
https://api.chilipiper.com/calendar/contact/{!Contact.Id}
Hot Handoff (Fire Icon)
https://api.chilipiper.com/handoff/contact/{!Contact.Id}
Person Account Object
https://ib.chilipiper.com/?prospect={!Account. PersonEmail}
Routing by and Relating to Opportunity, Case, and Custom Objects
For Routing, Reporting, and Automation Purposes other Object Record Id's can be passed to Chili Piper. Using opportunityId, caseId, or objectId from the Custom Button will override any settings around Event relationships as defined in the CRM Actions of your Workspace.
Opportunity Object
https://api.chilipiper.com/calendar/contact/{!Contact.Id}?opportunityId={!Opportunity.Id}
In this example URL, we are using the standard "Primary Contact" field to book a meeting. A primary Contact must be defined on the Opportunity to be able to schedule a meeting.
When the 'opportunityId' parameter is used, it will result in the Instant Booker using the defined Record to use against any "Opportunity-Based" rules setup within Chili Piper for Queues active in the 'Handoff Router'.
Additionally, when Chili Piper creates an Event within Salesforce using this format, the Event's "WhatId" will be set with the Opportunity Id passed, which can be useful for things like updating the Owner of an Opportunity using a Salesforce Flow.
For the Opportunity Object, your setup should look like the setup in the image below
Case Object
https://api.chilipiper.com/calendar/contact/{!Contact.Id}?caseId={!Case.Id}
When the 'caseId' parameter is used, it will result in the Instant Booker using the defined Record to use against any "Case-Based" rules setup within Chili Piper for Queues active in the 'Handoff Router'.
Additionally, when Chili Piper creates an Event within Salesforce using this format, the Event's "WhatId" will be set with the Case Id passed, which can be useful for things like updating the Owner of an Case using a Salesforce Flow.
We also recommend reading this article to learn more about routing and relate Events to an existing Case
Custom Object
https://api.chilipiper.com/calendar/contact/{!Custom_Obj.Contact__c}?objectId={!Custom_Obj.Id}&customObjectId={!Custom_Obj.Id}
If you are routing by or relating to a Custom Object, the Contact Id are not on the object's layout by default. As such, you'll may need to add a custom lookup field on the custom object that references the related Contact's Id or Email Address for the Button to work.
Once you have a Contact Id or Email Address available on the Custom Object Record, you can use a tag like {!Custom_Obj.Contact__c} where "Custom_Obj" is your object name and "Contact__c" is the custom field name. These names will vary depending on how you set them up.
If you have multiple custom object records related to the Lead/Contact, you will want to also pass one additional parameter customObjectId={!Custom_Obj.Id} so that Chili Piper knows which of the Related Custom Object Records to route against via your Queue Rules.
You may need to ask support@chilipiper.com or your CSM to enable Custom Object-Based Routing for your Instant of Chili Piper. See this article for more details.
Using an Email Address
https://ib.chilipiper.com/?prospect={!Object. Email__c}
We recommend using the Lead Id or Contact Id if available on the record to pass to Chili Piper, otherwise referencing the Email Address will work as well.
If duplicates records existing when referencing the email address, Chili Piper will allow the user booking the meeting to choose between the duplicate records in Salesforce to select the right on.If Chili Piper is unable to find a record within Salesforce using the Email Address, the User will be able to create a new Lead or Contact record within Salesforce directly from the Instant Booker.
Add button to the layout
Once your Custom Button is created on the respective Object, the next step is adding the Button to the Salesforce Page Layout so that End Users are able to access and click on the Button to load Chili Piper.
- In "Object Manager," in the Object you added the Custom Button, select "Page Layout" and choose the Page Layout you wish to apply the Button to.
- Click on "Buttons", search for the Button you created in the previous steps, and Drag the button into the "Custom Buttons" Section of the Page Layout.
3. Now that the Custom Button is available in Custom Buttons, navigate to a real Opportunity record, click the Gear Icon on the page → "Edit Page"
4. Click into the "Highlight Panel", then click "Add Actions" on the Right Panel, search for the name of the Button that you created, and Add it to the Page
Note: Salesforce Lightning Page Layouts have a maximum amount of 10 Visible Action Buttons
5. Click "Save" in the top right and your Custom Button to book meetings will be Live.
Visualize Page
When you click the Button, you should expect to see the Chili Piper Instant Booker open, using the Name and Email Address of the respective Lead or Contact that you are booking with.