Skip to main content
CalendarHero logo
  • Category: scheduling & booking
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 38
  • Triggers: 0
  • Slug: CALENDARHERO
  • Version: 20261101_00

Tools

Slug: CALENDARHERO_ADD_CALENDAR_CONNECTIONAdd a new calendar directory/connection to the user’s CalendarHero account. A directory is a calendar connection configuration that groups meeting types together. Use this to organize different types of meetings (e.g., sales calls, team meetings) under separate calendar connections. Returns the unique ID of the created directory.

Input Parameters

object
required
Directory object containing calendar connection details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_CREATE_CONTACTCreates a new contact in CalendarHero with the provided contact information. Returns the unique identifier of the created contact.

Input Parameters

string
Contact’s full name in ‘First Last’ format.
array
required
List of one or more email addresses for the contact.
string
Contact’s job title.
array
List of phone numbers for the contact.
string
Email address from the list to set as default. Must match one provided.
string
Contact’s organization or company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_CREATE_MEETING_REQUEST_V2Tool to create a new meeting request in CalendarHero. Use when scheduling a meeting with participants, time range, and additional details.

Input Parameters

object
Meeting room configuration with capacity
string
required
The meeting type. Must be one of the user’s defined meeting types returned from GET /user/meeting (e.g., ‘coffee’, ‘call’, ‘meeting’)
string
required
The requested timeframe’s ending date/time (YYYY-MM-DDTHH:mm:ssZ).
string
required
The meeting topic/subject
integer
The number of seats required for a meeting room. If zero, then no room will be booked.
array
List of contacts to invite by ID
string
The specific location for the meeting
string
required
The requested timeframe’s start date/time (YYYY-MM-DDTHH:mm:ssZ).
array
List of preferred meeting locations
string
The agenda/description of the meeting
integer
Alternate field for meeting room seats required.
array
List of contact emails to invite
integer
The number of minutes of the requested meeting. If omitted, the meeting type’s meeting duration will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_CREATE_WEBHOOKCreates or updates a webhook for a specific event type in CalendarHero. Use this to register a URL endpoint that will receive notifications when events occur (e.g., when a meeting request succeeds or a new contact is added).

Input Parameters

string ("meeting_request_success" | "new_meeting_request" | "meeting_request_expired" | "meeting_request_cancelled" | "meeting_rescheduled" | "new_contact_added" | "meeting_completed" | "meeting_started")
required
Type of event to create or update a webhook for. Determines when the webhook will be triggered.
string
required
URL endpoint that will receive webhook POST requests when the specified event occurs. Must be a valid HTTPS endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_DELETE_CONTACTTool to delete a contact from CalendarHero by its unique identifier. Use when you need to permanently remove a contact from the system.

Input Parameters

string
required
Unique identifier of the contact to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_DELETE_MEETING_TASKTool to delete a meeting task/request from CalendarHero. Use when you need to remove a meeting task by its ID.

Input Parameters

string
required
The unique identifier of the meeting task/request to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_DELETE_MEETING_TYPETool to delete a meeting type from the authenticated user’s CalendarHero account. Use when you need to remove a meeting type configuration. Note: Cannot delete meeting types that have active or upcoming meetings scheduled.

Input Parameters

string
required
The meeting type identifier to delete (e.g., ‘coffee’, ‘call’, ‘meeting’). Note: Cannot delete meeting types that have active or upcoming meetings scheduled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_DELETE_USER_DIRECTORYTool to delete a user directory by its UUID. Use when you need to remove a directory from the user’s account.

Input Parameters

string
required
Unique identifier of the directory to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_DELETE_WEBHOOKTool to delete a webhook subscription for a specific event type. Use when you need to remove a webhook listener that was previously registered for CalendarHero events.

Input Parameters

string ("meeting_request_success" | "new_meeting_request" | "meeting_request_expired" | "meeting_request_cancelled" | "meeting_rescheduled" | "new_contact_added" | "meeting_completed" | "meeting_started")
required
The event type to delete the webhook for. Must be one of the supported webhook event types.
string
Optional webhook URL to delete. If provided, only the webhook with this specific URL will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_FETCH_CONTACTFetch Contact

Input Parameters

