What data is sent with a webhook?
Booking Created
This webhook is sent whenever a new booking is created in your Appointedd account where the webhook is created.
{
"event_type": "booking_created",
"event_data": {
"organisation": {
"id": "5b1129141df0422a691b8b5a",
"name": "E2E"
},
"booking": {
"id": "63eba46bcf1b3c0013c8b6b6",
"start_time": "2023-02-15T13:00:00.000Z",
"end_time": "2023-02-15T14:00:00.000Z",
"price": 20,
"created": "2023-02-14T15:10:34.907Z",
"status": "Confirmed",
"type": "Hourly",
"timezone": "Europe/London",
"allow_online_group": false,
"max_occupancy": 1,
"last_modified_source": "appointment_screen",
"updated": "2023-02-14T15:10:34.907Z"
},
"participants": [
{
"id": "63eba4653bc39996f2040152",
"firstname": "AFGF",
"lastname": "asfafs",
"timezone": "Europe/London",
"email": "fsaasfafsfas@example.org",
"marketing_opt_in": false,
"spaces": 1,
"booking_status": "No Status",
"notes": "asd",
"questions": [
{
"label": "Test Text",
"value": "sad",
"id": "5dd3fad787b76310cf1622cc"
},
{
"label": "Test Dropdown",
"value": "",
"id": "5dd3fad787b76310cf1622cd"
},
{
"label": "Test Checkbox",
"value": false,
"id": "5dd3fad787b76310cf1622ce"
}
],
"customer_booking_id": "63eba46bcf1b3c0013c8b6b5",
"locale": "es", // only set if locale is not "en"
"total_price": 20,
"total_spaces": 1,
"price_points": [
{
"price_per_quantity": 20,
"quantity": 1,
"spaces_per_quantity": 1
}
],
"custom_fields": [
{
"id": "date_of_birth",
"value": 1684105200
}
],
"stripe_charge_ids": [
"ch_3MbQ9GGrjHKwGJeA1ZXVItBd"
],
"total_paid_online_amount": 10,
"cancellation_url": "https://book.appointedd.com/cancel/1e2af1ea5b0b0b708c389f546214202b",
"reschedule_url": "https://reschedule.appointedd.com?token=16aab619bb734176366e0756ed9cfee1&bookingId=66fc03d2c92e34001208784f&participantId=66fc03d2c92e34001208784e"
}
],
"bookables": [
{
"id": "5f02dd9d1849f43909277532",
"name": "Ada Lovelace",
"email": "geraint+t2@appointedd.com"
}
],
"service": {
"id": "5f02de75eee3e55219133b83",
"name": "Math Tutoring (Charity)",
"type": "Hourly",
"category": {
"id": "5e53af1eab2d472b976d0b02",
"name": "General"
}
}
},
"event_timestamp": 1676387436
}
Booking Updated
This webhook is sent whenever an existing booking is updated in your Appointedd account where the webhook is created. It is also sent if any booking customer's record on a booking is updated such as the customer's arrival status on the booking.
If a customer on a group booking cancels, this webhook will be sent excluding the information of the removed customer.
{
"event_type": "booking_updated",
"event_data": {
"organisation": {
"id": "5b1129141df0422a691b8b5a",
"name": "E2E"
},
"booking": {
"id": "63eba46bcf1b3c0013c8b6b6",
"start_time": "2023-02-15T13:00:00.000Z",
"end_time": "2023-02-15T14:00:00.000Z",
"price": 20,
"created": "2023-02-14T15:10:34.907Z",
"status": "Confirmed",
"type": "Hourly",
"timezone": "Europe/London",
"allow_online_group": false,
"last_modified_source": "appointment_screen",
"max_occupancy": 1,
"updated": "2023-02-14T15:10:34.907Z"
},
"participants": [
{
"id": "63eba4653bc39996f2040152",
"firstname": "AFGF",
"lastname": "asfafs",
"timezone": "Europe/London",
"email": "fsaasfafsfas@example.org",
"marketing_opt_in": false,
"spaces": 1,
"booking_status": "No Status",
"notes": "asd",
"questions": [
{
"label": "Test Text",
"value": "sad",
"id": "5dd3fad787b76310cf1622cc"
},
{
"label": "Test Dropdown",
"value": "",
"id": "5dd3fad787b76310cf1622cd"
},
{
"label": "Test Checkbox",
"value": false,
"id": "5dd3fad787b76310cf1622ce"
}
],
"customer_booking_id": "63eba46bcf1b3c0013c8b6b5",
"locale": "es", // only set if locale is not "en"
"total_price": 20,
"total_spaces": 1,
"price_points": [
{
"price_per_quantity": 20,
"quantity": 1,
"spaces_per_quantity": 1
}
],
"custom_fields": [
{
"id": "date_of_birth",
"value": 1684105200
}
],
"stripe_charge_ids": [
"ch_3MbQ9GGrjHKwGJeA1ZXVItBd"
],
"total_paid_online_amount": 2.5,
"cancellation_url": "https://book.appointedd.com/cancel/1e2af1ea5b0b0b708c389f546214202b",
"reschedule_url": "https://reschedule.appointedd.com?token=16aab619bb734176366e0756ed9cfee1&bookingId=66fc03d2c92e34001208784f&participantId=66fc03d2c92e34001208784e"
}
],
"bookables": [
{
"id": "5f02dd9d1849f43909277532",
"name": "Ada Lovelace",
"email": "geraint+t2@appointedd.com"
}
],
"service": {
"id": "5f02de75eee3e55219133b83",
"name": "Math Tutoring (Charity)",
"type": "Hourly",
"category": {
"id": "5e53af1eab2d472b976d0b02",
"name": "General"
}
}
},
"event_timestamp": 1676387436
}
Booking Cancelled
This webhook is sent whenever an existing booking is cancelled in your Appointedd account where the webhook is created.
Please note, this webhook will not be sent if a single customer on a group booking cancels (where the whole booking is not cancelled).
{
"event_type": "booking_cancelled",
"event_data": {
"organisation": {
"id": "5e53ae7f104a096777792e17",
"name": "E2E"
},
"booking": {
"id": "64147fd0843fbb000efe20b7",
"start_time": "2023-03-17T15:45:00.000Z",
"end_time": "2023-03-17T16:15:00.000Z",
"price": 0,
"created": "2023-03-17T14:57:20.506Z",
"status": "Cancelled",
"type": "Hourly",
"timezone": "Europe/London",
"allow_online_group": false,
"max_occupancy": 1,
"last_modified_source": "appointment_screen",
"label": "Test Booking",
"updated": "2023-03-17T14:57:22.000Z"
},
"participants": [
{
"id": "62234622c23a1a58fe34bf2c",
"firstname": "A",
"lastname": "A",
"timezone": "Europe/London",
"email": "ada.lovelace@example.org",
"marketing_opt_in": true,
"spaces": 1,
"booking_status": "No Status",
"customer_booking_id": "64147fd0843fbb000efe20b6",
"locale": "es", // only set if locale is not "en"
"total_price": 0,
"total_spaces": 1,
"price_points": [
{
"quantity": 1,
"price_per_quantity": 0,
"spaces_per_quantity": 1
}
],
"custom_fields": [
{
"id": "test_text",
"value": "asd"
},
{
"id": "test_date",
"value": ""
}
],
"stripe_charge_ids": [
"ch_3MbQ9GGrjHKwGJeA1ZXVItBd"
],
"total_paid_online_amount": 2.5,
"cancellation_url": "https://book.appointedd.com/cancel/1e2af1ea5b0b0b708c389f546214202b",
"reschedule_url": "https://reschedule.appointedd.com?token=16aab619bb734176366e0756ed9cfee1&bookingId=66fc03d2c92e34001208784f&participantId=66fc03d2c92e34001208784e"
}
],
"bookables": [
{
"id": "5e53b330892ab2000f618dba",
"name": "Ana Devon",
"email": "geraint@appointedd.com"
}
],
"service": {
"id": "637b836953042d749daa3547",
"name": "Math Tutoring (Charity)",
"type": "Hourly",
"category": {
"id": "5e53af1eab2d472b976d0b02",
"name": "General"
}
}
},
"event_timestamp": 1679065042
}
Customer Created
This webhook is sent whenever a new customer is created in your Appointedd account where the webhook is created.
{
"event_type": "customer_created",
"event_data": {
"organisation": {
"id": "579..................57f",
"name": "ACME Corp"
},
"customer": {
"id": "597..................962",
"firstname": "Hannah",
"lastname": "Martin",
"email": "hannah@email.com",
"marketing_opt_in": true,
"custom_fields": [
{
"id": "date_of_birth",
"value": 1684105200
}
],
"lastModifiedSource": "internal"
}
},
"event_timestamp": 1500999311,
}
Customer Updated
This webhook is sent whenever an existing customer is updated in your Appointedd account where the webhook is created.
{
"event_type": "customer_updated",
"event_data": {
"organisation": {
"id": "579..................57f",
"name": "ACME Corp"
},
"customer": {
"id": "597..................962",
"firstname": "Hannah",
"lastname": "Martin",
"email": "hannah@email.com",
"marketing_opt_in": true
"custom_fields": [
{
"id": "date_of_birth",
"value": 1657065600
}
],
"lastModifiedSource": "internal"
}
},
"event_timestamp": 1680776354
}
Customer Deleted
This webhook is sent whenever an existing customer is deleted in your Appointedd account where the webhook is created.
{
"event_type": "customer_deleted",
"event_data": {
"organisation": {
"id": "579..................57f",
"name": "ACME Corp"
},
"customer": {
"id": "597..................962",
"firstname": "Hannah",
"lastname": "Martin",
"email": "hannah@email.com",
"marketing_opt_in": true
"custom_fields": [
{
"id": "date_of_birth",
"value": 1657065600
}
],
"lastModifiedSource": "internal"
}
},
"event_timestamp": 1680776345
}
Updated about 1 month ago