Overview

The OnSched API fires webhooks for several events including:

Each of the above events are described in detail below.

Webhooks

Webhooks support an optional message signature to ensure that the source is OnSched and not an impersonator.

Each webhook notification passes an event trigger which provides information on what triggered the event and how you should process it.

Basic Structure of Webhooks

Signed Signature
An http header X-Message-Signature contains the signature to verify the source is OnSched.
The signature uses the Sha256 signing algorithm to generate a signature based on a hash key that you configure, or using the default hash key which is equivalent to the company external id.

Event Trigger
The event trigger is a string that describes the underlying event that triggered the webhook. Event triggers help tell you how to process the webhook. For example you’ll know if the trigger is for sending an Sms reminder message versus an email reminder message. This is important if you are rolling your own notification. See the section below which describes all of the possible event triggers.

Object Data
Each different type of webhook supplies data for one or more objects that provide relevant context information for the event.

Each object definition is provided in a section below.

Webhook Url’s

You can configure up to four different url’s for processing webhooks:

  1. Booking Webhook Url
  2. Reminder Webhook Url
  3. Customer Webhook Url
  4. Resource Webhook Url

Webhooks url’s are configured using the OnSched Portal under the company settings menu. Note you can use the same url for some, or all of the webhooks provided your logic uses the event trigger information and acts accordingly.

Booking Webhook

One of the following event triggers will be sent with a booking webhook.

• BookingConfirmation
• RescheduleConfirmation
• CancelReservationConfirmation

Reminder Webhook

One of the following event triggers will be sent with a reminder webhook.

• EmailReminder
• SmsReminder

Customer Webhook

One of the following event triggers will be sent with a customer webhook

• NewCustomer
• UpdateCustomer

Resource Webhook

One of the following event triggers will be sent with a resource webhook.

• NewResource
• UpdateResource

Data definitions

Booking Webhook Sample

