Skip to main content
Clickmeeting logo
  • Category: webinars
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 39
  • Triggers: 0
  • Slug: CLICKMEETING
  • Version: 20261101_00

Tools

Slug: CLICKMEETING_CREATE_ACCESS_TOKENSTool to generate access tokens for conference participants. Use when room access_type=3 (token protected) and you need unique tokens for attendees.

Input Parameters

integer
required
Unique identifier of the conference room. The room must have access_type=3 (token protected).
integer
required
Number of access tokens to generate. Maximum 1000 tokens per request. Total tokens per event cannot exceed fourfold of maximum attendees.

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: CLICKMEETING_CREATE_CONFERENCETool to create a new conference. Use when you need to schedule or start a meeting/webinar after authentication.

Input Parameters

string
required
The display name of the conference room visible to attendees.
string ("active" | "inactive")
Initial room status. ‘inactive’ rooms cannot be joined.
integer
ID of the UI skin/theme. Get available skins from get_conference_skins endpoint.
string
Duration in ‘H:MM’ format for scheduled rooms. Required when permanent_room=0.
string
Room password. Required when access_type=2.
object
Advanced conference settings.
string ("meeting" | "webinar")
required
Type of room: ‘meeting’ for collaborative sessions (all can share audio/video) or ‘webinar’ for one-to-many broadcast.
string
Start date/time for scheduled rooms. Format: ‘YYYY-MM-DD HH:MM:SS’ or ISO 8601. Required when permanent_room=0.
string
IANA time zone for the scheduled start time.
integer ("1" | "2" | "3")
required
Access mode: 1=open (anyone with link can join); 2=password-protected (requires ‘password’ field); 3=token-based (unique tokens per attendee).
object
Registration configuration for a conference.
integer ("0" | "1")
1 to show a waiting lobby before joining; 0 to allow direct entry.
integer ("0" | "1")
required
1 to create a permanent room (always available); 0 to create a scheduled room (requires starts_at and duration).
string
Custom message displayed in the waiting lobby before the event starts.
string
Custom URL slug for the room (must be unique). If not provided, auto-generated from name.

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: CLICKMEETING_CREATE_CONTACTCreate a contact in your ClickMeeting account or update an existing contact with the same email address.

Input Parameters

string
required
First name of the contact (required by the API)
string
required
Email address of the contact. If the email already exists, the contact details will be updated.
string
Phone number of the contact
string
Company name associated with the contact
string
Last name of the contact
array
List of custom fields to set for the contact

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: CLICKMEETING_DELETE_CONFERENCETool to delete a specific conference. Use after confirming the conference is no longer needed.

Input Parameters

integer
required
Unique identifier of the conference 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: CLICKMEETING_DELETE_FILEPermanently delete a file from the ClickMeeting file library. Use this action to remove unwanted or outdated files (presentations, images, videos, etc.) from your library. Before calling this action, use Get File Library to find the file_id. WARNING: Deletion is irreversible - the file cannot be recovered once deleted.

Input Parameters

integer
required
The unique numeric identifier of the file to delete from the library. Obtain this ID from the Get File Library action.

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: CLICKMEETING_DELETE_RECORDINGPermanently delete a specific recording from a conference room. Use this action to remove an unwanted or outdated recording. Before calling this action: 1. Use Get Conferences to find the conference_id 2. Use Get Recordings to find the recording_id within that conference WARNING: Deletion is irreversible. The recording file cannot be recovered once deleted.

Input Parameters

integer
required
The unique numeric identifier of the recording to delete. Obtain this ID from the Get Recordings action for the specific conference.
integer
required
The unique numeric identifier of the conference room containing the recording. Obtain this ID from the Get Conferences action.

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: CLICKMEETING_DELETE_RECORDINGSTool to delete all recordings for a conference room. Use when you need to clear all saved recordings for a specific conference before archiving or reusing it.

Input Parameters

integer
required
Unique identifier of the conference to delete recordings for

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: CLICKMEETING_DOWNLOAD_FILEDownload the content of a specific file from the ClickMeeting file library. Use when you need to retrieve the actual file content for processing or storage.

Input Parameters

integer
required
Unique identifier of the file to download from the file library.

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: CLICKMEETING_GENERATE_AUTOLOGIN_URLGenerate an autologin hash for a conference participant. This tool creates a hash that allows direct access to a ClickMeeting conference room without requiring separate login. Use it to build auto-login URLs in the format: <room_url>?l=<autologin_hash> The returned hash is time-sensitive and tied to the specific participant details provided.

Input Parameters

