- Category: customer support
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 179
- Triggers: 0
- Slug:
GLEAP - Version: 20261101_00
Tools
Archive All Tickets
Archive All Tickets
GLEAP_ARCHIVE_ALL_TICKETSTool to archive all tickets matching specific type and status criteria. Use when you need to bulk archive multiple tickets at once based on their type and status.Input Parameters
Output
Archive a Ticket
Archive a Ticket
Clone Engagement
Clone Engagement
Create a Collection
Create a Collection
Create AI Content
Create AI Content
GLEAP_CREATE_AI_CONTENTCreates or updates AI content in Gleap’s knowledge base for AI assistants to reference. Supports text, file, and product content types, with an optional batch identifier for grouping items.Input Parameters
Output
Create a new chat message
Create a new chat message
GLEAP_CREATE_A_NEW_CHAT_MESSAGECreates a chat message for a Gleap session, with a user or admin role and message content. Returns the created message details when the response matches the expected schema.Input Parameters
Output
Create a new session
Create a new session
GLEAP_CREATE_A_NEW_SESSIONCreate a new user session in Gleap and associate it with a project. Use this to track user activity, engagement metrics, and session data. Sessions can be created with minimal information and enriched later through identify_user or other API calls.Input Parameters
Output
Create a new team
Create a new team
GLEAP_CREATE_A_NEW_TEAMTool to create a new team. Use when you have team details ready and want to assign tickets among members.Input Parameters
Output
Create a new ticket
Create a new ticket
GLEAP_CREATE_A_NEW_TICKETCreate a new support ticket in Gleap with detailed information including title, description, type, priority, status, tags, and attachments. Supports custom metadata and sentiment tracking for comprehensive ticket management and customer feedback analysis.Input Parameters
Output
Create Engagement Checklist
Create Engagement Checklist
Create Engagement Cobrowse
Create Engagement Cobrowse
Create Engagement Email
Create Engagement Email
GLEAP_CREATE_ENGAGEMENT_EMAILTool to create a new engagement email in Gleap. Use when you want to send emails for user engagement, announcements, or marketing campaigns. Requires name, subject, and body; other fields are optional with defaults (type: ‘EMAIL’, status: ‘draft’, format: ‘widget’, frequency: ‘once’, targetAudience: ‘all’).Input Parameters
Output
Create Engagement Modal
Create Engagement Modal
GLEAP_CREATE_ENGAGEMENT_MODALTool to create a new engagement modal in Gleap. Use when you want to display a modal dialog for user engagement, onboarding, announcements, or feature introductions.Input Parameters
Output
Create Engagement Product Tour
Create Engagement Product Tour
GLEAP_CREATE_ENGAGEMENT_PRODUCT_TOURTool to create a new product tour in Gleap. Use when you want to create guided tours for onboarding, feature introductions, or step-by-step walkthroughs for users.Input Parameters
Output
Create Engagement Push Notification
Create Engagement Push Notification
GLEAP_CREATE_ENGAGEMENT_PUSH_NOTIFICATIONTool to create a new push notification in Gleap. Use when you want to send push notifications for user engagement, announcements, or alerts. All fields are optional; the API will create a notification with default values (name: ‘New survey’, type: ‘PUSH’, status: ‘draft’, sound: true, hidden: false, sent: false, format: ‘widget’, frequencyType: ‘dynamic’, frequency: ‘once’, frequencyDays: 0).Input Parameters
Output
Create Engagement Tooltip
Create Engagement Tooltip
Create feedback item
Create feedback item
GLEAP_CREATE_FEEDBACK_ITEMTool to manually create a feedback item (bug) in a Gleap project. Use when you need to: - Create a new bug report programmatically - Add customer feedback to a specific project - Submit feature requests or issues via API Requires project ID, title, and description. Supports optional fields like type, priority, status, tags, and custom metadata for comprehensive feedback tracking.Input Parameters
Output
Create Help Center Redirect
Create Help Center Redirect
GLEAP_CREATE_HELPCENTER_REDIRECTTool to create a new redirect for help center URLs. Use when you need to redirect old or deprecated help articles to new URLs. Supports both exact URL matching and pattern-based matching for flexible redirect rules.Input Parameters
Output
Create Message Template
Create Message Template
GLEAP_CREATE_MESSAGE_TEMPLATETool to create a new message template in Gleap. Use when creating pre-defined message templates for support conversations, automated responses, or quick replies. The template can include actions (buttons, links) and attachments, and can be shared publicly or restricted to specific users.Input Parameters
Output
Create new conversation with session
Create new conversation with session
GLEAP_CREATE_NEW_CONVERSATIONCreate a new conversation with a session in Gleap. Use this action to initiate a conversation linked to a specific session ID within a project.Input Parameters
Output
Create QA Snippet
Create QA Snippet
Create Tracker Ticket
Create Tracker Ticket
Delete AI Content
Delete AI Content
Delete AI Content Batch
Delete AI Content Batch
GLEAP_DELETE_AICONTENT_BATCHTool to delete all AI content by batchId. Use when you need to remove all AI-generated content associated with a specific batch identifier.Input Parameters
Output
Delete a User from a Project
Delete a User from a Project
GLEAP_DELETE_A_USER_FROM_A_PROJECTRemoves a user (team member) from a Gleap project, revoking their access. Use this when you need to remove a team member’s access to the project by their user ID. The user ID can be obtained from the ‘Get All Users for a Project’ action. Note: This removes organization members from the project, not end-user sessions/contacts.Input Parameters
Output
Delete Bugs
Delete Bugs
Delete Engagement Chat Message
Delete Engagement Chat Message
GLEAP_DELETE_ENGAGEMENT_CHAT_MESSAGEDeletes an engagement chat message from Gleap by its ID. Use this action to permanently remove a chat message from a conversation. The message ID must be obtained from a prior list or get operation. Once deleted, the message cannot be recovered.Input Parameters
Output
Delete Engagement Checklist
Delete Engagement Checklist
Delete Engagement Cobrowse
Delete Engagement Cobrowse
GLEAP_DELETE_ENGAGEMENT_COBROWSETool to delete a cobrowse product tour by its ID. Use when you need to remove a cobrowse product tour from the project.Input Parameters
Output
Delete Engagement Email
Delete Engagement Email
GLEAP_DELETE_ENGAGEMENT_EMAILTool to delete an engagement email by its ID. Use when you need to remove an email from the project’s engagement emails list.Input Parameters
Output
Delete Engagement Modal
Delete Engagement Modal
Delete Engagement News
Delete Engagement News
GLEAP_DELETE_ENGAGEMENT_NEWSTool to delete an engagement news article. Use when you need to remove a news article from the project by its news ID.Input Parameters
Output
Delete Engagement Product Tour
Delete Engagement Product Tour
GLEAP_DELETE_ENGAGEMENT_PRODUCT_TOURTool to delete an engagement product tour by its ID. Use when you need to remove a product tour from the project’s engagement product tours list.Input Parameters
Output
Delete Engagement Push Notification
Delete Engagement Push Notification
GLEAP_DELETE_ENGAGEMENT_PUSH_NOTIFICATIONTool to delete an engagement push notification by its ID. Use when you need to remove a push notification from the project’s engagement push notifications list.Input Parameters
Output
Delete Engagement Surveys
Delete Engagement Surveys
Delete Engagement Tooltips
Delete Engagement Tooltips
GLEAP_DELETE_ENGAGEMENT_TOOLTIPSTool to delete an engagement tooltip. Use when you need to remove a tooltip from the project by its tooltip ID.Input Parameters
Output
Delete Engagement WhatsApp Message
Delete Engagement WhatsApp Message
GLEAP_DELETE_ENGAGEMENT_WHATSAPP_MESSAGETool to delete an engagement WhatsApp message by its ID. Use when you need to remove a WhatsApp message from the project’s engagement WhatsApp messages list.Input Parameters
Output
Delete Help Center Collection
Delete Help Center Collection
Delete Help Center Redirect
Delete Help Center Redirect
Delete Message
Delete Message
Delete Message Template
Delete Message Template
GLEAP_DELETE_MESSAGE_TEMPLATETool to delete a message template. Use when you need to remove a message template from the project by its template ID.Input Parameters
Output
Delete Old AI Content Batches
Delete Old AI Content Batches
GLEAP_DELETE_OLD_AI_CONTENT_BATCHESDelete all AI content batches except the current batch. Use when cleaning up old AI content and keeping only the latest batch by providing its ID.Input Parameters
Output
Delete QA Answer
Delete QA Answer
GLEAP_DELETE_PROJECTS_QAANSWERSTool to delete a QA answer (snippet) from a Gleap project. Use when removing help center content or AI assistant snippets.Input Parameters
Output
Delete project session
Delete project session
GLEAP_DELETE_PROJECTS_SESSIONSTool to delete a session from a Gleap project. Use when you need to remove session data by providing both project ID and session ID.Input Parameters
Output
Delete session
Delete session
Delete Team
Delete Team
Delete Ticket
Delete Ticket
Export sessions
Export sessions
GLEAP_EXPORT_SESSIONSTool to export sessions for the authenticated project in CSV format. Use when you need to export session data for analysis, reporting, or backup purposes. Returns comprehensive session information in CSV format including user details, activity data, and metadata. Use limit and skip parameters to control pagination for large datasets.Input Parameters
Output
Export Statistics Lists
Export Statistics Lists
GLEAP_EXPORT_STATISTICS_LISTSTool to export statistics list data as CSV from Gleap. Use when you need to export performance metrics, analytics, or reports. Supports various report types including team performance, article statistics, ticket ratings, SLA reports, and more. Results can be filtered by date range, grouped by time intervals, and paginated for large datasets.Input Parameters
Output
Generate ticket draft reply
Generate ticket draft reply
GLEAP_GENERATE_TICKET_DRAFT_REPLYTool to generate an AI-powered draft reply for a ticket. Use when you need to automatically create a contextual response based on the ticket content, similar tickets, and knowledge base articles. The AI analyzes the ticket and suggests an appropriate reply that can be reviewed and sent.Input Parameters
Output
Generate tracker ticket data
Generate tracker ticket data
GLEAP_GENERATE_TRACKER_TICKET_DATATool to generate AI-powered tracker ticket data from an existing ticket. Use when you need to automatically create a title and description for a tracker ticket based on a source ticket’s content. The AI analyzes the source ticket and generates appropriate metadata.Input Parameters
Output
Get a Checklist
Get a Checklist
Get a Collection
Get a Collection
Get AI content
Get AI content
Get all articles
Get all articles
Get all chat messages
Get all chat messages
GLEAP_GET_ALL_CHAT_MESSAGESRetrieves all engagement chat messages from the current Gleap project. Use this action to: - List all chat conversations across all sessions - Review customer support interactions and message history - Analyze chat engagement data and message patterns - Export or audit chat communications Returns messages sorted by creation date (newest first) with complete metadata including sender information, session details, content, and timestamps. Supports pagination via limit and skip parameters.Input Parameters
Output
Get All Collections
Get All Collections
GLEAP_GET_ALL_COLLECTIONSRetrieves all help center collections for the authenticated project. Collections are organizational containers in the help center that group related articles. Each collection can contain articles and nested sub-collections. Use this action to: - Get an overview of all collections in the help center - Check collection counts (articles and sub-collections) - Access collection metadata (titles, descriptions, audience filters) Returns an empty list if no collections exist in the project.Output
Get All Invitations for a Project
Get All Invitations for a Project
Get all sessions
Get all sessions
GLEAP_GET_ALL_SESSIONSRetrieves all user sessions for the authenticated project. This endpoint returns comprehensive session data including user information, activity timestamps, engagement metrics, and metadata for all sessions associated with the project. Useful for analytics, user tracking, and session management. Use limit and skip parameters to control pagination for large datasets.Input Parameters
Output
Get All Teams
Get All Teams
Get All Tickets
Get All Tickets
GLEAP_GET_ALL_TICKETSRetrieve tickets from a Gleap project with optional filtering, sorting, and pagination. This action fetches tickets from the authenticated Gleap project. Without parameters, it returns all tickets. Use filters to narrow results by type, status, priority, or spam classification. Results can be sorted and paginated for efficient data retrieval. Use cases: - List all open bugs: Set status=‘OPEN’ and type=‘BUG’ - Get recent tickets: Set sort=’-createdAt’ and limit=20 - Paginate through tickets: Use skip and limit parameters - Find high-priority issues: Set priority=‘HIGH’Input Parameters
Output
Get All Users for a Project
Get All Users for a Project
Get a ticket
Get a ticket
GLEAP_GET_A_TICKETRetrieves complete details for a specific ticket by its ID. Use this action when you need to: - View full ticket information including title, description, status, and priority - Check ticket metadata like creation time, tags, and custom data - Access associated session and user information - Review AI-generated summaries and support recommendations Returns comprehensive ticket data including type (BUG/FEATURE_REQUEST), priority level, sentiment analysis, upvotes, linked tickets, and custom fields.Input Parameters
Output
Get current user
Get current user
GLEAP_GET_CURRENT_USERRetrieves the authenticated user’s profile including email, name, user type, availability status, notification preferences, and 2FA settings. No parameters required - uses authentication from headers. Returns detailed user information including notification preferences for different event types (tickets, assignments, mentions) and account settings.Output
Get engagement activities count
Get engagement activities count
GLEAP_GET_ENGAGEMENT_ACTIVITIES_COUNTTool to retrieve the count of activities for a specific engagement. Use when you need to know how many activities are associated with an engagement without fetching all activity details.Input Parameters
Output
Get engagement chat message
Get engagement chat message
GLEAP_GET_ENGAGEMENT_CHAT_MESSAGERetrieves a specific engagement chat message by its ID. Use this action to fetch complete details of a single chat message including content, sender role, timestamps, and configuration settings.Input Parameters
Output
Get Engagement Checklists
Get Engagement Checklists
Get Engagement Cobrowse
Get Engagement Cobrowse
GLEAP_GET_ENGAGEMENT_COBROWSERetrieves all cobrowse product tours for the authenticated project. Cobrowse product tours are interactive guided experiences that help users navigate through features or workflows. Use this action to get an overview of all configured cobrowse tours in your project, including their status, steps, and settings.Output
Get engagement cobrowse by ID
Get engagement cobrowse by ID
GLEAP_GET_ENGAGEMENT_COBROWSE_BY_IDTool to retrieve a specific cobrowse product tour by its ID. Use when you need to fetch complete details of a single cobrowse tour including steps, settings, status, and configuration.Input Parameters
Output
Get engagement email
Get engagement email
GLEAP_GET_ENGAGEMENT_EMAILRetrieves a specific engagement email by its ID. Use this action to fetch complete details of a single engagement email including name, subject, body content, status, and configuration settings like frequency, target audience, and scheduling.Input Parameters
Output
Get Engagement Emails
Get Engagement Emails
Get engagement modal
Get engagement modal
GLEAP_GET_ENGAGEMENT_MODALRetrieves an engagement modal by its ID, including available content, targeting, button configuration, and display settings. A 204 response returns an empty modal result.Input Parameters
Output
Get Engagement Modals
Get Engagement Modals
Get Engagement News
Get Engagement News
Get engagement news article
Get engagement news article
GLEAP_GET_ENGAGEMENT_NEWS_ARTICLERetrieves a specific engagement news article by its ID. Use this action to fetch complete details of a single news article including content, configuration, targeting settings, and delivery schedule.Input Parameters
Output
Get a Product Tour
Get a Product Tour
Get Engagement Product Tours
Get Engagement Product Tours
Get engagement push notification
Get engagement push notification
GLEAP_GET_ENGAGEMENT_PUSH_NOTIFICATIONRetrieves a specific engagement push notification by its ID. Use this action to fetch complete details of a single push notification including name, title, message content, status, and configuration settings like frequency, target audience, and scheduling.Input Parameters
Output
Get Engagement Push Notifications
Get Engagement Push Notifications
Get Engagements Activities
Get Engagements Activities
GLEAP_GET_ENGAGEMENTS_ACTIVITIESTool to retrieve all activities for a specific engagement. Use when you need to track user interactions, view engagement performance, or analyze activity patterns for a particular engagement campaign.Input Parameters
Output
Get engagement recipients
Get engagement recipients
GLEAP_GET_ENGAGEMENTS_RECIPIENTSTool to find and retrieve recipients for a specific engagement. Use when you need to: - View all recipients who received an engagement (email, push notification, etc.) - Check delivery status and engagement metrics for recipients - Track when recipients opened or clicked on engagement contentInput Parameters
Output
Get engagement statistics
Get engagement statistics
GLEAP_GET_ENGAGEMENTS_STATISTICSTool to retrieve statistics for a specific engagement. Use when you need to analyze engagement performance metrics such as views, interactions, conversions, and user behavior data.Input Parameters
Output
Get Engagement Survey
Get Engagement Survey
GLEAP_GET_ENGAGEMENT_SURVEYTool to retrieve a survey by its ID. Use when you need to view survey details including name, description, status, format, questions, and other configuration settings.Input Parameters
Output
Get Engagement Surveys
Get Engagement Surveys
Get Survey Responses
Get Survey Responses
Get Engagement Survey Response Samples
Get Engagement Survey Response Samples
GLEAP_GET_ENGAGEMENT_SURVEYS_RESPONSES_SAMPLESTool to retrieve survey response samples for a specific engagement survey. Use when you need to view example responses, analyze survey feedback patterns, or audit survey submissions for a particular survey.Input Parameters
Output
Summarize Survey Responses
Summarize Survey Responses
GLEAP_GET_ENGAGEMENT_SURVEYS_RESPONSES_SUMMARIZETool to retrieve an AI-generated summary of survey responses. Use when you need to analyze survey feedback, understand response patterns, or get insights from customer feedback without reviewing individual responses.Input Parameters
Output
Get Engagement Tooltip by ID
Get Engagement Tooltip by ID
GLEAP_GET_ENGAGEMENT_TOOLTIP_BY_IDTool to retrieve a specific engagement tooltip by its ID. Use when you need to get detailed information about a specific tooltip.Input Parameters
Output
Get Engagement Tooltips
Get Engagement Tooltips
Get engagement WhatsApp message
Get engagement WhatsApp message
GLEAP_GET_ENGAGEMENT_WHATSAPP_MESSAGERetrieves a specific engagement WhatsApp message by its ID. Use this action to fetch complete details of a single WhatsApp message including content, status, and configuration settings like frequency, target audience, and scheduling.Input Parameters
Output
Get Help Center Sources
Get Help Center Sources
Get Invitations
Get Invitations
Get message template
Get message template
GLEAP_GET_MESSAGE_TEMPLATERetrieves a specific message template by its ID from a Gleap project. Use this when you need to fetch the details of a particular message template including its title, content, visibility settings, and associated metadata.Input Parameters
Output
Get Message Templates
Get Message Templates
Get notification ticket
Get notification ticket
GLEAP_GET_NOTIFICATION_TICKETRetrieve a Gleap ticket using its notification share token. The tool uses the configured Gleap connection to request ticket details.Input Parameters
Output
Get project
Get project
GLEAP_GET_PROJECTRetrieves complete details for a specific project by its ID. Use when you need to view project configuration, settings, notification preferences, or metadata for a single project.Input Parameters
Output
Get Projects
Get Projects
Get archived bugs
Get archived bugs
GLEAP_GET_PROJECTS_BUGS_ARCHIVETool to retrieve archived bugs for a specific project. Use when you need to view bugs that have been archived or moved to history for a given project.Input Parameters
Output
Get Projects Help Center Collections
Get Projects Help Center Collections
Get project sessions
Get project sessions
Get Projects Tickets
Get Projects Tickets
Get project users
Get project users
Get a session
Get a session
GLEAP_GET_SESSIONRetrieves detailed information for a specific session by its ID. Use this when you need to fetch comprehensive session data including user information, activity timestamps, engagement metrics, and custom metadata for a particular session.Input Parameters
Output
Get session activities
Get session activities
GLEAP_GET_SESSION_ACTIVITIESRetrieves all activities for a specific session by session ID. Use this action when you need to fetch detailed activity data for a particular session, including user interactions and session events.Input Parameters
Output
Get session Chargebee info
Get session Chargebee info
Get Session Checklists
Get Session Checklists
GLEAP_GET_SESSION_CHECKLISTSRetrieve all engagement checklists associated with a user session in Gleap. Engagement checklists help track user progress through onboarding flows, feature adoption, or guided workflows. Use this after obtaining a valid session ID (e.g., from Get All Sessions). Returns an empty list if the session has no associated checklists.Input Parameters
Output
Get session events by ID
Get session events by ID
GLEAP_GET_SESSION_EVENTSTool to retrieve all streamed events for a specific session by its ID. Use when you need to get detailed event stream data for debugging user behavior or analyzing session activity.Input Parameters
Output
Get session LemonSqueezy info
Get session LemonSqueezy info
Get Session Shopify Info
Get Session Shopify Info
Get email client bounce statistics
Get email client bounce statistics
GLEAP_GET_STATISTICS_EMAIL_CLIENT_BOUNCESTool to retrieve email client bounce statistics from Gleap. Use when you need to analyze email delivery failures and bounce rates over time. The statistics can be filtered by date range, grouped by time intervals (day, month, year), and filtered by specific email server configurations.Input Parameters
Output
Get Email Client Usage Statistics
Get Email Client Usage Statistics
GLEAP_GET_STATISTICS_EMAIL_CLIENT_USAGETool to retrieve email client usage statistics from Gleap. Returns metrics such as sent emails, bounces, spam reports, and open rates. Use when you need to analyze email delivery performance, track email engagement, or monitor email client behavior over time. Note: The API typically requires startDate and endDate parameters to function properly.Input Parameters
Output
Get email overview statistics
Get email overview statistics
GLEAP_GET_STATISTICS_EMAIL_OVERVIEWTool to retrieve email overview statistics from Gleap. Use when you need to analyze email campaign performance metrics such as sent, delivered, opened, clicked, bounced emails, and engagement rates over a specified time period.Input Parameters
Output
Get statistics facts
Get statistics facts
GLEAP_GET_STATISTICS_FACTSTool to retrieve fact data for various statistics from Gleap. Use when you need statistical insights about tickets, AI interactions, help center engagement, or SLA performance for a specific time period.Input Parameters
Output
Get Statistics Heatmap
Get Statistics Heatmap
GLEAP_GET_STATISTICS_HEATMAPRetrieve heatmap data for activity patterns in Gleap. Use when you need to visualize busiest hours per weekday or comment activity patterns. Returns aggregated data showing activity distribution across time dimensions, helpful for identifying peak usage times and activity trends.Input Parameters
Output
Get Statistics Lists
Get Statistics Lists
GLEAP_GET_STATISTICS_LISTSTool to retrieve statistics list data from Gleap. Use when you need to access performance metrics, analytics, or reports. Supports various report types including team performance, article statistics, ticket ratings, SLA reports, and more. Results can be filtered by date range, grouped by time intervals, and paginated for large datasets.Input Parameters
Output
Get Statistics Raw Data
Get Statistics Raw Data
GLEAP_GET_STATISTICS_RAW_DATARetrieve Gleap raw statistics data for analysis or reporting. Optionally filter by date or type, specify grouping and aggregation settings, and paginate using skip and limit. Returned counts may be inferred from the number of data points when the API does not provide them.Input Parameters
Output
Get Tickets By Session Query
Get Tickets By Session Query
GLEAP_GET_TICKETS_BY_SESSION_QUERYFind tickets associated with a user session using email, user ID, phone, or the custom data TIN field. At least one of these search parameters is required; pagination is supported.Input Parameters
Output
Get Tickets Export
Get Tickets Export
GLEAP_GET_TICKETS_EXPORTExport tickets from Gleap project with optional filtering and sorting. This action retrieves tickets in an export format suitable for data analysis, reporting, or backup purposes. Use filters to narrow the export to specific ticket types, statuses, or priorities. The project is automatically identified from authentication headers.Input Parameters
Output
Get Tickets Export Fields
Get Tickets Export Fields
Search Tickets by Term
Search Tickets by Term
GLEAP_GET_TICKETS_SEARCHSearch for tickets using a text search term in Gleap. Use when you need to find tickets based on keywords or phrases in titles and descriptions.Input Parameters
Output
Get Tickets Count
Get Tickets Count
Get current user's permissions
Get current user's permissions
Get users unified inbox
Get users unified inbox
GLEAP_GET_USERS_UNIFIED_INBOXRetrieves tickets from the unified inbox for the authenticated user. Use this action to view all tickets assigned to or accessible by the current user across projects. Supports filtering by ticket type, project ID, and pagination for large result sets.Input Parameters
Output
Get users unified inbox ticket
Get users unified inbox ticket
GLEAP_GET_USERS_UNIFIED_INBOX_TICKETRetrieves complete details for a specific ticket from the unified inbox by its ID. Use this action when you need to: - View full unified inbox ticket information including title, description, status, and priority - Check ticket metadata like creation time, tags, and custom data - Access associated session and user information - Review notification status and agent replies - Get AI-generated summaries and support recommendations The unified inbox provides a consolidated view of tickets across different channels. Returns comprehensive ticket data including type, priority level, sentiment analysis, upvotes, linked tickets, and custom fields.Input Parameters
Output
Identify or update user
Identify or update user
GLEAP_IDENTIFY_USERSubmit user information to Gleap to identify a user or update an existing profile, syncing application data for customer support and feedback tracking. You can prevent the last-activity timestamp from being updated. Gleap requires the project’s identity verification secret as an Api-Token for this operation.Input Parameters
Output
Import session
Import session
GLEAP_IMPORT_SESSIONImport user sessions into Gleap for tracking and analytics. Use this action to: - Bulk import user session data from external systems - Migrate user data from other platforms into Gleap - Synchronize user information with Gleap’s session tracking - Create or update user profiles with associated metadata Each session must include a userId, and can optionally include email, name, phone, avatar, language, company information, custom data, plan, value, and tags.Input Parameters
Output
Import sessions from Intercom
Import sessions from Intercom
GLEAP_IMPORT_SESSIONS_FROM_INTERCOMImport user sessions from Intercom into Gleap. Use this to synchronize contact data and session information from your Intercom workspace to Gleap for unified customer support tracking.Input Parameters
Output
Indicate user typing
Indicate user typing
GLEAP_INDICATE_USER_TYPINGTool to indicate that a user is typing in a ticket conversation. Use this to show real-time typing indicators to other users viewing the same ticket. Set typing to true when starting to type and false when finished.Input Parameters
Output
Indicate user viewing
Indicate user viewing
GLEAP_INDICATE_USER_VIEWINGTool to indicate that a user is viewing a ticket. Use this to show real-time viewing indicators to other users accessing the same ticket. Set viewing to true when starting to view and false when finished.Input Parameters
Output
Link a Ticket
Link a Ticket
Mark Survey Responses as Read
Mark Survey Responses as Read
Merge tickets
Merge tickets
GLEAP_MERGE_TICKETSTool to merge multiple tickets into a single target ticket in Gleap. Use when you need to consolidate duplicate tickets or combine related tickets into one. You can either merge into an existing ticket by providing targetTicketId, or create a new ticket by setting shouldCreateNewTicket to true. Optionally merge contacts and tasks from all tickets.Input Parameters
Output
Post a comment on a bug
Post a comment on a bug
GLEAP_POST_BUGS_COMMENTSTool to post a comment/message on a bug or ticket in Gleap. Use when you need to add a comment to an existing bug/ticket conversation, such as providing updates, asking questions, or documenting resolution steps.Input Parameters
Output
Create Engagement News Article
Create Engagement News Article
GLEAP_POST_ENGAGEMENT_NEWSCreate an engagement news article in Gleap with scheduling, audience, and display-frequency settings.Input Parameters
Output
Create Engagement Survey
Create Engagement Survey
GLEAP_POST_ENGAGEMENT_SURVEYSTool to create a new survey in Gleap. Use when you want to create a customer feedback survey, product satisfaction survey, or any user engagement survey. Only the name field is required; all other fields are auto-populated with defaults (status=‘draft’, type=‘SURVEY’, format=‘widget’, frequency=‘once’).Input Parameters
Output
Create WhatsApp Engagement Message
Create WhatsApp Engagement Message
GLEAP_POST_ENGAGEMENT_WHATSAPP_MESSAGESTool to create a new WhatsApp message in Gleap for user engagement. Use when you want to send WhatsApp messages for customer support, announcements, or marketing campaigns. All fields are optional; the API will create a message with default values (name: ‘New whatsapp message’, type: ‘WHATSAPP’, status: ‘draft’, sound: true, hidden: false, sent: false, format: ‘widget’, frequencyType: ‘dynamic’, frequency: ‘once’, frequencyDays: 0).Input Parameters
Output
Reassign all tickets to user
Reassign all tickets to user
Resubscribe a Session
Resubscribe a Session
Search for sessions
Search for sessions
GLEAP_SEARCH_FOR_SESSIONSSearch Gleap sessions using optional filters such as user ID, email, name, session identifiers, language, and blocked or unsubscribed status. Use multiple criteria to find relevant sessions.Input Parameters
Output
Search messages
Search messages
GLEAP_SEARCH_MESSAGESSearch messages in Gleap by search term. Use when you need to find specific messages based on content, keywords, or metadata across all conversations and tickets.Input Parameters
Output
Search sessions by index
Search sessions by index
GLEAP_SEARCH_SESSIONS_BY_INDEXSearch the session index for a specified Gleap project to retrieve available session information, including user details and activity timestamps.Input Parameters
Output
Send Engagement Email Preview
Send Engagement Email Preview
GLEAP_SEND_ENGAGEMENT_EMAIL_PREVIEWTool to send a preview of an engagement email to specified email addresses. Use when you need to test or review how an engagement email will appear before sending it to the actual recipients.Input Parameters
Output
Send ticket transcript
Send ticket transcript
GLEAP_SEND_TICKET_TRANSCRIPTTool to send ticket conversation transcript to multiple email addresses. Use when you need to share the complete conversation history of a ticket with external users or team members via email.Input Parameters
Output
Snooze a Ticket
Snooze a Ticket
GLEAP_SNOOZE_A_TICKETTool to snooze a ticket for a specified duration. Use when you need to temporarily hide a ticket from active view. The ticket will be automatically unsnoozed after the duration expires.Input Parameters
Output
Suggest FAQ from message
Suggest FAQ from message
GLEAP_SUGGEST_FAQ_FROM_MESSAGETool to suggest a FAQ from a message. Use when you want to accept or reject a FAQ suggestion for a specific message.Input Parameters
Output
Toggle Collection Publish Status
Toggle Collection Publish Status
GLEAP_TOGGLE_HELPCENTER_COLLECTION_PUBLISHTool to toggle the publish status of a help center collection. Use when you need to publish or unpublish a collection to control its visibility in the help center.Input Parameters
Output
Track events
Track events
GLEAP_TRACK_EVENTSSubmit batches of custom user events to Gleap for analytics and behavior monitoring. Events can include custom data and must reference previously identified users. Gleap requires the project’s identity verification secret as an Api-Token for this operation.Input Parameters
Output
Unarchive a Ticket
Unarchive a Ticket
Unlink a Ticket
Unlink a Ticket
Unsubscribe sessions
Unsubscribe sessions
Update AI Content by Content ID
Update AI Content by Content ID
Update a team
Update a team
GLEAP_UPDATE_A_TEAMUpdates an existing team’s name, assignment method, members, and optional ticket-assignment settings. The team ID, name, assignment method, and members are required.Input Parameters
Output
Update a ticket
Update a ticket
GLEAP_UPDATE_A_TICKETTool to update an existing ticket/bug in Gleap. Use when you need to modify ticket properties like status, priority, description, type, assigned user, tags, or other attributes. All fields except the ticket ID are optional - only provide the fields you want to update.Input Parameters
Output
Update a User for a Project
Update a User for a Project
Update Chat Message
Update Chat Message
GLEAP_UPDATE_CHAT_MESSAGEUpdates an existing chat message in Gleap by its ID. This action modifies one or more fields of a chat message such as content, status, visibility, and other properties. Use this after creating a chat message to edit its text, change its status from draft to active, or update other metadata. The message ID must be obtained from a prior create or list operation. Common use cases: - Edit message content after sending - Change message status (draft → active) - Toggle message visibility (hidden/shown) - Update message metadata (name, sound settings)Input Parameters
Output
Update a Checklist
Update a Checklist
Update Engagement Cobrowse
Update Engagement Cobrowse
Update Engagement Email
Update Engagement Email
Update Engagement Modal
Update Engagement Modal
Update Engagement News
Update Engagement News
GLEAP_UPDATE_ENGAGEMENT_NEWSTool to update an engagement news article. Use when modifying news article properties like name, status, scheduling, targeting, or other attributes.Input Parameters
Output
Update Engagement Product Tour
Update Engagement Product Tour
Update Engagement Push Notification
Update Engagement Push Notification
Update Engagement Survey
Update Engagement Survey
GLEAP_UPDATE_ENGAGEMENT_SURVEYSTool to update an existing engagement survey in Gleap. Use when you need to modify survey properties like name, status, type, format, frequency settings, or targeting. Only the surveyId is required; all other fields are optional - provide only the fields you want to update.Input Parameters
Output
Update Engagement Tooltips
Update Engagement Tooltips
GLEAP_UPDATE_ENGAGEMENT_TOOLTIPSTool to update an engagement tooltip. Use when modifying tooltip properties like name, active status, targeting, or frequency settings.Input Parameters
Output
Update Engagement WhatsApp Message
Update Engagement WhatsApp Message
Update Helpcenter Collection
Update Helpcenter Collection
GLEAP_UPDATE_HELPCENTER_COLLECTIONTool to update a help center collection. Use when you need to modify an existing collection’s properties such as title, description, icon, audience filters, or organizational structure. All fields except the collection ID are optional - only provide the fields you want to update.Input Parameters
Output
Update help center redirect
Update help center redirect
GLEAP_UPDATE_HELPCENTER_REDIRECTTool to update an existing help center redirect. Use when you need to modify the URL paths or match type of an existing redirect rule. This allows you to change where old URLs redirect to or update the matching strategy.Input Parameters
Output
Update message template
Update message template
GLEAP_UPDATE_MESSAGE_TEMPLATETool to update an existing message template in Gleap. Use when you need to modify template properties like title, content, ordering, visibility, or associated actions. All fields except the template ID, title, content, and lexorank are optional.Input Parameters
Output
Update project
Update project
GLEAP_UPDATE_PROJECTTool to update a Gleap project’s configuration including name, description, notification settings, and feedback tags. Use when you need to modify project settings such as enabling/disabling notifications, updating contact information, or managing feedback categories. Rate limit: 1000 requests per minute.Input Parameters
Output
Update QA Answer
Update QA Answer
Update a session
Update a session
GLEAP_UPDATE_SESSIONTool to update an existing session in Gleap. Use when you need to modify session properties like user information (name, email, phone), custom data, tags, or other session attributes. All fields except the session ID are optional - only provide the fields you want to update.Input Parameters
Output
Update user
Update user
GLEAP_UPDATE_USERTool to update a user’s profile information including name, availability, profile image, onboarding status, and notification settings. Use when you need to modify user profile data or preferences. Use ‘me’ as the user_id to update the authenticated user.Input Parameters
Output
Vote for ticket
Vote for ticket
GLEAP_VOTE_FOR_TICKETTool to vote for a ticket in Gleap. Use when users want to upvote or show support for a specific ticket or feature request. Each email can only vote once per ticket to prevent duplicate votes.