string
required
Unique identifier of the contact to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_FETCH_MEETING_DETAILSFetches meeting details for a specified time range. Provide the start and end datetimes in ISO 8601 format.

Input Parameters

string
required
The end datetime of the time range to fetch meetings, in ISO 8601 format, e.g., ‘2025-03-14T18:00:00Z’
string
required
The start datetime of the time range to fetch meetings, in ISO 8601 format, e.g., ‘2025-03-10T09:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_FETCH_USER_PROFILETool to fetch the profile details of the authenticated user. Use after obtaining a valid access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_ASSISTANT_MESSAGETool to retrieve a reply message from the CalendarHero assistant. Use when you need to get an automated response or greeting from the assistant for the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_CONTACT_COUNTTool to get the total count of contacts in CalendarHero. Use when you need to know how many contacts exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_MEETING_CATEGORIESRetrieves the user’s meeting categories’ stats for a specified time period. Use to analyze meeting distribution across different categories or types within a given month.

Input Parameters

string
Filter results by a specific month in YYYY-MM format (e.g., ‘2026-01’ for January 2026). When omitted, returns stats for the current month.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_MEETING_TASKSRetrieves the user’s meeting requests/tasks from CalendarHero. Use when you need to check pending meeting requests, view scheduling tasks, or track meeting coordination progress. Supports filtering by state (active/upcoming/closed), pagination, and meeting type.

Input Parameters

integer
Number of tasks to skip for pagination. Use with ‘take’ to paginate through results.
integer
Maximum number of tasks to return in the response. Use with ‘skip’ to paginate through results.
string
Filter tasks by meeting type (e.g., ‘coffee’, ‘call’, ‘meeting’). Returns only tasks of the specified type.
string ("active" | "upcoming" | "closed")
State of a meeting task.
boolean
When true, includes count/summary information for the tasks. When false or omitted, returns full task details without tallying.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_SEARCH_RESULTTool to get a search result by ID. Use when you have a search result ID from a previous /search request.

Input Parameters

string
required
The ID of the search result returned from /search endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_USER_DIRECTORYTool to retrieve a user’s directory by its unique identifier. Use when you need to fetch configuration details for a specific directory including meeting types and tracking settings.

Input Parameters

string
required
Unique identifier (UUID) of the directory to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_USER_ORGANIZATIONTool to retrieve the authenticated user’s organization details. Use when needing organization-level information.

Input Parameters

boolean
Whether to include billing user information in the response. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_USER_SAVINGSTool to retrieve the authenticated user’s savings information from CalendarHero. Use to view time saved, efficiency metrics, or other savings data tracked by the platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_WEBHOOKRetrieves webhook configuration for a specific meeting or contact event type. The returned URL can be null for some response shapes, so a null result does not necessarily establish that no webhook is configured.

Input Parameters

string ("meeting_request_success" | "new_meeting_request" | "meeting_request_expired" | "meeting_request_cancelled" | "meeting_rescheduled" | "new_contact_added" | "meeting_completed" | "meeting_started")
required
The event type to get webhook configuration for. Supported events include meeting lifecycle events (request, completion, cancellation) and contact events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_GET_WEBHOOK_SAMPLETool to retrieve a sample webhook payload for a specific event type. Use when testing webhook integrations or understanding the structure of webhook data for different CalendarHero events.

Input Parameters

string ("meeting_request_success" | "new_meeting_request" | "meeting_request_expired" | "meeting_request_cancelled" | "meeting_rescheduled" | "new_contact_added" | "meeting_completed" | "meeting_started")
required
The webhook event type for which to retrieve a sample payload. Must be one of: meeting_request_success, new_meeting_request, meeting_request_expired, meeting_request_cancelled, meeting_rescheduled, new_contact_added, meeting_completed, or meeting_started.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_LIST_MEETING_TEMPLATESLists the authenticated user’s meeting templates, which are reusable scheduling configurations. Use this to discover meeting type options before creating meetings; templates can include settings such as duration, availability and video conferencing preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_LIST_MEETING_TYPESRetrieves all meeting types configured for the authenticated CalendarHero user. Meeting types are templates that define availability windows, durations, and booking URLs for different kinds of meetings (e.g., ‘coffee’, ‘call’, ‘meeting’). Each meeting type has: - A unique identifier (e.g., ‘coffee’, ‘call’, ‘meeting’) - Availability windows (days and hours when meetings can be scheduled) - Booking URL for on-demand scheduling - Configuration for duration, timezone, notice period, etc. Use onlyTypes=true to get just the list of meeting type identifiers. Use onlyTypes=false (or omit) to get full configurations including all settings. This is a read-only operation that doesn’t modify any data.

