Skip to content

Configure Webhooks

The Webhooks feature in SchedAgent enables users to connect with other web applications seamlessly. With this feature, users can set up automated messages and updates to custom URLs. Webhooks enable the sending of data from SchedAgent to any other application, allowing for efficient data sharing and integration across various platforms.

The Webhooks feature for SchedAgent is considered a premium feature, and it will be counted towards your total number of Custom Features & Integrations.

In order to use Webhooks, you need to Enable this feature on the Features & Integration page. Once enabled, you can set up your webhooks by clicking on the ‘Set Up‘ button. This will take you to the page where you can create your webhooks. At this stage, you will see that no webhooks exist, so let’s create some!

In the top right corner, you will find the ‘Create Webhook‘ button. Click on this button to create various types of Webhooks:

  • Appointment Booked
  • Appointment Canceled
  • Appointment has been rescheduled
  • Appointment status has been changed
  • Customer Created

These types of webhooks correspond to the events in SchedAgent that would trigger them to be sent.

Custom Special Day

Please note that, at this stage, you can only create a single webhook for each type. This means there can be only one ‘Appointment Booked’ webhook, one ‘Appointment Canceled’ webhook, and so on.

When configuring your Webhooks in SchedAgent, you will have access to various settings:

  1. Name: This allows you to title your webhook for easy identification.
  2. Website URL: Enter the URL of your application where you want the webhook information from SchedAgent to be sent. This enables you to integrate SchedAgent data into other applications as needed.

Additionally, SchedAgent offers a handy feature to test your Webhooks:

Send Test Webhook: This option sends dummy data to the specified URL. It provides a preview of the information that will be sent for each appointment triggered by the webhook. The following appointment details are included:

  • Appointment Status
  • Appointment Start Date
  • Appointment Start Time
  • Appointment Start Date and Time
  • Appointment End Date
  • Appointment End Time
  • Appointment End Date and Time
  • Appointment Price
  • Customer Full Name
  • Customer First Name
  • Customer Last Name
  • Customer Email
  • Customer Phone
  • Employee Full Name
  • Employee First Name
  • Employee Last Name
  • Employee Email
  • Employee Phone
  • Service Category
  • Service Name
  • Service Duration
  • Service Price
  • Extras
  • Location Name
  • Location Address
  • Location Phone
  • Custom Fields

This allows you to ensure that the webhook is correctly configured to send the necessary information for your integration needs.

Please note that the data sent will be formatted according to the settings you have chosen in SchedAgent. When using Webhooks, the information is transmitted via a POST request.

When setting up your Webhooks in SchedAgent, you have the option to utilize a ‘Verification Token‘. Clicking on this button (next to the “Create Webhook” button) will prompt a pop-up window where you can view and copy your verification token.

Custom Special Day

By utilizing the Verification Token, each webhook request sent from SchedAgent to your application can be authenticated, ensuring that the data received is indeed originating from SchedAgent. This token is included in the Authorization Header of the webhook request for added security.