Chili Piper

https://help.chilipiper.com/hc/
Admin
Chili Piper is a sales engagement platform that combines lead distribution, scheduling, and chatbot...
Tokens:147,260
Snippets:2,698
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Chili Piper Skills via Claude Code CLI

Source: https://help.chilipiper.com/hc/en-us/articles/52876890633235-Chili-Piper-Skills-AI-recipes

Use these commands in the Claude Code CLI to add the marketplace and install the Chili Piper Skills plugin.

```bash
/plugin marketplace add https://github.com/Chili-Piper/mcp-assets
/plugin install chili-piper-skills@chili-piper-skills
```

--------------------------------

### Implement full announcement configuration

Source: https://help.chilipiper.com/hc/en-us/articles/54415929492371-Creating-an-Announcement-Flow

A complete configuration example for integrating the announcement banner with a fixed header using the push mode.

```html
<script>
  window.ChiliChat = {
    config: {
      workspaceId: 'your-workspace-id',
      tenantId: 'your-tenant-id',
      chatUrl: 'https://your-tenant.chilipiper.com/chat/widget/',
      announcementPlacement: {
        mode: 'push',
        shiftElements: ['header.header'],
      },
    },
  };
</script>
```

--------------------------------

### Ownership Scheduling Link with Smart Parameters

Source: https://help.chilipiper.com/hc/en-us/articles/35832959705619-Ownership-Scheduling-Links

Examples of Ownership Scheduling Links configured with email addresses or CRM IDs.

```text
https://fire.chilipiper.com/ownership/contact-owner?id=john_doe@acme.com
```

```text
https://fire.chilipiper.com/ownership/contact-owner?id=0035g00002A9tQXAA0
```

--------------------------------

### Appending Smart Parameters to URLs

Source: https://help.chilipiper.com/hc/en-us/articles/50205484604051-Setting-up-Smart-Parameters-for-Chat

Examples of how to append single and multiple smart parameters to your page URL as query strings.

```text
https://yoursite.com/pricing?campaign_id=512301234
```

```text
https://yoursite.com/pricing?campaign_id=512301234&gclid=def456
```

--------------------------------

### Initialize a scheduling session

Source: https://help.chilipiper.com/hc/en-us/articles/50860790980627-How-do-I-Schedule-Chili-Piper-Meetings-Programmatically

Use this request to start a session and retrieve available time slots for a specific scheduling link.

```curl
curl -X POST \
  "https://fire.chilipiper.com/api/fire-edge/v1/org/schedulingLinks/init-simple" \
  -H "Authorization: Bearer $CHILI_PIPER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "link": { "type": "RoundRobin", "linkId": "[linkId]" },
    "interval": { "startsAt": "2026-04-14T00:00:00Z", "duration": "7 days" }
  }'
```

--------------------------------

### POST /schedulingLinks/init-simple

Source: https://help.chilipiper.com/hc/en-us/articles/50860790980627-How-do-I-Schedule-Chili-Piper-Meetings-Programmatically

Initializes a scheduling session for a specific link and returns available slots.

```APIDOC
## POST /schedulingLinks/init-simple

### Description
Initializes a scheduling session and returns available slots for a given scheduling link.

### Method
POST

### Endpoint
https://fire.chilipiper.com/api/fire-edge/v1/org/schedulingLinks/init-simple

### Request Body
- **link** (object) - Required - The link reference containing type and linkId.
- **interval** (object) - Required - The time range for availability (startsAt, duration).
- **guestEmail** (string) - Optional - Required for Ownership links to resolve the owner from CRM.

### Request Example
{
  "link": { "type": "RoundRobin", "linkId": "[linkId]" },
  "interval": { "startsAt": "2026-04-14T00:00:00Z", "duration": "7 days" }
}

### Response
- **routeId** (string) - Identifier for the initialized session.
- **startTimes** (array) - List of available meeting slots.
```

--------------------------------

### Capture timeslot-selected event data

Source: https://help.chilipiper.com/hc/en-us/articles/1500011381522-Capturing-Javascript-Messaging-in-Browser

Example of the data structure returned when a prospect selects a timeslot.

```json
{"action":"timeslot-selected", "args":{"time":"2023-08-24T12:30:00.000Z", "timezone":"America/Chicago", "duration":30}}
```

--------------------------------

### Configure ChiliPiper.getQuery

Source: https://help.chilipiper.com/hc/en-us/articles/360053021574-Running-Form-Concierge-Using-Query-String-Parameters

Include the Concierge script and initialize the router with a specific query variable to trigger the booking flow.

```html
<script id="chilipiper-concierge" src="https://**YOUR_DOMAIN**.chilipiper.com/concierge-js/cjs/concierge.js" crossorigin="anonymous" type="text/javascript"></script>  
<script>ChiliPiper.getQuery("**YOUR_DOMAIN**", "router", { queryVariable: "Email" })</script>
```

--------------------------------

### UNABLE_TO_LOCK_ROW Error Response

Source: https://help.chilipiper.com/hc/en-us/articles/1500003160981-Common-Salesforce-API-Error-Codes

Example of the error returned when a record is locked by another system process.

```text
[Error extendedErrorDetails='{[0]}'  
fields='{[0]}'  
message='unable to obtain exclusive access to this record'  
statusCode='UNABLE_TO_LOCK_ROW'  
]
```

