Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.voxworks.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

Cancels an existing appointment in Calendly by calling the Calendly API. On successful cancellation, all booking-related global variables are cleared. Returns true if the booking is cancelled successfully. Provider: Calendly (calendly.com)

​
Manual Inputs

NameData TypeRequiredDescription
Cancellation reasonstringNoReason for cancellation (default: “Appointment cancelled by user via voice agent”)

​
Global Inputs

This tool automatically uses:
VariableDescription
[Calendar - Booking ID]The Calendly event URI from a previous booking

​
Manual Outputs

NameData TypeDescription
resultbooltrue if booking was cancelled successfully

​
Global Outputs

On successful cancellation, the following variables are cleared (set to empty):
VariableDescription
[Calendar - Booking ID]Cleared after cancellation
[Calendar - Booking Link]Cleared after cancellation
[Calendar - Booking Time - Raw]Cleared after cancellation
[Calendar - Booking Time - Written]Cleared after cancellation
[Calendar - Booking Time - Spoken]Cleared after cancellation
On failure:
VariableData TypeDescription
[Calendar - Booking Error - Spoken]stringError message if cancellation failed (for assistant to speak)

​
Conditions

​
Success (true)

The tool returns true when:
  • The Calendly API successfully cancels the booking
  • The API returns a 200, 201, or 204 status code

​
Failure (false)

The tool returns false when:
  • [Calendar - Booking ID] is empty or missing
  • The booking has already been cancelled
  • The booking ID is invalid or doesn’t exist
  • The Calendly API credentials are missing or invalid
  • A network or API error occurs

​
Example Usage

Step 1 (Voice): "I can help you cancel your appointment. Can I confirm you'd like to cancel?"
   -> User confirms -> Step 2

Step 2 (Tool): Calendly - Cancel Booking
   Input:
     Cancellation reason = "Customer requested cancellation"

   Condition: true (success)
   -> Next: confirmation_step
   -> Script: "Your appointment has been cancelled. Would you like to reschedule?"

   Condition: Otherwise (failure)
   -> Next: fallback_step
   -> Script: "I wasn't able to cancel the booking. [Calendar - Booking Error - Spoken]"

​
Prerequisites

This tool requires an existing booking. The [Calendar - Booking ID] variable must be set from either:
  • A previous Calendly - Book Time tool in the same call
  • A booking ID stored in the contact record and loaded at call start

​
Best Practices

  1. Confirm before cancelling — Verify the user wants to cancel
  2. Provide a reason — Helps with analytics and follow-up
  3. Offer to reschedule — Don’t end the conversation after cancellation
  4. Handle failures — Offer to transfer to a human if cancellation fails

​
Next Steps