Set up Scheduling Pro Webhooks

Prev Next

Overview

Scheduling Pro webhooks allow you to receive real-time notifications whenever key scheduling events occur in your account. Instead of manually checking the system, webhooks send event data directly to your chosen endpoint or delivery URL.

Currently, two webhook events are available:

  • Session Completed (Job/Booking Creation): Fires when a customer successfully completes a booking and a job/booking is created.

  • Qualified Abandoned Session: Fires when a customer provides enough contact details, such as phone or email, to follow up but abandons the booking before completion.


Who uses this feature

  • Office employees, administrators

  • Primarily benefits Residential Service and Replacement business types

Feature configuration

  • This feature is currently in Private Preview and available for specific accounts. It is subject to change. If you want to enable this feature for your account, reach out to your Success Manager.

  • Account configuration is required to use this feature. Please contact Technical Support for details.

Things to know

  • A webhook is an automated way for one application to send real-time data to another when a specific event occurs, for example, sending an email when a session is completed through Scheduling Pro.

Step 1: Create an app

  1. Go to developer portal and click Sign In & Create Apps.

  2. Click Sign In as Production Environment User to sign in.
    Sign-in options for Third-Party Developers and ServiceTitan Customers on Developer Portal.

  3. In the Sign in to ServiceTitan screen, enter your login credentials and click Sign In.

  4. Review the API TERMS OF USE document and click Accept.
    ServiceTitan API terms of use document with highlighted acceptance button and important clauses.

  5. In the Developer Portal screen, click Create and Manage Applications.
    Button for creating and managing applications with an arrow indicating action.

  6. In the Create and Manage Applications screen, click Create New App.

  7. In the Create New App screen, enter all details to create the application.

    1. Enter the Developer Details section.
      Form fields for entering developer details including organization name, website, and email address.

      1. Organization Name

      2. Organization/App Website

      3. Email Address

    2. Enter the App Details section.
      Form fields for app details including name, description, category, and GUID.

      1. App Name

      2. Description

      3. App Category

      4. External Data Application GUID

    3. Add APIs and webhooks in the Tenant APIs and Webhooks section.
      Overview of APIs and Webhooks sections with prompts to add scopes and events.

      1. Click Add API Scopes to select the API scopes for this app.

        1. In the API Scopes screen, select Schedulers scope under Scheduling Pro and click Done.
          API scopes with highlighted Scheduling Pro section and options for selection.

      2. Click Add Webhook Events to select the webhooks events for this app.

        1. In the Webhook Events screen, select Session Completed and Qualified Abandoned Session events and click Done.

          Note: Ensure to provide the delivery URL next to each webhook event you select. The URL is where your webhooks are sent to.

          Overview of session statuses: Qualified Abandoned Session and Session Completed with links.

    4. Enter your Tenant ID to add a tenant to the app.
      Form displaying Tenant ID and optional note fields for tenant management.

      1. (Optional) You can add a note to the Note (optional) section.

    5. Enter Network ID to add a network to the app.
      Form fields for entering Network ID and optional notes with an add network button.

      1. (Optional) You can add a note to the Note (optional) section.

    6. Decide who you want to configure the credentials within the app.

      1. I, the app developer, will configure the credentials on behalf of each tenant

      2. Tenants will configure the credentials themselves.

  8. When finished, click Create App.

After creating the app, move on to connecting the app in ServiceTitan to generate the client ID and secret Key.

Tip: Keep client IDs and client secrets confidential. Never publish them with your source code, embed them within web pages, or distribute them byan app store.

Step 2: Connect the App

To create a Client ID and Secret Key and provide it to your developer, first we need to connect the application in ServiceTitan.

  1. In ServiceTitan, go to Settings > Integration > API Application Access.

  2. From the Manage API Application Access screen, click Connect New App and select the available app to connect.
    Tip: Ensure to allow access to your ServiceTitan account.

  3. After connecting the app, in Application Details > Client ID, copy your Client ID. Go to Client Secret and click Generate to generate a secret key.
    Now you can share the Client ID and Secret Key with your app developer.

Want to learn more?