--------------------------------

### Install the Concierge Script

Source: https://help.chilipiper.com/hc/en-us/articles/32588330506643-Concierge-Snippet-and-JS-API

The unique script tag required to load the Chili Piper library on your page.

```html
<script src="https://subdomain.chilipiper.com/concierge-js/cjs/concierge.js" type="text/javascript"></script>
```

--------------------------------

### Example Thank You Page URL with Query Parameters

Source: https://help.chilipiper.com/hc/en-us/articles/36020992678675-Chili-Piper-Gravity-Forms-Redirect-to-Thank-you-page-for-booking-in-Concierge

A sample URL structure showing how form field values are appended as query parameters after a Gravity Form submission.

```text
https://chilipiper.com/thank-you-page?FirstName=value&LastName=value&Email=value&Company=value
```

--------------------------------

### POST /handoff/workspace/{workspaceId}/booker/{userId}/init-simple

Source: https://help.chilipiper.com/hc/en-us/articles/50860790980627-How-do-I-Schedule-Chili-Piper-Meetings-Programmatically

Initializes a handoff request to evaluate routing paths and return available time slots based on guest email or CRM record.

```APIDOC
## POST /handoff/workspace/{workspaceId}/booker/{userId}/init-simple

### Description
Evaluates routing paths and returns available time slots for a lead handoff.

### Method
POST

### Endpoint
https://fire.chilipiper.com/api/fire-edge/v1/org/handoff/workspace/{workspaceId}/booker/{userId}/init-simple

### Parameters
#### Path Parameters
- **workspaceId** (string) - Required - The ID of the workspace.
- **userId** (string) - Required - The Chili Piper user ID of the rep initiating the handoff.

#### Request Body
- **type** (string) - Required - Must be "GuestEmailRequest" or "CrmRequest".
- **guestEmail** (string) - Optional - The guest's email address (required if type is GuestEmailRequest).
- **id** (string) - Optional - The CRM record ID (required if type is CrmRequest).
- **interval** (object) - Required - Object containing startsAt and duration.
- **routerId** (string) - Optional - Target a specific router.
- **crmExplicits** (object) - Optional - Additional CRM context.

### Request Example
{
  "type": "GuestEmailRequest",
  "guestEmail": "lead@example.com",
  "interval": { "startsAt": "2026-04-14T00:00:00Z", "duration": "7 days" }
}
```

--------------------------------

### SOQL Query Example

Source: https://help.chilipiper.com/hc/en-us/articles/52008656041619-How-do-I-set-up-a-Scheduled-Trigger-Flow-in-Distro

A basic SOQL query for record processing that must include the Id field.

```sql
SELECT Id FROM Lead
```

--------------------------------

### Example Booking Link URL

Source: https://help.chilipiper.com/hc/en-us/articles/360053799093-Relate-a-Meeting-to-Salesforce-Case

A sample URL structure demonstrating how to append the prospect's email and the Salesforce Case ID to a Chili Piper booking link.

```text
https://mycompany.chilipiper.com/book/me/my-name
```

```text
https://mycompany.chilipiper.com/book/me/my-name?id=someaccount@domain.com&caseId=5000W00001Dx07y
```

--------------------------------

### Capture booked event data

Source: https://help.chilipiper.com/hc/en-us/articles/1500011381522-Capturing-Javascript-Messaging-in-Browser

Example of the data structure returned for a booked event, containing the routeId.

```json
{ routeId: "5a7c654a2b52873a2ce5df57" }
```

--------------------------------

### FIELD_CUSTOM_VALIDATION_EXCEPTION Error Structure

Source: https://help.chilipiper.com/hc/en-us/articles/1500003160981-Common-Salesforce-API-Error-Codes

Example of a validation rule error indicating a missing or invalid field value.

```text
fields='{[1]Salesperson__c,}'  
  
message='Salesperson is a required field.'
```

```text
  Salesforce API Error. Can't update prospect None: [SaveResult errors='{[1][Error extendedErrorDetails='{[0]}'  
  fields='{[0]}'  
  message='Hi! Please add an email to the Lead prior to creating the new record.'  
  statusCode='FIELD_CUSTOM_VALIDATION_EXCEPTION'
```

--------------------------------

### Create a Definition List

Source: https://help.chilipiper.com/hc/en-us/articles/23968833835411-Meeting-Types-and-Reminders-Enhanced-with-HTML

Use <dl>, <dt>, and <dd> tags to structure glossary or FAQ-style content.

```html
<dl>  
 <dt>Topic 1</dt>  
 <dd>- Sub-Topic 1</dd>  
 <dt>Topic 2</dt>  
 <dd>- Sub-Topic 2</dd>  
</dl>
```

--------------------------------

### Configure announcement placement in the installation snippet

Source: https://help.chilipiper.com/hc/en-us/articles/54415929492371-Creating-an-Announcement-Flow

Add the announcementPlacement object to the window.ChiliChat.config block to define banner behavior.

```javascript
<script>
  window.ChiliChat = {
    config: {
      workspaceId: 'your-workspace-id',
      tenantId: 'your-tenant-id',
      // ...your existing config...
      announcementPlacement: {
        mode: 'push',
      },
    },
  };
</script>
```
Tokens:
Raw