string ("listener" | "presenter" | "host")
required
Role of the participant: ‘listener’ (attendee), ‘presenter’, or ‘host’.
string
required
Email address of the participant.
string
Access token. Required if the room has access_type=3 (token protected).
integer
required
ID of the conference room for which to generate the autologin hash.
string
required
Display name of the participant in the conference.
string
Room password. Required if the room has access_type=2 (password protected).

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: CLICKMEETING_GENERATE_SESSION_PDF_REPORTGenerates a PDF report containing analytics and details for a specific conference session. The report includes session attendance, duration, and other metrics. Use this when you need to export session data as a downloadable PDF document. Note: This action requires a valid session_id. Sessions are only created after a conference has been held (started and ended). Use get_conference_sessions to find available sessions. The PDF generation may be asynchronous - check the ‘status’ field in the response. If status is ‘NEW’ or ‘IN_PROGRESS’, poll again until status becomes ‘FINISHED’.

Input Parameters

string
Two-letter ISO 639-1 language code for the report (e.g., ‘en’ for English, ‘pl’ for Polish). Defaults to ‘en’ if not specified.
integer
required
The ID of the session within the conference. Sessions are created when a conference is held. Obtain this from the get_conference_sessions action.
integer
required
The ID of the conference room (room_id). Obtain this from the get_conferences or create_conference actions.

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: CLICKMEETING_GET_CHAT_DETAILSRetrieve details for a specific ClickMeeting chat session by session ID. Use a session ID from the chat list to request its details.

Input Parameters

integer
required
Numeric session ID for the chat. Obtain this from the GET /chats endpoint which returns a list of chat sessions with their IDs.

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: CLICKMEETING_GET_CHATSTool to retrieve a list of all chat sessions. Use when you need to list available chats in your account.

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: CLICKMEETING_GET_CONFERENCE_DETAILSRetrieve detailed information about a specific ClickMeeting conference room. Returns comprehensive data including room URL, access settings, phone dial-in PINs, timezone, status, and configuration options. Use the meeting_id from Get Conferences action or from a previously created conference.

Input Parameters

string
required
Unique numeric ID of the conference/meeting room to retrieve. Can be obtained from the Get Conferences action.

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: CLICKMEETING_GET_CONFERENCE_FILESRetrieves the list of files uploaded to a specific conference room’s file library. Returns file metadata including download URLs, conversion status, and thumbnails. Files must be uploaded via the upload_file action before they appear here. Returns an empty list if no files exist or if the conference ID is invalid.

Input Parameters

integer
required
Unique ID of the conference room to retrieve files for.

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: CLICKMEETING_GET_CONFERENCESRetrieve conference rooms filtered by active or inactive status, including room URLs, access settings, schedules, and registration information. Inactive results may be paginated; this action does not accept a page selection.

Input Parameters

string ("active" | "inactive")
Filter conferences by status. ‘active’ returns currently active meetings, ‘inactive’ returns archived/ended meetings.

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: CLICKMEETING_GET_CONFERENCE_SESSIONSRetrieves past sessions for a conference room. Sessions are only created when a conference is actually held (participants join). Use this to get historical data like session times and attendance counts after meetings have occurred. Returns an empty list if the conference has never been held.

Input Parameters

integer
required
The unique numeric ID of the conference room. Get this from the ‘Get Conferences’ action or from when you created the conference.

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: CLICKMEETING_GET_CONFERENCE_SKINSRetrieves a list of available conference room skins that can be used to customize the appearance of webinar/meeting rooms. Each skin includes an ID (for use when creating/updating conferences), a display name, and a preview thumbnail URL. Note: This feature may require a paid ClickMeeting plan with custom branding access.

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: CLICKMEETING_GET_FILE_DETAILSRetrieve detailed information about a specific file from the ClickMeeting file library. Returns file status, URL, document type, conversion progress, and upload date. Use this to check file availability and status before using in conferences.

Input Parameters

integer
required
Unique identifier of the file to retrieve details for. Can be obtained from the Get File Library action.

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: CLICKMEETING_GET_FILE_LIBRARYRetrieve a list of uploaded files from the ClickMeeting file library for browsing or inventory. Optional page and per-page parameters allow pagination.

Input Parameters

integer
Page number for pagination (1-based). Use with ‘per_page’ to navigate through large file lists.
integer
Number of files to return per page. Use with ‘page’ for pagination.

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: CLICKMEETING_GET_PHONE_GATEWAYSRetrieve available phone dial-in numbers for ClickMeeting webinars. Returns a list of worldwide phone gateways that participants can call to join a webinar via audio conference. Each gateway includes the country code, city location, dial-in number, and geographic coordinates. No parameters are required. Use this tool when you need to provide dial-in options for webinar participants who prefer to join by phone, or to display available dial-in numbers in meeting invitations.

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: CLICKMEETING_GET_PINGTool to check API service status. Use when verifying the ClickMeeting API connection before making requests.

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: CLICKMEETING_GET_REGISTRATIONSRetrieve registrations for a specified conference room, with optional status and pagination parameters. Use the conference ID to request a list of registered participants.

