Callbacks

Callback types

Callback type

API Field Integration

Initiated actions

new

New booking callbacks

Booking from the schedule, landing page, widget

cancelled

Booking cancellation callbacks

“Cancel” a meeting by an expert, client or owner/admin

woker_removed

Renewal callbacks

“Remove expert”

worker_assigned

Renewal callbacks

“Add expert”

reschedule

Booking reschedule callbacks

“Reschedule” a scheduled or cancelled meeting

report

Renewal callbacks

“Create report”

custom_fields_or_note_changed

Renewal callbacks

“Edit”

in_work

Renewal callbacks

“Accept to work”

Callback format

Callback is a JSON, which contains inside information about callback type (callback_type) and booking with which the monitored action was performed.

Fields describing the booking:

id

unique internal meeting ID

booking

JSON with basic information about the meeting

cancel_url

link to cancel the meeting on behalf of the company owner

cancel_url_client

link to cancel the meeting on behalf of the client

created_at

meeting creation time

custom_fields_values

JSON with custom field values in the format:
{

"field identifier": "meaning",

...

}

first_booking_at

time when the customer first used the service

lesson

JSON with basic information about the service

note

company’s comment

old_booking_cancel_reason

reason for rescheduling the previous booking (during the reschedule, it is cancelled, when cancelling, the reason is indicated, which is entered in this field, and then a new booking is created)

old_id

identifier of the previous booking (after the reschedule, a new one is issued, and the old one is indicated here)

report

JSON with information about the meeting summary, in case the expert created a report

reschedule_url

link to reschedule the meeting on behalf of the company owner

reschedule_url_client

link to reschedule a meeting on behalf of a client

team

JSON with basic information about the company

updated_at

?time of last service update

utm_params

 

worker

JSON with basic information about the appointed expert

zoom_join_url

a link to the Zoom meeting if Zoom is specified as the venue

Booking Fields:

by_teacher

meeting booked by an expert from the schedule (true) or by client from landing/widget (false)

client

JSON with basic information about the client

client_timezone

client’s time zone

comment

client’s comment which was left during the booking, if not - null

start_time

meeting start time

session_state

meeting with expert processing status: scheduled (meeting was just created), in_work (meeting was accepted to work), finished (expert created meeting report), cancelled (meeting was cancelled)

end_time

meeting end time (start_time + service duration)

state

meeting status: new (created) or cancelled (cancelled)

Fields describing users (client, worker, cancelled_by):

id

unique internal user identifier (acting as a client/employee/owner/expert)

avatar_url

link to user’s avatar

domain

user’s domain name on cabinet.fm

email

user’s name

name

user’s name and surname

phone

user’s phone number

Fields describing the service (lesson):

id

unique internal service identifier

description

service description

price

service price

title

service title

Fields describing the outcome of the meeting (report):

comment

employee report text

state

outcome of the meeting selected by the employee: success (the meeting took place) or cancelled (the meeting didn’t take place)

Fields describing the company(team):

id

unique internal company identifier

name

company’s name

Additional fields

Callback cancelled

booking.cancel_reason

reason for meeting cancellation, if specified

cancelled_by

JSON with basic information about the cancellation initiator

Callback reschedule

This callback sends JSON with 3 fields:

callback_type

callback type

new

JSON with information about new booking

old

JSON with information about past booking

 

©20202024 cabinet.fm