{
  "eventTrigger": "BookingConfirmation",
  "appointment": {
    "object": "appointment",
    "id": 459685,
    "locationId": "32d19c1e-66db-448a-90f2-b21c8fb711c3",
    "calendarId": 102946,
    "serviceId": 117845,
    "resourceId": 126610,
    "customerId": 108826,
    "rescheduledId": 0,
    "createDate": "2022/02/28 7:44:00 PM",
    "startDateTime": "2022-03-02T15:30:00+00:00",
    "endDateTime": "2022-03-02T16:00:00+00:00",
    "date": "3/02/2022",
    "time": 1030,
    "duration": 30,
    "timezone": 0,
    "status": "BK",
    "confirmationNumber": "TQWVS586954",
    "bookedBy": "johnpaddon@onsched.com",
    "onlineBooking": true,
    "confirmed": false,
    "email": "johnpaddon@onsched.com",
    "name": "Nitin Shukla",
    "lastname": "Paddon",
    "firstname": "John",
    "phone": "",
    "phoneType": "M",
    "phoneExt": "",
    "customerMessage": null,
    "lastModifiedOn": "2022-02-28 7:44:00 PM",
    "lastModifiedBy": "nitin@onsched.com",
    "location": "",
    "latitude": "",
    "longitude": "",
    "stripeChargeId": null,
    "stripeRefundId": null,
    "paymentStatus": 0,
    "type": "testService",
    "appointmentTypeId": 0,
    "groupSize": 1,
    "travelAppointmentId": 0,
    "travelTimeMins": 0,
    "ipAddress": "150.129.248.244",
    "timezoneIana": "Coordinated Universal Time",
    "timezoneId": null,
    "noticeSent": true,
    "mobileBooking": false,
    "reminderDays": 0,
    "reminderSent": "0001-01-01 12:00:00 AM",
    "resourceName": "JohnPST",
    "scheduleName": "Main",
    "businessName": "Nitin NonGuitar Player",
    "gender": null,
    "resourceIds": null,
    "birthdate": null,
    "phoneFormatted": "",
    "notes": "",
    "customerRequest": "",
    "googleEventId": "",
    "googleResourceEventId": "",
    "synchedWithGoogle": false,
    "outlookEventId": "",
    "outlookResourceEventId": "",
    "synchedWithOutlook": false,
    "externalAppointmentId": "",
    "synchedWithExternal": false,
    "repeatMasterId": 0,
    "repeat": false,
    "repeatFrequency": "",
    "repeatInterval": 0,
    "repeatWeekDays": "",
    "repeatMonthDay": "",
    "repeatMonthType": "",
    "repeatStart": "",
    "repeatEnd": "",
    "quickbooksInvoiceId": "",
    "autoDealRuleId": 0,
    "autoDealDiscount": 0,
    "smsNotificationSent": true,
    "staffBooking": false,
    "staffAttendees": "",
    "smsConfirmationSent": "2022-02-28T19:44:02.86",
    "smsReminderSent": null,
    "smsReminderHours": 0,
    "usageType": 0,
    "emailNoticeSent": "2022-02-28T19:44:03.277",
    "emailReminderSent": null,
    "emailReminderHours": 0,
    "country": "",
    "deletedStatus": false,
    "deletedTime": null,
    "notificationsConverted": true,
    "endDate": "",
    "visitDateTime": "2022-03-02T10:30:00",
    "customField1": null,
    "customField1_int": 0,
    "customField1_bool": false,
    "customField1_decimal": 0,
    "customField1_date": "0001-01-01T00:00:00",
    "customField2": null,
    "customField2_int": 0,
    "customField2_bool": false,
    "customField2_decimal": 0,
    "customField2_date": "0001-01-01T00:00:00",
    "customField3": null,
    "customField3_int": 0,
    "customField3_bool": false,
    "customField3_decimal": 0,
    "customField3_date": "0001-01-01T00:00:00",
    "customField4": null,
    "customField4_int": 0,
    "customField4_bool": false,
    "customField4_decimal": 0,
    "customField4_date": "0001-01-01T00:00:00",
    "customField5": null,
    "customField5_int": 0,
    "customField5_bool": false,
    "customField5_decimal": 0,
    "customField5_date": "0001-01-01T00:00:00",
    "customField6": null,
    "customField6_int": 0,
    "customField6_bool": false,
    "customField6_decimal": 0,
    "customField6_date": "0001-01-01T00:00:00",
    "customField7": null,
    "customField7_int": 0,
    "customField7_bool": false,
    "customField7_decimal": 0,
    "customField7_date": "0001-01-01T00:00:00",
    "customField8": null,
    "customField8_int": 0,
    "customField8_bool": false,
    "customField8_decimal": 0,
    "customField8_date": "0001-01-01T00:00:00",
    "customField9": null,
    "customField9_int": 0,
    "customField9_bool": false,
    "customField9_decimal": 0,
    "customField9_date": "0001-01-01T00:00:00",
    "customField10": null,
    "customField10_int": 0,
    "customField10_bool": false,
    "customField10_decimal": 0,
    "customField10_date": "0001-01-01T00:00:00"
  },
  "customer": {
    "id": 108826,
    "externalId": "84665ac4-257a-ec11-94f6-0050f271d436",
    "friendlyId": null,
    "businessId": 74396,
    "name": "John Paddon",
    "lastname": "Paddon",
    "firstname": "John",
    "gender": "",
    "birthdate": "",
    "dtBirthdate": "0001-01-01T00:00:00",
    "age": 0,
    "homePhone": "",
    "homePhoneFormatted": "",
    "businessPhone": "",
    "businessPhoneFormatted": "",
    "businessPhoneExt": "",
    "mobilePhone": "",
    "mobilePhoneFormatted": "",
    "email": "nitin@onsched.com",
    "timezone": null,
    "timezoneId": null,
    "lastVisitDate": "",
    "dtLastVisitDate": "0001-01-01T00:00:00",
    "addressLine1": "",
    "addressLine2": "",
    "city": "",
    "state": "",
    "postalCode": "",
    "country": "",
    "companyName": "",
    "groupId": 0,
    "groupName": null,
    "skypeUsername": null,
    "emailInfo": true,
    "emailPromotion": false,
    "createdBy": "johnpaddon@onsched.com",
    "createdOn": "2022-01-20 7:18:37 PM",
    "modifiedBy": "johnpaddon@onsched.com",
    "modifiedOn": "2022-01-20 7:18:37 PM",
    "verificationDate": "",
    "dtVerificationDate": "0001-01-01T00:00:00",
    "registrationDate": "",
    "dtRegistrationDate": "0001-01-01T00:00:00",
    "verifiedBy": "",
    "registeredBy": "",
    "disabled": false,
    "quickbooksCustomerId": "",
    "familyCustomerId": 0,
    "familyRelationship": "",
    "phoneType": "M",
    "resourceId": 0,
    "resourceName": null,
    "inviteEmailSent": null,
    "welcomeEmailSent": null,
    "deletedStatus": false,
    "deletedTime": null,
    "stripeCustomerId": "",
    "stripeCreditCardId": "",
    "stripeBankAccountId": "",
    "customId": 0,
    "notificationType": 1,
    "latitude": null,
    "longitude": null,
    "emailThankyouSent": null,
    "smsThankyouSent": null,
    "emailWaitListSent": null,
    "smsWaitListSent": null,
    "smsInviteSent": null,
    "smsWelcomeSent": null,
    "customField1": null,
    "customField1_int": 0,
    "customField1_bool": false,
    "customField1_decimal": 0,
    "customField1_date": "0001-01-01T00:00:00",
    "customField2": null,
    "customField2_int": 0,
    "customField2_bool": false,
    "customField2_decimal": 0,
    "customField2_date": "0001-01-01T00:00:00",
    "customField3": null,
    "customField3_int": 0,
    "customField3_bool": false,
    "customField3_decimal": 0,
    "customField3_date": "0001-01-01T00:00:00",
    "customField4": null,
    "customField4_int": 0,
    "customField4_bool": false,
    "customField4_decimal": 0,
    "customField4_date": "0001-01-01T00:00:00",
    "customField5": null,
    "customField5_int": 0,
    "customField5_bool": false,
    "customField5_decimal": 0,
    "customField5_date": "0001-01-01T00:00:00",
    "customField6": null,
    "customField6_int": 0,
    "customField6_bool": false,
    "customField6_decimal": 0,
    "customField6_date": "0001-01-01T00:00:00",
    "customField7": null,
    "customField7_int": 0,
    "customField7_bool": false,
    "customField7_decimal": 0,
    "customField7_date": "0001-01-01T00:00:00",
    "customField8": null,
    "customField8_int": 0,
    "customField8_bool": false,
    "customField8_decimal": 0,
    "customField8_date": "0001-01-01T00:00:00",
    "customField9": null,
    "customField9_int": 0,
    "customField9_bool": false,
    "customField9_decimal": 0,
    "customField9_date": "0001-01-01T00:00:00",
    "customField10": null,
    "customField10_int": 0,
    "customField10_bool": false,
    "customField10_decimal": 0,
    "customField10_date": "0001-01-01T00:00:00"
  },
  "resource": {
    "id": 126610,
    "businessId": 74396,
    "type": 0,
    "name": "JohnPST",
    "email": "johnpaddon@onsched.com",
    "groupId": 0,
    "bookingsPerSlot": 0,
    "groupName": "",
    "recurringAvailability": true,
    "displayColor": "",
    "bookingLimit": 0,
    "score": 0,
    "gender": "",
    "commission": 0,
    "hourly": 0,
    "allAppointmentTypes": false,
    "googleCalendarId": "",
    "googleRefreshToken": "",
    "googleCalendarSyncEnabled": true,
    "outlookCalendarId": "",
    "outlookRefreshToken": "",
    "outlookCalendarSyncEnabled": true,
    "description": "",
    "notificationType": 1,
    "bookingNotification": 1,
    "smsNotificationSent": false,
    "flexPadding": false,
    "homePhone": "",
    "mobilePhone": "",
    "businessPhone": "",
    "businessPhoneExt": "",
    "addressLine1": "",
    "addressLine2": "",
    "city": "",
    "state": "",
    "postalCode": "",
    "country": "",
    "latitude": "",
    "longitude": "",
    "ignoreBusinessHours": false,
    "calendarAvailability": 0,
    "selfAccessOnly": false,
    "sortKey": 0,
    "skypeName": "",
    "bioLink": "",
    "timezoneOffset": -480,
    "timezoneId": "Pacific Standard Time",
    "effectiveDate": null,
    "imageUrl": null,
    "deletedStatus": false,
    "deletedTime": null,
    "conferenceInfo": "",
    "onBoardingStatus": 0,
    "blockGoogleBusyTimesOnly": false,
    "blockOutlookBusyTimesOnly": false,
    "salesforceUserId": "",
    "salesforceRefreshToken": "",
    "customField1": null,
    "customField1_int": 0,
    "customField1_bool": false,
    "customField1_decimal": 0,
    "customField1_date": "0001-01-01T00:00:00",
    "customField2": null,
    "customField2_int": 0,
    "customField2_bool": false,
    "customField2_decimal": 0,
    "customField2_date": "0001-01-01T00:00:00",
    "customField3": null,
    "customField3_int": 0,
    "customField3_bool": false,
    "customField3_decimal": 0,
    "customField3_date": "0001-01-01T00:00:00",
    "customField4": null,
    "customField4_int": 0,
    "customField4_bool": false,
    "customField4_decimal": 0,
    "customField4_date": "0001-01-01T00:00:00",
    "customField5": null,
    "customField5_int": 0,
    "customField5_bool": false,
    "customField5_decimal": 0,
    "customField5_date": "0001-01-01T00:00:00",
    "customField6": null,
    "customField6_int": 0,
    "customField6_bool": false,
    "customField6_decimal": 0,
    "customField6_date": "0001-01-01T00:00:00",
    "customField7": null,
    "customField7_int": 0,
    "customField7_bool": false,
    "customField7_decimal": 0,
    "customField7_date": "0001-01-01T00:00:00",
    "customField8": null,
    "customField8_int": 0,
    "customField8_bool": false,
    "customField8_decimal": 0,
    "customField8_date": "0001-01-01T00:00:00",
    "customField9": null,
    "customField9_int": 0,
    "customField9_bool": false,
    "customField9_decimal": 0,
    "customField9_date": "0001-01-01T00:00:00",
    "customField10": null,
    "customField10_int": 0,
    "customField10_bool": false,
    "customField10_decimal": 0,
    "customField10_date": "0001-01-01T00:00:00"
  }
}

