Embed Events
Listening to Events
You can listen to an event that occurs in embedded cal link as follows. You can think of them as DOM events.
Event Reference
eventTypeSelected
Description: When user chooses an event-type from the listing.
Properties:
eventType
:object
- Event Type that has been selected
bookingSuccessfulV2
It deprecates bookingSuccessful
event.
Description: When a fresh booking is successfully done. It might not be confirmed.
Properties:
uid
:string
|undefined
- Unique identifier for the bookingtitle
:string
|undefined
- Title of the bookingstartTime
:string
|undefined
- Start time of the bookingendTime
:string
|undefined
- End time of the bookingeventTypeId
:number
|null
|undefined
- Event type id of the bookingstatus
:string
|undefined
- Status of the bookingpaymentRequired
:boolean
- Whether payment is required for the bookingisRecurring
:boolean
- Whether the booking is recurringallBookings
:object
- Array of objects withstartTime
andendTime
. Applicable only ifisRecurring
istrue
videoCallUrl
:string
- URL of the video call
rescheduleBookingSuccessfulV2
It deprecates rescheduleBookingSuccessful
event.
Description: When a booking is rescheduled.
Properties:
uid
:string
|undefined
- Unique identifier for the bookingtitle
:string
|undefined
- Title of the bookingstartTime
:string
|undefined
- Start time of the bookingendTime
:string
|undefined
- End time of the bookingeventTypeId
:number
|null
|undefined
- Event type id of the bookingstatus
:string
|undefined
- Status of the bookingpaymentRequired
:boolean
- Whether payment is required for the bookingisRecurring
:boolean
- Whether the booking is recurringallBookings
:object
- Array of objects withstartTime
andendTime
. Applicable only ifisRecurring
istrue
linkReady
Description: Tells that the link is ready to be shown now.
Properties: None
linkFailed
Description: Fired if link fails to load.
Properties:
code
:number
- Error Codemsg
:string
- Human Readable msgdata
:object
- More details to debug the error
NOTE: With GTM App enabled for an Event type, these events are automatically sent to GTM and GTM could be setup to send these events to your desired destination like Google Analytics, etc.
To get more details on how Embed actually works, you can refer to this Embed Flowchart.