Data consumption with webhooks (Schedule Engine)

Prev Next

Overview

Schedule Engine webhooks allow all the data payload from a job to be sent to an endpoint URL. To enable, an Endpoint URL is supplied to Schedule Engine, then data points are sent to the URL. Data points can be configured internally or through a third-party webhooks application like Zapier or Tray.io.

Note: This feature applies only to the legacy Schedule Engine. ServiceTitan customers are encouraged to transition to Scheduling Pro, an upgraded tool designed to replace Schedule Engine on your website and provide a seamless booking experience.


Who uses this feature

  • Administrators

  • Applies to all business types

Data points

The following are the most common data points that Schedule Engine pushed to the webhook endpoint:

Parameter

Description

SE Client Name

Client name

SE Client ID

Unique identifier for Client

Data External Ref

External job ID from FSM

Data Created At:

Creation date

Data Estimated Start Date:

Start time

Data Estimated End Date:

End time

Data Service Code Name:

Service codes for job

Data Customer Notes:

Includes Appointment Window, any free form text they submitted, and notes from selections in scheduler

Data Status:

Job status

Data Confirmation Status:

Notification confirmation status

Data Contact First Name

First name

Data Contact Last Name:

Last name

Data Location Address Line1:

Address Line1

Data Location Address Line2:

Address Line2

Data Location Address City:

City

Data Location Address State:

State

Data Location Address Zipcode:

Zip code/Postal code

Data Contact Phone Number:

Customer’s phone number

Data Contact Email:

Customer’s email

clid

A general purpose Click ID

fbclid

Facebook Click ID

gclid

Google Click ID

se_affiliate

Schedule Engine Affiliate ID

se_campaign

Schedule Engine Campaign ID

se_custom_field_1

Schedule Engine Custom Field

se_lead_source

Schedule Engine Lead Source

utm_campaign

UTM Campaign

utm_content

UTM Content

utm_medium

UTM Medium

utm_source

UTM Source

utm_term

UTM Term

Click here to see the full list of all the payload data available.