Reminder Webhook Sample

{
  "eventTrigger": "EmailReminder",
  "appointment": {
    "object": "appointment",
    "id": 457238,
    "locationId": "32d19c1e-66db-448a-90f2-b21c8fb711c3",
    "calendarId": 102946,
    "serviceId": 117845,
    "resourceId": 137551,
    "customerId": 104082,
    "rescheduledId": 0,
    "createDate": "2022/06/09 5:53:41 AM",
    "startDateTime": "2022-06-09T11:00:00-04:00",
    "endDateTime": "2022-06-09T11:30:00-04:00",
    "date": "6/09/2022",
    "time": 1100,
    "duration": 30,
    "timezone": -240,
    "status": "BK",
    "confirmationNumber": "TQWVS832754",
    "bookedBy": "",
    "onlineBooking": false,
    "confirmed": false,
    "email": "johnpaddon@onsched.com",
    "name": null,
    "lastname": "Paddon",
    "firstname": "John",
    "phone": "5555555555",
    "phoneType": "M",
    "phoneExt": "",
    "customerMessage": "",
    "lastModifiedOn": "2022-06-09 5:54:27 AM",
    "lastModifiedBy": "johnpaddon@onsched.com",
    "location": "",
    "latitude": "",
    "longitude": "",
    "stripeChargeId": null,
    "stripeRefundId": null,
    "paymentStatus": 0,
    "type": "testService",
    "appointmentTypeId": 0,
    "groupSize": 0,
    "travelAppointmentId": 0,
    "travelTimeMins": 0,
    "ipAddress": null,
    "timezoneIana": null,
    "timezoneId": null,
    "noticeSent": false,
    "mobileBooking": false,
    "reminderDays": 0,
    "reminderSent": "0001-01-01 12:00:00 AM",
    "resourceName": "London-Location-Res1",
    "scheduleName": "Main",
    "businessName": "Burlington Medical Center",
    "gender": "",
    "resourceIds": null,
    "birthdate": null,
    "phoneFormatted": "(555) 555-5555",
    "notes": "",
    "customerRequest": "",
    "googleEventId": "",
    "googleResourceEventId": "",
    "synchedWithGoogle": false,
    "outlookEventId": "",
    "outlookResourceEventId": "",
    "synchedWithOutlook": false,
    "externalAppointmentId": "",
    "synchedWithExternal": false,
    "repeatMasterId": 0,
    "repeat": false,
    "repeatFrequency": "",
    "repeatInterval": 0,
    "repeatWeekDays": "",
    "repeatMonthDay": "9",
    "repeatMonthType": "D",
    "repeatStart": "",
    "repeatEnd": "",
    "quickbooksInvoiceId": "",
    "autoDealRuleId": 0,
    "autoDealDiscount": 0,
    "smsNotificationSent": false,
    "staffBooking": false,
    "staffAttendees": "",
    "smsConfirmationSent": null,
    "smsReminderSent": null,
    "smsReminderHours": 0,
    "usageType": 0,
    "emailNoticeSent": null,
    "emailReminderSent": "2022-06-09T15:30:20.163",
    "emailReminderHours": 1,
    "country": "",
    "deletedStatus": false,
    "deletedTime": null,
    "notificationsConverted": false,
    "endDate": "",
    "visitDateTime": "2022-06-09T11:00:00",
    "customField1": null,
    "customField1_int": 0,
    "customField1_bool": false,
    "customField1_decimal": 0,
    "customField1_date": "0001-01-01T00:00:00",
    "customField2": null,
    "customField2_int": 0,
    "customField2_bool": false,
    "customField2_decimal": 0,
    "customField2_date": "0001-01-01T00:00:00",
    "customField3": null,
    "customField3_int": 0,
    "customField3_bool": false,
    "customField3_decimal": 0,
    "customField3_date": "0001-01-01T00:00:00",
    "customField4": null,
    "customField4_int": 0,
    "customField4_bool": false,
    "customField4_decimal": 0,
    "customField4_date": "0001-01-01T00:00:00",
    "customField5": null,
    "customField5_int": 0,
    "customField5_bool": false,
    "customField5_decimal": 0,
    "customField5_date": "0001-01-01T00:00:00",
    "customField6": null,
    "customField6_int": 0,
    "customField6_bool": false,
    "customField6_decimal": 0,
    "customField6_date": "0001-01-01T00:00:00",
    "customField7": null,
    "customField7_int": 0,
    "customField7_bool": false,
    "customField7_decimal": 0,
    "customField7_date": "0001-01-01T00:00:00",
    "customField8": null,
    "customField8_int": 0,
    "customField8_bool": false,
    "customField8_decimal": 0,
    "customField8_date": "0001-01-01T00:00:00",
    "customField9": null,
    "customField9_int": 0,
    "customField9_bool": false,
    "customField9_decimal": 0,
    "customField9_date": "0001-01-01T00:00:00",
    "customField10": null,
    "customField10_int": 0,
    "customField10_bool": false,
    "customField10_decimal": 0,
    "customField10_date": "0001-01-01T00:00:00"
  },
  "customer": {
    "id": 104082,
    "externalId": "00000000-0000-0000-0000-000000000000",
    "friendlyId": null,
    "businessId": 74396,
    "name": "John Paddon",
    "lastname": "Paddon",
    "firstname": "John",
    "gender": "",
    "birthdate": "",
    "dtBirthdate": "0001-01-01T00:00:00",
    "age": 0,
    "homePhone": "",
    "homePhoneFormatted": "",
    "businessPhone": "",
    "businessPhoneFormatted": "",
    "businessPhoneExt": "",
    "mobilePhone": "5555555555",
    "mobilePhoneFormatted": "(555) 555-5555",
    "email": "johnpaddon@onsched.com",
    "timezone": null,
    "timezoneId": null,
    "lastVisitDate": "",
    "dtLastVisitDate": "0001-01-01T00:00:00",
    "addressLine1": "",
    "addressLine2": "",
    "city": "",
    "state": "",
    "postalCode": "",
    "country": "",
    "companyName": "",
    "groupId": 0,
    "groupName": null,
    "skypeUsername": null,
    "emailInfo": true,
    "emailPromotion": false,
    "createdBy": "johnpaddon@onsched.com",
    "createdOn": "2021-11-06 12:00:00 AM",
    "modifiedBy": "johnpaddon@onsched.com",
    "modifiedOn": "2021-11-06 12:00:00 AM",
    "verificationDate": "0001-01-01",
    "dtVerificationDate": "0001-01-01T00:00:00",
    "registrationDate": "2021/11/06",
    "dtRegistrationDate": "2021/11/06T00:00:00",
    "verifiedBy": "",
    "registeredBy": "johnpaddon@onsched.com",
    "disabled": false,
    "quickbooksCustomerId": "",
    "familyCustomerId": 0,
    "familyRelationship": " ",
    "phoneType": "M",
    "resourceId": 0,
    "resourceName": null,
    "inviteEmailSent": null,
    "welcomeEmailSent": null,
    "deletedStatus": false,
    "deletedTime": null,
    "stripeCustomerId": "",
    "stripeCreditCardId": "",
    "stripeBankAccountId": "",
    "customId": 0,
    "notificationType": 0,
    "latitude": null,
    "longitude": null,
    "emailThankyouSent": null,
    "smsThankyouSent": null,
    "emailWaitListSent": null,
    "smsWaitListSent": null,
    "smsInviteSent": null,
    "smsWelcomeSent": null,
    "customField1": null,
    "customField1_int": 0,
    "customField1_bool": false,
    "customField1_decimal": 0,
    "customField1_date": "0001-01-01T00:00:00",
    "customField2": null,
    "customField2_int": 0,
    "customField2_bool": false,
    "customField2_decimal": 0,
    "customField2_date": "0001-01-01T00:00:00",
    "customField3": null,
    "customField3_int": 0,
    "customField3_bool": false,
    "customField3_decimal": 0,
    "customField3_date": "0001-01-01T00:00:00",
    "customField4": null,
    "customField4_int": 0,
    "customField4_bool": false,
    "customField4_decimal": 0,
    "customField4_date": "0001-01-01T00:00:00",
    "customField5": null,
    "customField5_int": 0,
    "customField5_bool": false,
    "customField5_decimal": 0,
    "customField5_date": "0001-01-01T00:00:00",
    "customField6": null,
    "customField6_int": 0,
    "customField6_bool": false,
    "customField6_decimal": 0,
    "customField6_date": "0001-01-01T00:00:00",
    "customField7": null,
    "customField7_int": 0,
    "customField7_bool": false,
    "customField7_decimal": 0,
    "customField7_date": "0001-01-01T00:00:00",
    "customField8": null,
    "customField8_int": 0,
    "customField8_bool": false,
    "customField8_decimal": 0,
    "customField8_date": "0001-01-01T00:00:00",
    "customField9": null,
    "customField9_int": 0,
    "customField9_bool": false,
    "customField9_decimal": 0,
    "customField9_date": "0001-01-01T00:00:00",
    "customField10": null,
    "customField10_int": 0,
    "customField10_bool": false,
    "customField10_decimal": 0,
    "customField10_date": "0001-01-01T00:00:00"
  },
  "resource": {
    "id": 137551,
    "businessId": 74396,
    "type": 0,
    "name": "London-Location-Res1",
    "email": "johnpaddon@onsched.com",
    "groupId": 0,
    "bookingsPerSlot": 0,
    "groupName": "",
    "recurringAvailability": false,
    "displayColor": "",
    "bookingLimit": 0,
    "score": 0,
    "gender": "",
    "commission": 0,
    "hourly": 0,
    "allAppointmentTypes": false,
    "googleCalendarId": "",
    "googleRefreshToken": "",
    "googleCalendarSyncEnabled": true,
    "outlookCalendarId": "",
    "outlookRefreshToken": "",
    "outlookCalendarSyncEnabled": true,
    "description": "London-Location-Res1",
    "notificationType": 1,
    "bookingNotification": 1,
    "smsNotificationSent": false,
    "flexPadding": false,
    "homePhone": "516-555-9999",
    "mobilePhone": "516-359-8608",
    "businessPhone": "914-344-4567",
    "businessPhoneExt": "",
    "addressLine1": "44, Hanmer Street East",
    "addressLine2": "",
    "city": "Barrie",
    "state": "ON",
    "postalCode": "L4M 6V1",
    "country": "CA",
    "latitude": "",
    "longitude": "",
    "ignoreBusinessHours": false,
    "calendarAvailability": 0,
    "selfAccessOnly": false,
    "sortKey": 0,
    "skypeName": "",
    "bioLink": "",
    "timezoneOffset": null,
    "timezoneId": null,
    "effectiveDate": null,
    "imageUrl": null,
    "deletedStatus": false,
    "deletedTime": null,
    "conferenceInfo": "",
    "onBoardingStatus": 0,
    "blockGoogleBusyTimesOnly": false,
    "blockOutlookBusyTimesOnly": false,
    "salesforceUserId": "",
    "salesforceRefreshToken": "",
    "customField1": null,
    "customField1_int": 0,
    "customField1_bool": false,
    "customField1_decimal": 0,
    "customField1_date": "0001-01-01T00:00:00",
    "customField2": null,
    "customField2_int": 0,
    "customField2_bool": false,
    "customField2_decimal": 0,
    "customField2_date": "0001-01-01T00:00:00",
    "customField3": null,
    "customField3_int": 0,
    "customField3_bool": false,
    "customField3_decimal": 0,
    "customField3_date": "0001-01-01T00:00:00",
    "customField4": null,
    "customField4_int": 0,
    "customField4_bool": false,
    "customField4_decimal": 0,
    "customField4_date": "0001-01-01T00:00:00",
    "customField5": null,
    "customField5_int": 0,
    "customField5_bool": false,
    "customField5_decimal": 0,
    "customField5_date": "0001-01-01T00:00:00",
    "customField6": null,
    "customField6_int": 0,
    "customField6_bool": false,
    "customField6_decimal": 0,
    "customField6_date": "0001-01-01T00:00:00",
    "customField7": null,
    "customField7_int": 0,
    "customField7_bool": false,
    "customField7_decimal": 0,
    "customField7_date": "0001-01-01T00:00:00",
    "customField8": null,
    "customField8_int": 0,
    "customField8_bool": false,
    "customField8_decimal": 0,
    "customField8_date": "0001-01-01T00:00:00",
    "customField9": null,
    "customField9_int": 0,
    "customField9_bool": false,
    "customField9_decimal": 0,
    "customField9_date": "0001-01-01T00:00:00",
    "customField10": null,
    "customField10_int": 0,
    "customField10_bool": false,
    "customField10_decimal": 0,
    "customField10_date": "0001-01-01T00:00:00"
  }
}

