Concierge Snippet and API – Chili Piper

Overview

With the Concierge Inbound Router, we offer two solutions to help convert your inbound leads into booked meetings:

Embedded Snippet: Just insert it in your form and post-form pages, everything will work the same as before except that your qualified prospects will be prompted to book a meeting with the right calendar at the right time.
JS API: Call Chili Piper from your JavaScript code, for full control of the workflow.
REST API. Server to Server. Most Advanced - Used primarily for InApp use-cases. Please contact support@chilipiper.com for more documentation around this method.

Getting Started

Make sure you create your Inbound Router in our admin. Directions on how to create your first inbound router here
You have to make sure your Salesforce settings are correct (you need a “Default Booker” with write access to create your leads in Salesforce).
Make sure you add the queues that specify rules for booking (e.g. mid-size companies get routed to the mid-size account executive team on a round robin basis).
At the bottom of the router, you will find the code you need to embed per below.

Embedded Snippet

Chili Piper embedded snippet collects data from forms in the background via the DOM.

The code to insert is:

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>ChiliPiper.scheduling("byte2bite", "inbound-router")</script>

where

ChiliPiper.scheduling(subdomain, router, options)

subdomain = sub domain of account
router = id of form scheduler
options = additional options (see below)

Javascript API

Insert marketing.js to your webpage.

Instead of passively using ChiliPiper.scheduling , have your javascript code call our ChiliPiper.submit function:

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>

Calling ChiliPiper.submit will trigger the following actions:

Collect form data if there is a form in the page (including hidden values) and/or receive key-value data as parameters in the Options object (they will be merged if you’re using both).
Call Chili Piper API endpoint.
1. Optionally (based on Concierge settings), the Lead/Contact will be created in Salesforce or updated if it exists, with the form values, including hidden value.
2. The Router’s logic will be executed (based on Queues) and return the booking calendar link.
The booking calendar is displayed in an iFrame in a lightbox
Once the slot is selected and the meeting is booked, you can choose among 3 options: 1) provide us with redirection settings, the user will be redirected or 2) use the onComplete parameter, onComplete call back will be executed or 3) nothing, the user can just close the box.

To pass on parameters, use the Salesforce Lead object’s data structure – you can find it at Workbench or Salesforce Developers. More details on the lead: {[Object]} option below.

Options

const options = {
   handleSubmit: boolean,
   formId: string,
   debug: boolean,      
   map: boolean,      
   domain: string,      
   router: string,      
   title: string,      
   titleStyle: string,  
   lead: {[Object]}    
   onSuccess: function,      
   onError: function,      
   onClose: function,      
   onRouted: function,   
   closeOnOutside: boolean,      
   dynamicRedirectLink: string,    
   mobileRedirectLink: string, 
   injectRootCss: boolean, 
   locale: language_code, 
   webHook: URL 
}

formId: string

Use this when you have multiple tags within 1 page to prevent the Chili Piper snippet from firing on your page upon submission of the wrong form. If you add this option, your snippet with ONLY execute when the form you specify is submitted.

<script>ChiliPiper.submit("account-name", "example-router", { 
formId: "form_Id" })</script>

map: boolean

If this is set to map: true we will rely on the form mapping within Chili Piper to ensure your form values are associated with the proper Lead / Contact object.

If this is set map: false we will assume you are submitting values in the Salesforce Lead Object format. Custom field names will not be supported and may be mapped incorrectly (or not at all) to Salesforce.

webHook: URL

To return the data upon booking to a specific location via webhook, and also to inform you of reschedules, re-assignment or cancellations, we need a webhook. We suggest that you pass the url for the webhook in each request, that way you can change it at any time. So you will add a parameter in the Booking Request. Works with ChiliPiper.submit(), ChiliPiper.scheduling(), ChiliPiper.getQuery(), and ChiliPiper.showCalendar().

Example:

<script>
ChiliPiper.submit("account-name", "example-router", { 
webHook: "https://hooks.zapier.com/hooks/catch/1127216/o1f1jpf/" 
})</script>

The post when the webhook fires will be of the following format: 	
{ 	   
"routeId: "5a7c654a2b52873a2ce5df57", 	
"eventId": "5b2124533a906b5f0bff32ad", 	  
"assigneeId": "00D1N000001S8LUUA0", 	
"actionType":"reassign", 	  
"slot": { 	   
"start": 1536355315, 	    
"end": 1536356315 	  } 	},

