Calendly Booking
An embedded Calendly scheduling field for booking appointments directly within your form flow.
The Calendly Booking field embeds a Calendly scheduling widget inside your form. Users can select a time slot and book an appointment without leaving the form. The field supports inline, popup, and button embed modes, prefilled invitee information, and custom styling. It requires a connected Calendly credential.
Configuration
| Property | Type | Default | Description |
|---|---|---|---|
| label | string | -- | Label text displayed above the booking widget |
| width | LayoutWidth | "full" | Horizontal space the field occupies |
| credentialId | string | -- | ID of the connected Calendly credential |
| eventTypeUri | string | -- | Calendly event type URI to display |
| eventTypeName | string | -- | Display name of the event type |
| schedulingUrl | string | -- | Direct Calendly scheduling URL |
| hideEventTypeDetails | boolean | -- | Whether to hide event type details in the widget |
| hideGdprBanner | boolean | -- | Whether to hide the GDPR cookie banner |
| embedMode | string | -- | How the widget is displayed: "inline", "popup", or "button" |
| buttonText | string | -- | Label for the booking button (used with "popup" and "button" modes) |
| onComplete | OnCompleteAction | "auto" | Action after booking completes: "auto", "next", "submit", or "none" |
Styling
| Property | Type | Description |
|---|---|---|
| primaryColor | string | Primary accent color for the Calendly widget (hex value) |
| textColor | string | Text color for the widget |
| backgroundColor | string | Background color for the widget |
Prefill Options
| Property | Type | Description |
|---|---|---|
| prefillName | string | Pre-populate the invitee's name |
| prefillEmail | string | Pre-populate the invitee's email address |
| prefillCustomAnswers | Record | Key-value pairs for custom question answers |
Embed Modes
- inline -- The Calendly widget is embedded directly in the form, visible without user action.
- popup -- A button is shown that opens the Calendly widget in a modal overlay.
- button -- A button is shown that opens the Calendly scheduling page.
Output Data
After a booking is made, the field produces structured output:
| Output Key | Type | Description |
|---|---|---|
| status | enum | Booking result: "scheduled", "failed", "canceled", or "rescheduled" |
| eventUri | string | URI of the created event |
| inviteeUri | string | URI of the invitee record |
| inviteeEmail | string | Email address of the person who booked |
| inviteeName | string | Name of the person who booked |
| startTime | string | Scheduled start time (ISO 8601) |
| endTime | string | Scheduled end time (ISO 8601) |
| eventTypeName | string | Name of the booked event type |
| cancelUrl | string | URL for the invitee to cancel the booking |
| rescheduleUrl | string | URL for the invitee to reschedule |
| errorMessage | string | Error description on failure |
Example Usage
An inline Calendly booking widget with prefilled data:
{
"type": "calendlyBooking",
"label": "Schedule Your Demo",
"schedulingUrl": "https://calendly.com/your-org/30min",
"embedMode": "inline",
"hideGdprBanner": true,
"primaryColor": "#4f46e5",
"prefillName": "Jane Doe",
"prefillEmail": "[email protected]",
"onComplete": "next"
}