Resource Webhook Sample

{

“eventTrigger”: “UpdateResource”,

"resource": {

"object": "resource",

"id": 8,

"locationId": "e4d61bd8-cdf3-4fc9-887e-2320dce062e0",

"name": "Eric Clapton",

"email": "john@onsched.com",

"groupId": 2,

"description": "",

"imageUrl": "https://onschedule.blob.core.windows.net/pics/E4D61BD8-CDF3-4FC9-887E-2320DCE062E0/resource/8/eric-clapton.jpg",

12 "deletedStatus": false,

"deletedTime": null,

"notificationType": 1,

"bookingNotification": 2,

"googleCalendarId": "john@onsched.com",

"outlookCalendarId": "",

"ignoreBusinessHours": false,

"gender": "",

"hourly": 0,

"calendarAvailability": 1,

"sortKey": 0,

"skypeName": "EricTestSkypeName",

"bioLink": "",

"timezoneOffset": -240,

"timezoneId": "Eastern Standard Time",

"effectiveDate": null,

"contact": {

"phoneType": null,

"homePhone": "",

"mobilePhone": "9053998404",

"businessPhone": "",

"businessPhoneExt": "",

"skypeUsername": "EricTestSkypeName"

},

"address": {

"addressLine1": "",

"addressLine2": "",

"city": "",

"state": "ON",

"country": "CA",

"postalCode": ""

}

}

}

