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
Retrieves available appointment slots from a Calendly event page by calling the Calendly API. Returns availability organised by week, day, and time period. Returns true if availabilities are found.
Provider: Calendly (calendly.com)
| Name | Data Type | Required | Description |
|---|
| Calendly Event link | string | Yes | Event link from Calendly (e.g., https://calendly.com/username/30min) |
| Number of weeks | integer | No | Number of weeks to retrieve availability for (1-8, default: 4) |
This tool has no global inputs. It uses the Calendly API credentials configured in your team settings.
Manual Outputs
| Name | Data Type | Description |
|---|
| result | bool | true if available slots were found |
Global Outputs
| Variable | Data Type | Description |
|---|
| [Calendar - Event ID] | string | The Calendly event URL (used by booking tool) |
| [Calendar - Availability - Raw] | string | Available times in JSON format organised by week/day/time period |
| [Calendar - Availability Error - Spoken] | string | Error message if check failed (for assistant to speak) |
Conditions
Success (true)
The tool returns true when:
- The Calendly API returns available time slots
- At least one slot is available within the requested week range
Failure (false)
The tool returns false when:
- The Calendly event link is invalid or inaccessible
- No availability exists within the requested week range
- The Calendly API credentials are missing or invalid
- A network or API error occurs
Example Usage
Step 1 (Tool): Calendly - Get Availabilities
Input:
Calendly Event link = "https://calendly.com/yourcompany/demo"
Number of weeks = 4
Condition: true (success)
-> Next: ask_preference_step
-> Script: "I have some availability. What day works best for you?"
Condition: Otherwise (failure)
-> Next: no_availability_step
-> Script: "I'm sorry, there's no availability at the moment. [Calendar - Availability Error - Spoken]"
Configuration
To use this tool, you need:
- Calendly API Token — Connected via your team integrations settings
- Calendly Event Link — The URL of your Calendly event type (e.g.,
https://calendly.com/username/30min)
Best Practices
- Use specific event links — Each event type has its own duration and settings
- Set appropriate week range — 4 weeks is a good default; more weeks = more options
- Follow with Calendar - Check Availability — Use that tool to select and format slots based on user preferences
- Handle no availability — Have a fallback when no slots are found
Next Steps
