Skip to main content

Custom Webhook Configuration

Chad Allard
  • Updated

Who can use this feature?

Available on ChiliCal Chat Concierge Handoff
Available to Admins Workspace Managers
Billing Center Get a Demo

A wehhook is a way for Chili Piper to communicate with another system. Without that system having to constantly ask for updates, Chili Piper will actively push data to that system in order for it to be used in reporting, data warehouses, or for triggering automations.

Chili Piper allows you to send booked meeting data to webhooks of your choice. You are not limited by the number of webhooks you have.

The Custom Webhooks feature can be found within the Integrations pane in the Admin Center.

Creating a Webhook

From the webhook management page, you will see a button to "Create Custom Webhook". Clicking this presents you with the type of webhook you would like to create.

You can have multiple webhook types have the same webhook URL, and multiple webhook URLs for the same type.

  • For New Meeting
    • Triggers for every new meeting booked, regardless of the source, we will push information to this location.
  • For Meeting Update
    • Triggered whenever a meeting is updated, for example if it's reassigned or rescheduled.
  • For Canceled Meeting
    • Triggers when a user or prospect cancels the meeting from any via source. 

 

Once you select an option, the setup is simple - paste in your webhook URL into the text field provided and click "Create".

Be sure to click "Enabled" on the status after creating in order for it to be active.

Managing Webhooks

All webhooks created will appear in the integration menu in the order they were created:

The 3 dots within the row provide a menu to delete the webhook entirely if needed. 

Once added and "Enabled" a webhook will begin capturing responses immediately. If the target webhook URL is set up to receive them, it should begin receiving data as soon as the next action type is triggered. 

Webhook Request Body (Schema)

The webhook will send to the target URL with the following body format provided.

Note that example data has been provided for clarity below but may differ from actual results:

{
  "meetingIdChili": "123e4567-e89b-12d3-a456-426614174000",
  "meetingTitle": "🔥 Demo Meeting: Support Call",
  "meetingDescription": "Looking forward to our meeting. \n\nIf you need to reschedule,
  please click the link below: https://calendar.example.com/reschedule/123e4567-e89b-12d3-a456-426614174000\n\nIf
  you would like to cancel, please click the link below: https://fire.chilipiper.com/cancel/123e4567-e89b-12d3-a456-426614174000\n\nEmail:
  demo@example.com",
  "meetingLocation": "https://example.zoom.us/j/1234567890",
  "meetingStartTime": "2025-03-21T20:30:00Z",
  "meetingEndTime": "2025-03-21T20:45:00Z",
  "primaryGuestTimeZone": "America/New_York",
  "hostEmail": "host@example.com",
  "hostFullName": "Alex Johnson",
  "hostIdChili": "987f6543-b21a-45c3-b123-5678d9e0f123",
  "assigneeEmail": "support@example.com",
  "assigneeFullName": "Jordan Smith",
  "assigneeIdChili": "654f3210-c98b-44d3-b432-890a1b2c3d45",
  "primaryGuestEmail": "demo@example.com",
  "primaryGuestDataFields": {
    "Email": "demo@example.com"
  },
  "additionalGuests": [
  {
    "email": "guest1@example.com",
    "fullName": "Taylor Williams"
  }],
  "bookerEmail": "booker@example.com",
  "bookerName": "Chris Davis",
  "bookerIdChili": "f123a456-789b-12d3-c456-789e012f3456",
  "workspaceName": "Customer Experience",
  "workspaceIdChili": "abcd1234-5678-90ef-1234-567890abcdef",
  "productFeatureType": "ConciergeRouter",
  "productFeatureName": "new-router-name",
  "productFeatureIdChili": "123abc45-def6-7890-ghi1-234jklmno567",
  "distributionName": "Demo Distribution",
  "distributionIdChili": "zxy9876-wvut-5432-srqp-1098onmlkjh",
  "meetingTypeName": "Support Session",
  "meetingTypeIdChili": "mnop1234-qrst-5678-uvwx-9012yzabcdef",
  "type": "Created"
  }

Most data provided will have common-sense values as provided by the prospect or Meeting Type during the booking process. Please refer to the below for additional values and information:

#####IdChili (UUID / hexadecimal )

Several values provided will be UUID or hex values of internal assets. These are often unique to that asset, so for example each meeting will have its own unique ID. Each assignee, booker, or prospect will have their own unique ID.

These IDs are stored internally so an assignee will always have the same UUID or hex value. 

If you ever have questions or want to troubleshoot a meeting, these IDs can be directly referenced by Chili Piper's Customer Love team in order to help track down more information within our database. 

meetingTitle, meetingDescription, meetingLocation (string)

These values are derived from the associated Meeting Type that the meeting was booked for

primaryGuestDataFields(object: {string:string})

If a guest form was filled out during the process of booking, or if form data was provided via API, this data will be presented with the data field name and value.

productFeatureType

Outlines the source of this meeting. Possible values include (but may not be limited to):

  • ConciergeRouter
  • HandoffRouter
  • RoundRobinSchedulingLink
  • ChatPlaybook
  • DistroRouter
  • OwnershipSchedulingLink

productFeatureName

This also corresponds to the source of the meeting. In the case of a "ConciergeRouter" booking for example, Chili Piper will include the router slug of the router used to book. 

meetingTypeName

Directly references the Meeting Type used to book the meeting. This can be an excellent way to additionally track the source of a meeting or specific campaign if you use unique Meeting Types for unique campaigns. 

type (string)

Possible values directly correlate to the action type selected.

  • Created
  • Updated
  • Deleted

Related articles