lead: {[Object]}

Helpful for running Chili Piper via a button click or within your webapp. Pass parameters directly to ChiliPiper.submit() - This only works when using ChiliPiper.submit() and does not work with ChiliPiper.scheduling().

<script>
ChiliPiper.submit("account-name", "example-router", { 
lead: { 
FirstName: "Test", 
LastName: "Test", 
Email: "test@test.com } })</script>

onSuccess: function

This will call a function after a successful booking. A time-specific redirect can be defined within the Router UI under "Router Redirect" so this option is not always required and is used with more custom form integrations.

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>
ChiliPiper.submit("account-name", "example-router", { 
onSuccess: someFunction() })</script>

onError: function

This will call a function when a lead is submitted but does not match any queue rules and cannot be routed, thus no calendar is displayed. This is usually when someone is disqualified from booking. A redirect can be specific within the Router UI under "Router Redirect" so this option is not always required and is used with more custom form integrations.

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>ChiliPiper.submit("account-name", "example-router", { onError: someFunction() })</script>

onClose: function

This will call a function when a lead is submitted and is displayed the option to book (meaning the lead has qualified for a meeting), but exits the booking module. A redirect can be specific within the Router UI under "Router Redirect" so this option is not always required and is used with more custom form integrations.

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>
ChiliPiper.submit("account-name", "example-router", { 
onClose: someFunction() })</script>

onRouted: function

This will call a function when a lead's submission has been received by Chili Piper and has matched to a queue and the calendar is displayed. This will occur before an onSuccess or onClose function is executed as it simply means they were routed and shown the calendar.

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>
ChiliPiper.submit("account-name", "example-router", { 
onRouted: someFunction() })</script>

closeOnOutside: boolean

This is a DOM listener option. By default, it is set to false and clicking the "X" within the booking module will close the calendar UI. When you set the option closeOnOutside: true, this will allow the Chili Piper booking module to be "closed" when then lead clicks outside of the booking frame. Any redirect settings for those who don't book or the onClose: function will be triggered when the lead clicks outside of the module. For conversion purposes for preventing accidental closures, we recommend against enabling this option unless there is a specific reason.

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>
ChiliPiper.submit("account-name", "example-router", { 
closeOnOutside: true })</script>

dynamicRedirectLink: string

This will overwrite all redirect options for all browsers and redirect to that url, both on success and if the user exits before booking. The url can be anything so you can pass us dynamic variables such as the lead ID

Ex: dynamicRedirectLink: "https://www.chilipiper.com"

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>ChiliPiper.submit("account-name", "example-router", { 
dynamicRedirectLink: "https://www.chilipiper.com" })</script>

mobileRedirectLink: string

This will only redirect mobile browsers (and some old IE browsers). It will redirect both on success and on premature exits. For other browsers, the behavior selected in our app settings will apply.

Ex: mobileRedirectLink: "https://www.chilipiper.com"

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>ChiliPiper.submit("account-name", "example-router", { 
mobileRedirectLink: "https://www.chilipiper.com" })</script>

injectRootCss: boolean

If you set injectRootCss: true as an option, then this allows you to add styling to the loading of the Chili Piper calendar. This will allow you to inject styling for the following page elements with your inApp Chili Piper preferences. .chilipiper-popup-window; .fabe-book-loading; .routing-loader; .routing-loader-body; .routing-loader-body span;

Learn more about custom CSS.

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>ChiliPiper.submit("account-name", "example-router", { 
injectRootCss: true })</script>

locale: language_code

This allows you to force a certain language in which you would like to serve the Chili Piper calendar in for the respective page/user.

Requirements: You must have the language enabled in your Global Master Admin Language settings.

Here are all the supported languages and respective locale codes to use when passing this parameter to us.

Ex:

<script src="https://js.chilipiper.com/marketing.js" type="text/javascript"></script>
<script>ChiliPiper.scheduling("account-name", "router-name", { 
locale: "de_DE" })</script>

The example above would force the calendar to render in German, regardless of the users' browser settings, per the { locale: "de_DE" } option.

To set the options outside of the main script tag:

const options = {      onSuccess: function(data){          // ...      }, } ChiliPiper.submit("byte2bite", "inbound-router", options)

Overview

Getting Started

Embedded Snippet

Javascript API

Options

Related articles