Customer Webhook Sample

{

“eventTrigger”: “UpdateCustomer”,

"customer": {

"object": "customer",

"iId": 37886,

"locationId": "e4d61bd8-cdf3-4fc9-887e-2320dce062e0",

"email": "jpaddon@hotmail.com",

"name": "John Paddon",

"lastname": "Paddon",

"firstname": "John",

"companyName": "Tasman Technolgies",

"gender": "",

"birthdate": "3/17/1991",

"lastVisitDate": "9/10/2018",

"groupId": "",

"resourceId": 0,

"createdOn": "3/16/2017 5:53:27 PM",

"createdBy": "jpaddon@hotmail.com",

"registeredBy": "jpaddon@hotmail.com",

"verifiedBy": "",

"modifiedBy": "jpaddon@hotmail.com",

"modifiedOn": "9/9/2018 5:53:25 PM",

"verificationDate": "",

"registrationDate": "9/7/2018",

"emailInfo": true,

"emailPromotion": false,

"disabled": false,

"inviteEmailSent": "",

"welcomeEmailSent": "7/14/2017 8:20:01 AM",

"deletedStatus": false,

14 "deletedTime": "",

"notificationType": "3",

"subscriptionId": "",

"latitude": "",

"longitude": "",

"stripeCustomerId": "cus_AaNlxYJN0PTnpM",

"contact": {

"phoneType": "M",

"homePhone": "",

"mobilePhone": "9053998404",

"businessPhone": "",

"businessPhoneExt": "",

"skypeUsername": null

},

"address": {

"addressLine1": "",

"addressLine2": "",

"city": "Burlington",

"state": "",

"country": "",

"postalCode": "L7L 3Z2"

},

"customFields": {

"field1": {

"name": "admin",

"value": "0"

},

"field2": {

"name": "Test",

"value": "1"

}

}

},

Zapier.com

Connect with a wide variety of different applications by creating a free account at zapier.com and creating a zap that is triggered with a Zapier webhook. Once created, select the trigger Catch Hook and a URL will be generated by Zapier which can be copied and pasted into any of the 3 webhook fields in the OnSched Dashboard.


What’s Next