Gleap

Tool to archive a ticket. Use after confirming the ticket ID and that the ticket is resolved. Call when moving tickets to history.

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

Tool to clone an existing engagement. Use when you need to duplicate an engagement with all its configuration.

Tool to create a help center collection. Use when adding a new organizational grouping in your Help Center.

Creates a new chat message in a Gleap chat session. Use this action to: - Send a message as a user or admin in an existing chat session - Reply to customer inquiries in the Gleap support system - Add

Create 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

Tool to create a new team. Use when you have team details ready and want to assign tickets among members.

Create 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 comprehe

Tool to create or update AI content in Gleap's knowledge base. Use when adding new documentation, help articles, or product information that AI assistants can reference. Supports text, file, and produ

Tool to create a new engagement banner in Gleap. Use when you want to add a banner for user engagement, announcements, or surveys. All fields are optional; the API will create a banner with default va

Tool to create a new engagement checklist. Use when you need to set up a step-by-step guide or task list for users.

Tool to create a new cobrowse product tour. Use when you need to set up an interactive guided tour for users to follow.

Tool 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

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

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 reques

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

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 (butt

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.

Removes 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

Tool to delete AI content by content ID. Use when you need to remove specific AI content from the system.

Tool to delete all AI content by batchId. Use when you need to remove all AI-generated content associated with a specific batch identifier.

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

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

Deletes 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. O

Tool to delete an engagement checklist by its ID. Use when removing a checklist from the project.

Tool to delete a cobrowse product tour by its ID. Use when you need to remove a cobrowse product tour from the project.

Tool to delete an engagement email by its ID. Use when you need to remove an email from the project's engagement emails list.

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

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 QA answer (snippet) from a Gleap project. Use when removing help center content or AI assistant snippets.

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

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

Tool 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

Tool 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

Tool to retrieve a specific engagement checklist by its ID. Use after obtaining a valid checklistId.

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

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

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

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

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 aut

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 se

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

Tool to retrieve all users for a project. Use when you need to list every user associated with the current 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.

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

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 f

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

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 s

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 o

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 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 all survey responses for a specific survey. Use when you need to get all responses submitted for a survey.

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 s

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 indiv

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,

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.

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 enga

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.

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

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 automat

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, an

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 c

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 notif

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

Retrieves all projects accessible to the authenticated user. Use when you need to list all projects the user has access to. Rate limit: 1000 requests per minute.

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.

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

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, activi

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

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

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

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 aft

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 thr

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 ti

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 em

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 ov

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 peri

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 acros

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,

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

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.

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 narro

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

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

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.

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

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 typ

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,

Identify or update a user's information in Gleap. Creates a new user if the userId doesn't exist, or updates the existing user's profile data. Use this to sync user information from your application t

Import 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

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

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

Tool to link a ticket. Use when you need to connect two existing tickets after confirming both IDs exist. Example: Link a duplicate issue ticket to its original.

Tool to mark all survey responses as read for a given survey. Use when you need to bulk-mark survey responses as read to clear unread indicators.

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 ticke

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 resol

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 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 fie

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; th

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.

Search for sessions in Gleap using various filter criteria. Use when you need to find sessions by user ID, email, name, or other session attributes. Supports filtering by multiple criteria including u

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

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.

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.

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 purchas

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 unsubscribe one or more user sessions from communications. Use when users request to stop receiving messages or notifications.

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

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

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 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; a

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 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 exc

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 th

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 I

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 notificati

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 re

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 excep

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

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.