Input Parameters

boolean
When true, returns only meeting type identifiers as a simple list. When false or omitted, returns full meeting type configurations including availability, URLs, and settings. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_LIST_USER_CALENDARSTool to list all calendar integrations connected to a user’s CalendarHero account. Use after authenticating when you need to retrieve available calendars for scheduling.

Input Parameters

boolean
When true, include organization-level calendar integrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_LIST_USER_DIRECTORIESTool to retrieve all directories configured for a user. Use when you need to list available directories for scheduling or configuration purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_SEARCH_CONTACTTool to search for existing contacts. Use after confirming a need to find contacts by email or name.

Input Parameters

boolean
When true, do not remove duplicate contacts.
string ("popular" | "recent" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z")
Filter by predefined set: ‘popular’, ‘recent’, or a single letter a-z. Cannot be used with search.
Search term: email (name@domain.com), domain (@domain.com), or full name (‘First Last’). Cannot be used with filter.
boolean
When true, include matching team entities in the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_SEARCH_INTEGRATIONSTool to search across all user integrations for a query term. Use when you need to find events, meetings, or other data matching specific keywords across the user’s connected calendar and productivity integrations.

Input Parameters

string
required
The query term to search for across all user integrations.
string
The requested timeframe’s ending date/time in ISO 8601 format (e.g., ‘2026-01-29T23:59:59Z’ for UTC or with timezone offset).
string
The requested timeframe’s start date/time in ISO 8601 format (e.g., ‘2026-01-28T00:00:00Z’ for UTC or with timezone offset).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_SEND_ASSISTANT_MESSAGETool to send a user’s message into the CalendarHero assistant. Use this to interact with the assistant using natural language for scheduling meetings, managing calendar events, or other calendar-related tasks.

Input Parameters

string
required
The message text to send to the CalendarHero assistant. This can be a natural language request for scheduling, rescheduling, or other calendar-related tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_SEND_REMINDERSends an email reminder to all contacts/participants about a scheduled meeting request. Use this to notify attendees who need a reminder about an upcoming meeting. Requires the meeting task ID from a previously created meeting request.

Input Parameters

string
required
Meeting task ID to send a reminder for. Must be a valid 24-character hexadecimal ID obtained from creating a meeting request (e.g., via Create Meeting Request V2).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_UPDATE_CONTACTUpdates an existing CalendarHero contact by ID, including details such as name, title, organization, and phone numbers. A nonempty email list is required and replaces existing emails, so include every address to keep; the primary email can also be set.

Input Parameters

string
required
Contact’s unique identifier (24-character hex string). Obtain from CREATE_CONTACT or FETCH_CONTACT actions.
string
Contact’s full name in ‘First Last’ format (e.g., ‘John Doe’). Updates the display name.
array
required
List of email addresses for the contact. Must include at least one email. This replaces all existing emails.
string
Contact’s job title or role (e.g., ‘Senior Engineer’, ‘Product Manager’).
string
Associated CalendarHero user ID (24-character hex string). Links contact to a specific user.
array
List of phone numbers for the contact (e.g., [‘+1-555-0100’, ‘+44-20-7123-4567’]).
array
List of external provider identifiers for calendar integrations (e.g., Google Calendar, Outlook).
string
Primary email address to use for communications. Must be one of the emails in the ‘email’ list.
string
Contact’s company or organization name (e.g., ‘Acme Corp’, ‘Tech Innovations Inc’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_UPDATE_MEETING_TYPESTool to update meeting type configurations for the authenticated CalendarHero user. Use when you need to modify existing meeting types’ availability, durations, or settings. IMPORTANT: The meeting type name must already exist in the user’s profile. To get existing meeting types, first use LIST_MEETING_TYPES action. This action updates properties like availability windows, notice periods, on-demand URLs, and other meeting-specific settings. Example: Update the ‘coffee’ meeting type to change the notice period from 4 hours to 5 hours, or modify the availability windows to only allow Monday-Wednesday bookings.

Input Parameters

array
required
Array of meeting types to update. Each entry must reference an existing meeting type by name and provide the updated configuration. Must contain at least one meeting type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_UPDATE_RESTRICTED_APPSUpdates the authenticated user’s restricted apps settings using a list of app identifiers. If the list is omitted, the request sends an empty list.

Input Parameters

array
List of app identifiers to restrict. Pass an empty list to clear all restrictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_UPDATE_USERTool to update the authenticated user’s profile information. Use when you need to modify user details such as name, email, timezone, or preferences.

Input Parameters

string
required
User’s full name (e.g., ‘John Doe’). This is the display name for the user.
string
User’s subscription plan identifier.
array
List of tags associated with the user for categorization.
string
User’s email address (e.g., ‘john.doe@example.com’).
string
URL to the user’s avatar image.
string
User’s physical address.
string
User’s country code (e.g., ‘US’, ‘GB’, ‘CA’).
string
User’s preferred currency code (e.g., ‘USD’, ‘EUR’, ‘GBP’).
string
User’s preferred language code (e.g., ‘en’, ‘es’, ‘fr’).
string
User’s timezone in IANA format (e.g., ‘America/New_York’, ‘Europe/London’).
array
List of phone numbers for the user (e.g., [‘+1-555-0100’, ‘+44-20-7123-4567’]).
Custom email footer text to append to outgoing emails.
boolean
Whether to hide the automated assistant for this user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_UPDATE_USER_ADDRESSTool to update the authenticated user’s address settings by providing latitude and longitude coordinates. Use when the user needs to update their location for meeting scheduling or time zone detection.

Input Parameters

string
required
Latitude coordinate of the user’s address as a string (e.g., ‘37.7749’ for San Francisco).
string
required
Longitude coordinate of the user’s address as a string (e.g., ‘-122.4194’ for San Francisco).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_UPDATE_USER_DIRECTORYTool to update a user’s directory in CalendarHero. Use when modifying directory settings such as title, meeting types, or configuration options. The directory UUID can be obtained from the user profile or directory listing endpoints. Ensure the directoryId in the request body matches the UUID path parameter.

Input Parameters

string
required
The UUID of the directory to update. This is a unique identifier in UUID format (e.g., ‘f79d0bd4-5fd8-487e-a30e-ed4fe3ac5f57’)
object
required
The directory data to update. Must include directoryId, directoryName, and at least one meetingType.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_UPDATE_USER_INFOUpdates the authenticated user’s info settings in CalendarHero. Use this action when you need to modify user profile details such as name, language, timezone, contact information, or display preferences. Only the fields provided in the request will be updated; all other fields remain unchanged. This allows for partial updates without affecting other user settings.

Input Parameters

string
User’s full name (e.g., ‘John Doe’). Updates the display name for the user.
string
URL to the user’s avatar image. Must be a valid HTTPS URL.
string
User’s physical address for location-based features.
string
User’s country code (e.g., ‘US’, ‘GB’, ‘CA’). Used for regional settings.
string
URL to the user’s logo image for branding purposes. Must be a valid HTTPS URL.
string
User’s preferred currency code (e.g., ‘USD’, ‘EUR’, ‘GBP’). Used for pricing display.
string
User’s preferred language code (e.g., ‘en’, ‘es’, ‘fr’). Sets the language for UI and communications.
string
User’s timezone in IANA format (e.g., ‘America/New_York’, ‘Europe/London’). Used for scheduling and time display.
array
List of phone numbers for the user (e.g., [‘+1-555-0100’, ‘+44-20-7123-4567’]).
Custom footer text to append to email communications sent from CalendarHero.
boolean
If true, hides negative WHOIS information from contact profiles.
boolean
If true, hides the automated assistant feature from the user interface.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALENDARHERO_UPDATE_WORK_LOCATIONTool to update the user’s work location settings in CalendarHero. Use when the user needs to change their work location (e.g., ‘Office’, ‘Home’, ‘Remote’).

Input Parameters

string
required
The work location setting to update (e.g., ‘Office’, ‘Home’, ‘Remote’). This is a simple string value representing the user’s work location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not