Gleap

Tool to retrieve a help center collection by ID. Use when you need to fetch specific collection details by its ID.

Tool to retrieve a specific engagement product tour by its ID. Use after obtaining a valid productTourId to fetch detailed tour configuration including steps, targeting, and timing settings.

Retrieves 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.

Tool to retrieve AI content by its content ID. Use when you need to fetch specific AI-generated or AI-managed content from Gleap's AI content system.

Tool to retrieve articles in a help center collection. Use when you have a helpcenterCollectionId and want to list its articles. Supports pagination via limit and skip parameters.

Retrieves 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.

Retrieves 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.

Retrieves all pending invitations for a project. Use this to list users who have been invited to join the project but haven't accepted yet. The project context is automatically determined from the authentication headers.

Retrieves 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.

Tool to retrieve all teams. Use when you need a list of all teams for the authenticated project.

Retrieve 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'

Tool to retrieve all users for a project. Use when you need to list every user associated with the current project.

Tool 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.

Retrieves 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.

Tool to retrieve the current user's role permissions. Use when you need to check what permissions the authenticated user has.

Tool 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.

Tool 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.

Tool 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.

Tool 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.

Tool to retrieve an engagement banner by its ID. Use when you need to fetch specific banner details including title, message, button configuration, targeting settings, and display schedule.

Tool to retrieve all engagement banners from a Gleap project. Use when you need to list all banners for viewing, auditing, or selecting a specific banner for further operations.

Retrieves 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.

Tool to retrieve all engagement checklists for a project. Use when you need to get an overview of all available checklists.

Retrieves 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.

Tool 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.

Retrieves 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.

Tool to retrieve all engagement emails from a Gleap project. Use when you need to list all emails for viewing, auditing, or selecting a specific email for further operations.

Tool to retrieve an engagement modal by its ID. Use when you need to fetch specific modal details including title, message, button configuration, targeting settings, and display schedule.

Tool to retrieve all engagement modals from a Gleap project. Use when you need to list all modals for viewing, auditing, or selecting a specific modal for further operations.

Tool to retrieve all engagement news articles from a Gleap project. Use when you need to list all news articles for viewing, auditing, or selecting a specific article for further operations.

Retrieves 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.

Tool to retrieve all engagement product tours for a project. Use when you need to get an overview of all available product tours.

Retrieves 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.

Tool to retrieve all engagement push notifications from a Gleap project. Use when you need to list all push notifications for viewing, auditing, or selecting a specific push notification for further operations.

Tool 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 content

Tool 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.

Tool 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.

Tool 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.

Tool to retrieve all engagement surveys from a Gleap project. Use when you need to list all surveys for viewing, auditing, or selecting a specific survey for further operations.

Tool to retrieve a specific engagement tooltip by its ID. Use when you need to get detailed information about a specific tooltip.

Tool to retrieve all engagement tooltips for the authenticated project. Use when you need to get a list of all configured tooltips.

Retrieves 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.

Tool 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.

Retrieves all configured help center sources (knowledge base content sources) for the project. Returns a list of sources with their IDs, titles, URLs, and metadata. Use this to discover available help center content sources before querying articles or answering questions.

Retrieves all invitations for the authenticated user. Use this to list all pending invitations (both organisation and project invitations) associated with the current user. The user context is automatically determined from the authentication headers.

Retrieves 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.

Retrieve all message templates for the authenticated project. Use when you need to list available message templates for customer communication. Message templates are pre-defined message formats that can be used for consistent communication with users. This action supports optional filtering via search term and pagination with a limit parameter.

Retrieves detailed information about a Gleap ticket using its notification share token. Use this action to access public ticket details via a share token, which is typically obtained from ticket notifications or webhooks. This allows viewing ticket information without requiring full authentication. Returns comprehensive ticket data including title, description, status, priority, tags, and session information.

Tool to retrieve all sessions for a specific project. Use when you need to get session data for a particular project by its ID. Returns comprehensive session information including user details, activity timestamps, and metadata.

Tool to get project users by project ID. Use when you need to list all users associated with a specific project.

Tool to get all help center collections for a project. Use when you need to retrieve the complete list of help center collections including their metadata, titles, descriptions, and audience targeting settings.

Tool to retrieve all tickets from a specific Gleap project. Use when you need to get tickets for a particular project by its ID.

Retrieves 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.

Tool to retrieve Chargebee billing information for a specific session. Use when you need to fetch subscription, payment, or billing details associated with a user session from Chargebee.

Retrieve 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.

Tool 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.

Tool to retrieve LemonSqueezy subscription and payment information for a specific session. Use when you need to fetch LemonSqueezy data associated with a user session.

Retrieve Shopify information associated with a user session in Gleap. Use this when you need to access e-commerce data from Shopify linked to a specific session.

Retrieves an answer to a question from the shared help center knowledge base. Use this when you need to find information from help center articles based on a user's question. The endpoint searches through configured help center sources and returns the most relevant answer. Returns null if no matching answer is found.

Tool 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.

Retrieve 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.

Tool 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.

Tool to retrieve raw statistics data from Gleap. Use when you need unprocessed, granular statistical data for custom analysis or reporting.

Tool to retrieve all survey responses for a specific survey. Use when you need to get all responses submitted for a survey.

Find tickets by session query parameters such as email, userId, phone, or custom data. Use this when you need to retrieve tickets associated with a specific user session or contact information.

