A webhook is a URL to which Agendize will send scheduling information in JSON format when appointments are scheduled or canceled. You can use it to notify somebody when a new appointment is booked, or synchronize the appointment with your internal calendar management system, for example.


In order to activate a webhook, go to your Dashboard (1), click on Settings (2) and Calendar Sync (3).




In the “Webhook URL” field (4), put your Webhook URL.

For testing you can use this website: http://requestb.in.

 

You’ll receive JSON information when a new appointment is scheduled or canceled:




The JSON structure is: 

{

   "action":{string},

   "client":{

      "email":{string}

      "firstname":{string}

      "id":{string}

      "lastname":{string}

      "phone":{string}

   },

   "company":{

      "id":{string}

      "name":{string}

   },

   "event":{

      "end-date":{datetime},

      "id":{string},

      "start-date":{datetime}

   },

   "service":{

      "duration":{integer},

      "id":{string},

      "name":{string}

      "price":{integer}

   },

   "source":{string}

   "staff":{

      "email":{string}

      "firstname":{string}

      "lastname":{string}

   }

}


Parameter name

Value

Description

action

string

Action: “new”, “cancel”.

client

object

Client details: id, email, first name, last name, phone.

company

object

Company information: id, name.

event

object

Event data: Appointment id, start and end dates (formatted according to RFC 3339).

service

object

Service information: id, name, price, duration.

source

string

Where the action originated: “widget” or “console”.

staff

object

Staff information: first name, last name, email.