Input Parameters

integer
Page number of results, must be >= 1.
string ("pending" | "accepted" | "declined" | "all")
Filter registrations by status. Accepted values: ‘pending’, ‘accepted’, ‘declined’, ‘all’. If omitted, all statuses are returned.
integer
Number of registrations per page, must be >= 1.
string
required
Unique identifier of the conference to list registrations for.

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: CLICKMEETING_GET_SESSION_ATTENDEESRetrieve attendees for a specific conference room session, including available device, role, rating, and poll response details. Use Get Conference Sessions to find a session ID.

Input Parameters

string
required
The numeric ID of the session within the conference. A session is created each time a conference is started. Obtain this from the Get Conference Sessions action.
string
required
The numeric ID of the conference room. Obtain this from the Get Conferences action or from the conference URL.

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: CLICKMEETING_GET_SESSION_DETAILSRetrieve detailed statistics for a specific past conference session. Returns attendance data (total and max concurrent visitors), participant list with join/leave times, and PDF report generation URLs. Sessions are only available after a conference has actually been held - scheduled or active conferences without any past meetings will not have sessions. First use Get Conference Sessions to obtain valid session_id values.

Input Parameters

integer
required
Unique ID of the session to retrieve. Obtain this from the Get Conference Sessions action. Sessions are only created after a conference has been held.
integer
required
Unique ID of the conference room. Obtain this from the Get Conferences action.

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: CLICKMEETING_GET_SESSION_POLL_DETAILSTool to retrieve details of a specific poll conducted during a session. Use after confirming conference_id, session_id, and poll_id to analyze poll results.

Input Parameters

integer
required
Unique ID of the poll to retrieve details for
integer
required
Unique ID of the session in which the poll was conducted
integer
required
Unique ID of the conference to which the session belongs

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: CLICKMEETING_GET_SESSION_QA_HISTORYRetrieve Q&A history for a specific session. An HTTP 404 or a response with code 404 is returned as an empty Q&A history, so an empty result can also indicate a missing session.

Input Parameters

integer
required
Numeric ID of the session to retrieve Q&A history for. Obtain this from GET /conferences/{room_id}/sessions which returns a list of sessions with their IDs.

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: CLICKMEETING_GET_SESSION_RECORDINGSRetrieve all recordings for a conference room. Each recording includes the duration, file size, start time, and a download URL (expires after 5 minutes). Use after confirming the room_id from the Get Conferences action. Note: Recordings are only available after a conference session has been held and recorded.

Input Parameters

integer
required
Unique ID of the conference room to fetch recordings from. Obtain this from the Get Conferences action.

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: CLICKMEETING_GET_SESSION_REGISTRATIONSRetrieve registrations for a specific session within a conference room. Requires both conference_id (room ID) and session_id. Use CLICKMEETING_GET_CONFERENCES to get conference IDs and CLICKMEETING_GET_CONFERENCE_SESSIONS to get session IDs.

Input Parameters

integer
Page number for pagination, must be >= 1
integer
Number of registrations per page, must be between 1 and 1000
integer
required
Unique identifier of the session to retrieve registrations for
integer
required
Unique identifier of the conference/room containing the session

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: CLICKMEETING_GET_SESSION_SURVEY_DETAILSRetrieve details of a survey or poll conducted during a ClickMeeting conference session, using the conference, session, and survey IDs.

Input Parameters

string
required
Unique identifier of the survey within the session. Obtain this from Get Session Surveys action.
string
required
Unique identifier of the session. A session is created each time a conference room is started. Obtain this from Get Conference Sessions action.
string
required
Unique identifier of the conference room (room_id). Obtain this from Get Conferences action.

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: CLICKMEETING_GET_SESSION_SURVEYSRetrieve the list of surveys conducted during a specific ClickMeeting conference session. Use a conference ID and a session ID to identify the session.

Input Parameters