Tool to get the total count of tickets in a Gleap project. Use when you need to know how many tickets exist without retrieving full ticket details.

Export 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.

Retrieve available fields for ticket export from Gleap. This action fetches metadata about which fields can be exported for tickets, useful for understanding what data is available before performing a ticket export.

Retrieves 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.

Retrieves 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.

Search 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.

Search for sessions in a project using the session search index. Use when you need to retrieve sessions for a specific project using the indexed search endpoint. This endpoint provides indexed session data including user information, activity timestamps, engagement metrics, and metadata for sessions within a specific project. The search is optimized through Gleap's session index for faster lookups.

Tool 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.

Tool 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.

Tool to create a new engagement news article in Gleap. Use when you need to publish announcements, product updates, or news content to users. Configure scheduling, targeting, and display frequency.

Tool 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.

Tool 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).

Tool 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').

Tool to create a new engagement tooltip in Gleap. Use when you want to add tooltips for user guidance, onboarding, or feature explanations.

Tool 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.

Tool 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.

Tool 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.

Create a new conversation with a session in Gleap. Use this action to initiate a conversation linked to a specific session ID within a project.

Tool to create a QA snippet (question-answer pair) in Gleap. Use when you need to add knowledge base content or FAQ entries to help AI assistants answer user questions.

Tool to create a tracker ticket in Gleap. Use when you need to create a new tracker-based ticket for tracking features, bugs, or tasks.

Tool 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).

Import 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.

Tool 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.

Tool 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.

Tool 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.

Track custom user events in Gleap for analytics and user behavior monitoring. Use this action to: - Record user actions like button clicks, page views, feature usage - Log business events like purchases, subscriptions, or conversions - Send batch events for efficiency (supports multiple events per request) - Track events with custom metadata for detailed analytics Note: Users must be identified first using the Identify User action before tracking events for them. Rate limit: 1000 requests per 60 seconds per project.

Tool 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.

Tool 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.

Tool to reassign all tickets to the authenticated user. Use when you need to bulk reassign tickets to yourself for handling or review.

Tool to resubscribe a session. Use when you need to re-enable notifications or tracking for a previously unsubscribed session.

Tool 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.

Tool to suggest a FAQ from a message. Use when you want to accept or reject a FAQ suggestion for a specific message.

Tool 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.

Tool to unarchive a ticket. Use when you need to restore a previously archived ticket after validation.

Tool to unlink a ticket. Use after confirming both tickets are linked to remove their association.

Tool to update an engagement checklist by its ID. Use to modify checklist properties such as name, description, status, items, and other configuration options.

Tool 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.

Tool to update an existing team. Use when you need to modify team properties like name, assignment method, or members. All fields except the team ID are required in the request body.

Tool to update a user’s role in a project. Use when you need to change a user's permissions.

Tool to update AI content by content ID. Use when modifying existing AI-powered content entries in Gleap.

Updates 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)

Tool to update an engagement banner. Use when modifying banner properties like name, status, targeting, or scheduling.

Tool to update an existing cobrowse product tour. Use when you need to modify properties like name, description, status, or configuration of an interactive guided tour.

Tool to update an existing engagement email. Use when you need to modify properties like name, subject, content, status, or targeting settings of an email campaign.

Tool to update an existing engagement modal. Use when you need to modify properties like name, status, format, or targeting configuration of a modal dialog.

Tool to update an engagement news article. Use when modifying news article properties like name, status, scheduling, targeting, or other attributes.

Tool to update an existing product tour. Use when you need to modify properties like name, status, configuration, or targeting of a product tour.

Tool to update an existing push notification. Use when you need to modify properties like title, message, status, targeting, or scheduling of a push notification.

Tool 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.

Tool to update an engagement tooltip. Use when modifying tooltip properties like name, active status, targeting, or frequency settings.

Tool to update an existing engagement WhatsApp message. Use when you need to modify properties like name, status, or targeting settings of a WhatsApp message campaign.

Tool 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.

Tool 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.

Tool 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.

Tool 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.

Updates an existing QA answer/snippet in Gleap. Use when you need to modify the question, answer, tags, or other properties of a snippet. Only the fields you provide will be updated; omitted fields remain unchanged.

Tool 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.

Tool to delete an engagement news article. Use when you need to remove a news article from the project by its news ID.

Tool 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.

Tool 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.

Tool to delete an engagement survey. Use when you need to remove a survey from the project by its survey ID.

Tool to delete an engagement tooltip. Use when you need to remove a tooltip from the project by its tooltip ID.

Tool 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.

Tool to delete a help center collection by ID. Use when you need to permanently remove a collection from the help center.

Tool to delete a help center redirect. Use when you need to remove a redirect from the help center by its redirect ID.

Tool to delete a message (comment) from a bug or ticket. Use when you need to permanently remove a comment from a bug/ticket conversation.

Tool to delete a message template. Use when you need to remove a message template from the project by its template ID.

Delete 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.

Tool to delete a session from a Gleap project. Use when you need to remove session data by providing both project ID and session ID.

Tool to delete a QA answer (snippet) from a Gleap project. Use when removing help center content or AI assistant snippets.

Tool to delete a session by ID. Use when you need to remove a specific session from the system.

Tool to delete a team by ID. Use when you need to permanently remove a team from the project.

Tool to delete a ticket by ID. Use when you need to permanently remove a ticket from the system.

Tool to unsubscribe one or more user sessions from communications. Use when users request to stop receiving messages or notifications.