string
required
The numeric ID of the session within the conference. A session is created each time a conference is started. Obtain this from the Get Conference Sessions action.
string
required
The numeric ID of the conference room. Obtain this from the Get Conferences action.

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: CLICKMEETING_GET_TIME_ZONE_LISTRetrieves all available time zones supported by ClickMeeting. Returns IANA time zone names (e.g., ‘Europe/Warsaw’, ‘America/New_York’). Use this to get valid time zone values when creating or scheduling conferences.

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: CLICKMEETING_GET_TIME_ZONE_LIST_BY_COUNTRYRetrieve available time zones for a specific country by ISO 3166-1 alpha-2 country code. Returns a list of IANA time zone identifiers (e.g., ‘America/New_York’, ‘Europe/Warsaw’). Useful when scheduling conferences and needing to present time zone options relevant to a specific country. Example: ‘Get time zones for country_code=US’ returns US time zones like America/New_York, America/Los_Angeles, etc.

Input Parameters

string
required
ISO 3166-1 alpha-2 country code (e.g., ‘US’ for United States, ‘PL’ for Poland, ‘DE’ for Germany)

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: CLICKMEETING_GET_TOKEN_BY_EMAILTool to retrieve access tokens assigned to a specific email address for a token-protected conference room. Use this action when you need to get tokens for participants in rooms with access_type=3 (token-based access).

Input Parameters

string
required
Email address to retrieve access tokens for
integer
required
Numeric ID of the token-protected conference room (access_type=3)

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: CLICKMEETING_LIST_ACCESS_TOKENSTool to retrieve all generated access tokens for a token-protected conference room. Use when you need to view token values, associated emails, and first use dates for access control. Only works with conferences that have access_type=3 (token-based protection).

Input Parameters

integer
required
Unique identifier of the token-protected conference room. Must be a conference with access_type=3 (token-based access).

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: CLICKMEETING_LIST_REGISTRATIONS_BY_STATUSTool to retrieve registered participants of a conference room filtered by registration status. Use when you need to get all registrations or only active registrations for a specific conference.

Input Parameters

string ("all" | "active")
required
Registration status filter: ‘all’ for all registrations, ‘active’ for active registrations only
integer
required
Unique identifier of the conference room

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: CLICKMEETING_REGISTER_PARTICIPANTRegister a participant for a specified ClickMeeting conference room using their name and email, with optional confirmation email settings.

Input Parameters

integer
required
Unique identifier of the conference room
object
required
Participant registration details
object
Settings for sending a confirmation email to the participant.

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: CLICKMEETING_SEND_INVITATIONTool to send invitation emails to participants for a ClickMeeting conference. Use this after creating a conference to invite attendees by email. Supports multiple recipients, different templates, and role assignment.

Input Parameters

string
Language code for the invitation email (e.g., ‘en’, ‘de’, ‘es’, ‘fr’, ‘pl’)
string ("listener" | "presenter")
Role to assign to invited attendees. ‘listener’ for regular participants, ‘presenter’ for speakers.
string ("basic" | "advanced")
Template type for the invitation email. Use ‘basic’ for simple emails or ‘advanced’ for detailed emails.
array
required
List of attendees to invite via email. Each attendee must have an email address.
integer
required
Unique identifier of the conference room to send invitations for

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: CLICKMEETING_UPDATE_CONFERENCETool to update an existing conference room’s parameters. Use when you need to modify conference settings such as name, type, access mode, lobby, schedule, or registration.

Input Parameters

string
The display name of the conference room visible to attendees.
string ("active" | "inactive")
Conference status. ‘inactive’ rooms cannot be joined.
integer
required
Unique identifier of the conference room to update.
integer
ID of the UI skin/theme. Get available skins from get_conference_skins endpoint.
string
Duration in ‘H:MM’ format (e.g., ‘1:30’ for 1 hour 30 minutes).
string
Room password. Required when access_type is ‘password’.
object
Advanced conference settings.
string
IANA time zone identifier for the scheduled start time.
string ("meeting" | "webinar")
Type of room: ‘meeting’ for collaborative sessions or ‘webinar’ for one-to-many broadcast.
string
Meeting start date/time. Format: ‘YYYY-MM-DD HH:MM:SS’ or ISO 8601.
string ("open" | "password" | "token")
Access control mode for the conference room.
object
Registration configuration for a conference.
boolean
Enable or disable the waiting lobby before joining.
boolean
False for one-time meeting (scheduled), True for permanent room (always available).
string
Custom message displayed in the waiting lobby before the event starts (max 160 characters, UTF-8).

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: CLICKMEETING_UPLOAD_FILEUpload a file to the ClickMeeting file library. Files can be uploaded to the user’s general library or to a specific conference room. Uploaded files are available for use in meetings as presentations, videos, or other materials.

Input Parameters

object
required
File to upload to the ClickMeeting file library.
integer
Conference room ID to upload the file to a specific room. If omitted, file is uploaded to the user’s general library. Get room IDs from CLICKMEETING_GET_CONFERENCES.

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