Skip to main content
Gleap logo
  • Category: customer support
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 179
  • Triggers: 0
  • Slug: GLEAP
  • Version: 20261101_00

Tools

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

string
required
The ticket type to filter by. Common values include ‘bug’, ‘feature’, ‘feedback’, etc. Required to specify which ticket type to archive.
string
required
The ticket status to filter by. Common values include ‘open’, ‘closed’, ‘pending’, etc. Required to specify which status to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_ARCHIVE_A_TICKETTool to archive a ticket. Use after confirming the ticket ID and that the ticket is resolved. Call when moving tickets to history.

Input Parameters

string
required
Identifier of the ticket to archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_CLONE_ENGAGEMENTTool to clone an existing engagement. Use when you need to duplicate an engagement with all its configuration.

Input Parameters

string
required
The unique identifier (ObjectId) of the engagement to clone. Must be a valid engagement ID from the project’s engagements list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_CREATE_A_COLLECTIONTool to create a help center collection. Use when adding a new organizational grouping in your Help Center.

Input Parameters

integer
Numeric document ID this collection belongs to, if applicable
string
required
Title of the help center collection
string
Identifier of the parent collection for nesting
string
URL to an icon representing the collection
string
String used to order this collection among its peers
string
External identifier for syncing with other systems
string
Detailed description of the collection
string
Audience for this collection, defaults to ‘all’
object
Base filter criteria object to limit the audience
object
Additional filter criteria to extend the base audience

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("text" | "file" | "product")
required
Type of content being created. Must be one of: ‘text’ (text-based content), ‘file’ (file-based content), or ‘product’ (product information).
string
required
Title of the AI content (required)
string
Optional batch identifier for grouping multiple content items together. Useful for bulk operations.
object
required
Content object containing the actual content data. For text type, use {‘text’: ‘Your content here’}. Structure varies by content type.
string
required
Unique identifier for this content item. Use this ID to update existing content or create new content with a specific ID.
string
URL where users can access the full content or additional information.
string
Label text for the ‘read more’ link (e.g., ‘Learn More’, ‘View Full Article’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("user" | "admin")
required
Role of the message sender. Use “user” for customer messages or “admin” for support team responses.
string
required
Text content of the chat message. Supports unicode characters, emojis, newlines, and special characters.
string
required
Unique identifier of the chat session where the message will be created. Must be a valid session ID from the Gleap project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Service level agreement value or response time in hours
string
User’s preferred language code (ISO 639-1 format, e.g., ‘en’, ‘de’, ‘fr’)
string
User’s full name
string
User’s subscription plan or tier (e.g., ‘free’, ‘pro’, ‘enterprise’)
array
List of tags for categorizing and filtering sessions
string
User’s email address for session identification and communication
string
User’s phone number
number
Monetary or lifetime value associated with the user
string
URL or path to the user’s avatar image
string
Unique user identifier from your system. Used to track sessions across different devices and platforms
boolean
Whether the user is blocked from creating feedback or support tickets
string
Unique Gleap session identifier (auto-generated if not provided)
string
Project ID to associate the session with. If not provided, uses the project from authentication headers
string
Platform or operating system (e.g., ‘iOS’, ‘Android’, ‘Windows’, ‘macOS’)
number
Total number of sessions for this user
string
Unique identifier of the company the user belongs to
boolean
If true, indicates the user should only be contacted via email
string
Security hash for verifying user identity in secure mode
object
Custom metadata as key-value pairs for storing additional session-specific data (e.g., {‘app_version’: ‘2.0.1’, ‘platform’: ‘web’})
string
Type of device (e.g., ‘desktop’, ‘mobile’, ‘tablet’)
string
Name of the company the user belongs to
string
Organisation identifier the session belongs to
boolean
Whether the user has unsubscribed from communications

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the team to create
array
required
List of user IDs to include in the team
string ("random" | "balanced" | "manual" | "circular")
required
Method used to assign tickets within the team. ‘random’ assigns tickets randomly, ‘balanced’ distributes evenly across members, ‘manual’ requires manual assignment, and ‘circular’ rotates through members in order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Tags for categorizing and organizing tickets
string
Ticket type/category (e.g., ‘BUG’, ‘FEATURE_REQUEST’, ‘QUESTION’, ‘FEEDBACK’)
string
required
Ticket title (required)
string
Ticket status (e.g., ‘OPEN’, ‘IN_PROGRESS’, ‘RESOLVED’, ‘CLOSED’). Defaults to ‘OPEN’ if not specified
string
Due date for ticket resolution in ISO 8601 format (e.g., ‘2026-02-15T10:00:00Z’)
string
Priority level: ‘LOW’, ‘MEDIUM’, or ‘HIGH’. Helps prioritize ticket handling
string
User sentiment: ‘positive’, ‘negative’, or ‘neutral’. Helps gauge customer satisfaction
object
Custom metadata as key-value pairs (e.g., {‘browser’: ‘Chrome’, ‘version’: ‘120.0’})
array
List of file attachments with name, URL, and MIME type
string
Detailed description of the ticket issue or request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_CREATE_ENGAGEMENT_BANNERTool 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 values if no fields are specified (default name: ‘New survey’, status: ‘draft’, format: ‘widget’, frequency: ‘once’).

Input Parameters

string
Name of the banner. Defaults to ‘New survey’ if not specified
array
List of specific pages where the banner should appear
string
Display format for the banner. Defaults to ‘widget’ if not specified
string
Banner status: ‘draft’ or ‘active’. Defaults to ‘draft’ if not specified
object
Banner content configuration including text, images, buttons, etc.
string
Frequency at which the banner is shown: ‘once’, ‘always’, ‘daily’, etc. Defaults to ‘once’ if not specified
string
Type of page filtering to apply: ‘all’, ‘specific’, ‘exclude’, etc.
string
Target audience for the banner: ‘all’, ‘specific’, etc. Determines who can see the banner
object
Base filter criteria to limit the audience who sees this banner
object
Additional filter criteria to extend the base audience targeting

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_CREATE_ENGAGEMENT_CHECKLISTTool to create a new engagement checklist. Use when you need to set up a step-by-step guide or task list for users.

Input Parameters

string
required
Name of the checklist
array
List of steps to include in the checklist. Each step can have a title and optional description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_CREATE_ENGAGEMENT_COBROWSETool to create a new cobrowse product tour. Use when you need to set up an interactive guided tour for users to follow.

Input Parameters

string
required
Name of the cobrowse product tour

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Email body content (can include HTML)
string
required
Name of the engagement email
string
Type of engagement element. Defaults to ‘EMAIL’ if not specified
string
Display format for the email. Defaults to ‘widget’ if not specified
string
Email status: ‘draft’ or ‘active’. Defaults to ‘draft’ if not specified
string
required
Email subject line
string
Frequency at which the email is sent: ‘once’, ‘always’, ‘daily’, etc. Defaults to ‘once’ if not specified
string
Target audience for the email: ‘all’, ‘specific’, etc. Determines who receives the email. Defaults to ‘all’ if not specified

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the modal (required)
string
Type of engagement element (auto-populated as MODAL by the server)
boolean
Whether to play a sound when the modal appears
string
Display format for the modal. Defaults to ‘widget’ if not specified
boolean
Whether the modal is hidden from users
string
Modal status: ‘DRAFT’ or ‘ACTIVE’. Defaults to ‘DRAFT’ if not specified
string
Frequency at which the modal is shown: ‘once’, ‘always’, ‘daily’, etc. Defaults to ‘once’ if not specified
string
Type of frequency control: ‘dynamic’, ‘static’, etc. Defaults to ‘dynamic’ if not specified
string
Target audience for the modal: ‘all’, ‘specific’, etc. Determines who can see the modal. Defaults to ‘all’ if not specified

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the product tour (required)
string
Type of engagement element. Defaults to ‘TOUR’ if not specified
boolean
Whether the product tour is active. Defaults to false if not specified
string
Display format for the tour. Defaults to ‘widget’ if not specified
string
Status of the tour: ‘draft’ or ‘active’. Defaults to ‘draft’ if not specified
string
Frequency at which the tour is shown: ‘once’, ‘always’, ‘daily’, etc. Defaults to ‘once’ if not specified
string
Target audience for the tour: ‘all’, ‘specific’, etc. Determines who can see the tour. Defaults to ‘all’ if not specified

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name of the push notification. Defaults to ‘New survey’ if not specified
boolean
Whether the notification has been sent to users. Defaults to false if not specified
string
Type of engagement element. Defaults to ‘PUSH’ if not specified
boolean
Whether to play a notification sound. Defaults to true if not specified
string
Display format for the notification. Defaults to ‘widget’ if not specified
boolean
Whether the notification is hidden from users. Defaults to false if not specified
string
Notification status: ‘draft’ or ‘active’. Defaults to ‘draft’ if not specified
string
Frequency at which the notification is shown: ‘once’, ‘always’, ‘daily’, etc. Defaults to ‘once’ if not specified
boolean
Whether this is a new trigger for the notification
integer
Number of days for frequency calculation. Defaults to 0 if not specified
string
Type of frequency calculation: ‘dynamic’, ‘daily’, ‘weekly’, etc. Defaults to ‘dynamic’ if not specified
string
Type of page filtering to apply: ‘all’, ‘specific’, ‘exclude’, etc.
string
Target audience for the notification: ‘all’, ‘specific’, etc. Determines who receives the notification
string
ISO 8601 timestamp when to stop sending the notification (e.g., ‘2026-12-31T23:59:59Z’)
string
ISO 8601 timestamp when to start sending the notification (e.g., ‘2026-02-14T10:00:00Z’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_CREATE_ENGAGEMENT_TOOLTIPTool to create a new engagement tooltip in Gleap. Use when you want to add tooltips for user guidance, onboarding, or feature explanations.

Input Parameters

string
required
Name of the tooltip
string
required
Content/text of the tooltip

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The project ID where the feedback item will be created. This is a 24-character hexadecimal string.
array
Tags for categorizing and organizing feedback items
string
Type of feedback item (e.g., ‘BUG’, ‘FEATURE_REQUEST’, ‘QUESTION’, ‘FEEDBACK’)
string
required
The title/subject of the bug or feedback item (required)
string
Status of the feedback item (e.g., ‘OPEN’, ‘IN_PROGRESS’, ‘RESOLVED’, ‘CLOSED’)
string
Priority level: ‘LOW’, ‘MEDIUM’, or ‘HIGH’
object
Custom metadata as key-value pairs
string
required
Detailed description of the bug or feedback (required)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The new URL path to redirect to (e.g., ‘/new-help-article’)
string
required
The old URL path to redirect from (e.g., ‘/old-help-article’)
string ("exact" | "pattern")
required
Match type for the redirect: ‘exact’ for exact URL match or ‘pattern’ for pattern-based matching

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Title of the message template
array
List of user IDs who can access this message template. Only applicable if isPublic is false.
array
List of actions associated with the message template (e.g., buttons, links)
object
required
Content of the message template. Contains text and formatting data as a dictionary.
boolean
Whether the message template is publicly accessible. Defaults to false if not specified.
string
required
String used to order this template among its peers. Used for sorting and positioning.
array
List of file attachments for the message template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Session ID to associate with the conversation. Must be a valid session ID from the Gleap project.
string
required
Project ID where the conversation will be created. This is the unique identifier of the Gleap project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_CREATE_QA_SNIPPETTool 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.

Input Parameters

string
required
The answer text for the QA snippet
string
required
The question text for the QA snippet
string
required
The project ID to create the QA snippet in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_CREATE_TRACKER_TICKETTool to create a tracker ticket in Gleap. Use when you need to create a new tracker-based ticket for tracking features, bugs, or tasks.

Input Parameters

string
Type classification of the tracker ticket (e.g., ‘bug’, ‘feature’, ‘task’)
string
Title of the tracker ticket
string
Detailed description of the tracker ticket
array
Array of ticket IDs to link to this tracker ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_AI_CONTENTTool to delete AI content by content ID. Use when you need to remove specific AI content from the system.

Input Parameters

string
required
The unique identifier of the AI content to delete. This is the content ID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique batch identifier of the AI content to delete. All AI content items associated with this batch will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ObjectId) of the user to remove from the project. Must be a valid user ID from the project’s user list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_BUGSTool to delete a bug/ticket by ID. Use when you need to permanently remove a bug from the system.

Input Parameters

string
required
The unique identifier of the bug/ticket to delete. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_ENGAGEMENT_BANNERTool to delete an engagement banner. Use when you need to remove a banner from the project by its banner ID.

Input Parameters

string
required
The unique identifier (ObjectId) of the banner to delete. Must be a valid banner ID from the project’s engagement banners list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (MongoDB ObjectId) of the chat message to delete. Must be a valid 24-character hex string representing an existing message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_ENGAGEMENT_CHECKLISTTool to delete an engagement checklist by its ID. Use when removing a checklist from the project.

Input Parameters

string
required
Unique identifier of the checklist to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the cobrowse product tour to delete. Must be a valid ObjectId (24-character hexadecimal string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ObjectId) of the engagement email to delete. Must be a valid email ID from the project’s engagement emails list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_ENGAGEMENT_MODALTool to delete an engagement modal from a Gleap project. Use when you need to remove a modal by its ID.

Input Parameters

string
required
The unique identifier of the engagement modal to delete. Must be a valid modal ID (24-character hexadecimal ObjectId).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ObjectId) of the news article to delete. Must be a valid news ID from the project’s engagement news list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ObjectId) of the product tour to delete. Must be a valid product tour ID from the project’s engagement product tours list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ObjectId) of the push notification to delete. Must be a valid push notification ID from the project’s engagement push notifications list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_ENGAGEMENT_SURVEYSTool to delete an engagement survey. Use when you need to remove a survey from the project by its survey ID.

Input Parameters

string
required
The unique identifier of the survey to delete. Must be a valid survey ID from the engagement surveys list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ObjectId) of the tooltip to delete. Must be a valid tooltip ID from the project’s engagement tooltips list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ObjectId) of the WhatsApp message to delete. Must be a valid WhatsApp message ID from the project’s engagement WhatsApp messages list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_HELPCENTER_COLLECTIONTool to delete a help center collection by ID. Use when you need to permanently remove a collection from the help center.

Input Parameters

string
required
The unique identifier of the help center collection to delete. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_HELPCENTER_REDIRECTTool to delete a help center redirect. Use when you need to remove a redirect from the help center by its redirect ID.

Input Parameters

string
required
The unique identifier of the help center redirect to delete. Must be a valid 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_MESSAGETool to delete a message (comment) from a bug or ticket. Use when you need to permanently remove a comment from a bug/ticket conversation.

Input Parameters

string
required
The unique identifier of the message/comment to delete. Must be a valid 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ObjectId) of the message template to delete. Must be a valid message template ID from the project’s message templates list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional type filter to specify which type of AI content batches to delete.
string
required
The unique identifier of the current batch to keep. All other AI content batches will be deleted except this one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the project containing the QA answer/snippet. This is provided in the API authentication headers.
string
required
The unique identifier of the QA answer/snippet to delete. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the project containing the session to delete. Must be a valid project ID.
string
required
The unique identifier of the session to delete from the project. Must be a valid session ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_SESSIONSTool to delete a session by ID. Use when you need to remove a specific session from the system.

Input Parameters

string
required
The unique identifier of the session to delete. Must be a valid session ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_TEAMTool to delete a team by ID. Use when you need to permanently remove a team from the project.

Input Parameters

string
required
The unique identifier of the team to delete. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_DELETE_TICKETTool to delete a ticket by ID. Use when you need to permanently remove a ticket from the system.

Input Parameters

string
required
The unique identifier of the ticket to delete. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of sessions to skip for pagination.
integer
Maximum number of sessions to export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination
integer
Maximum number of records to return
string
End date for filtering statistics (ISO 8601 format)
string
Type of aggregation to apply to the statistics
string
Timezone for date calculations (e.g., ‘America/New_York’, ‘Europe/London’, ‘UTC’)
string ("AVERAGE_RATING_PER_USER_RESULT_LIST" | "TEAM_PERFORMANCE_LIST" | "ARTICLE_SEARCH_RESULT_LIST" | "ARTICLE_SEARCH_WITH_NO_RESULT_LIST" | "ARTICLE_VIEW_STATISTICS_LIST" | "TICKETS_WITH_RATING_LIST" | "LIVE_AGENTS_TEAM" | "SNAPSHOT_TICKETS" | "LATEST_NEGATIVE_AI_FEEDBACK" | "SLA_REPORTS_LIST")
required
Type of statistics list data to export (e.g., TEAM_PERFORMANCE_LIST, ARTICLE_VIEW_STATISTICS_LIST)
string
Filter by creation date (ISO 8601 format)
string
Field to group results by
string
Start date for filtering statistics (ISO 8601 format)
string
Filter by last update date (ISO 8601 format)
string ("day" | "month" | "year")
Time grouping interval for statistics.
boolean
Whether to use working hours for time calculations (excludes weekends/holidays)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ID) of the ticket to generate a draft reply for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional type parameter for the generation process. Specifies the type of data to generate.
string
required
The unique identifier of the source ticket to generate data from. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_A_CHECKLIST_ACTIONTool to retrieve a specific engagement checklist by its ID. Use after obtaining a valid checklistId.

Input Parameters

string
required
Unique identifier of the checklist to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_A_COLLECTIONTool to retrieve a help center collection by ID. Use when you need to fetch specific collection details by its ID.

Input Parameters

string
required
ID of the help center collection to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_AI_CONTENTTool 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.

Input Parameters

string
required
The unique identifier of the AI content to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ALL_ARTICLESTool 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.

Input Parameters

integer
Number of articles to skip for pagination.
integer
Maximum number of articles to return.
string
required
ID of the help center collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of chat messages to skip for pagination.
integer
Maximum number of chat messages to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ALL_INVITATIONS_FOR_A_PROJECTRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of sessions to skip for pagination.
integer
Maximum number of sessions to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ALL_TEAMSTool to retrieve all teams. Use when you need a list of all teams for the authenticated project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of tickets to skip for pagination. Use skip=(page-1)*limit for page-based pagination.
string
Sort order for results. Examples: ‘-createdAt’ (newest first), ‘createdAt’ (oldest first), ‘priority’, ‘-priority’, ‘-updatedAt’.
string
Filter by ticket type. Examples: ‘BUG’, ‘FEATURE_REQUEST’. Can specify multiple comma-separated: ‘BUG,FEATURE_REQUEST’.
integer
Maximum number of tickets to return. Default varies by API, maximum is 1000.
boolean
Filter by spam classification. Set to false to exclude spam tickets.
string
Filter by ticket status. Examples: ‘OPEN’, ‘DONE’, ‘INPROGRESS’. Can specify multiple comma-separated: ‘OPEN,DONE’.
boolean
Filter by archived state. Set to false to exclude archived tickets.
string
Filter by priority level. Examples: ‘HIGH’, ‘MEDIUM’, ‘LOW’. Can specify multiple comma-separated: ‘HIGH,MEDIUM’.
boolean
Set to true to ignore archived tickets regardless of archived filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ALL_USERS_FOR_A_PROJECTTool to retrieve all users for a project. Use when you need to list every user associated with the current project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ID) of the ticket to retrieve. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the engagement to retrieve activities count for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_BANNERTool 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.

Input Parameters

string
required
The unique identifier of the engagement banner to retrieve. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_BANNERSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the chat message to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_CHECKLISTSRetrieve a project’s engagement checklists to get an overview of available checklists for onboarding or feature adoption.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the cobrowse product tour to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the engagement email to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_EMAILSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the engagement modal to retrieve. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_MODALSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_NEWSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the engagement news article to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_PRODUCT_TOURTool 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.

Input Parameters

string
required
Unique identifier of the product tour to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_PRODUCT_TOURSTool to retrieve all engagement product tours for a project. Use when you need to get an overview of all available product tours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the push notification to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_PUSH_NOTIFICATIONSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the engagement to retrieve activities for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 content

Input Parameters

string
required
The unique identifier of the engagement to retrieve recipients for. This is a 24-character hexadecimal string (MongoDB ObjectId).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the engagement to retrieve statistics for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the survey to retrieve. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_SURVEYSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_SURVEYS_RESPONSESTool to retrieve all survey responses for a specific survey. Use when you need to get all responses submitted for a survey.

Input Parameters

string
required
The unique identifier of the survey to retrieve responses for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the survey to retrieve response samples for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the survey to summarize responses for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the tooltip to retrieve. Must be a valid tooltip ID from the project’s engagement tooltips list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_ENGAGEMENT_TOOLTIPSTool to retrieve all engagement tooltips for the authenticated project. Use when you need to get a list of all configured tooltips.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the WhatsApp message to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_HELP_CENTER_SOURCESRetrieve Gleap help center sources to discover available knowledge base content before querying articles or answering questions. Source information can include IDs, titles, URLs, and metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_INVITATIONSRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ID) of the message template to retrieve. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_MESSAGE_TEMPLATESList message templates for the authenticated project, with an optional search term and result limit.

Input Parameters

integer
Maximum number of message templates to return. Use for pagination.
string
Search term to filter message templates by title or content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The share token from a Gleap ticket notification. This token allows public access to view ticket details without authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the project to retrieve. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_PROJECTSRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The project ID to retrieve archived bugs for (MongoDB ObjectId format, 24-character hexadecimal string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_PROJECTS_HELPCENTER_COLLECTIONSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_PROJECTS_SESSIONSTool 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.

Input Parameters

string
required
The project ID to retrieve sessions for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_PROJECTS_TICKETSTool to retrieve all tickets from a specific Gleap project. Use when you need to get tickets for a particular project by its ID.

Input Parameters

string
required
The project ID to retrieve tickets from. This is a MongoDB ObjectId format string (24-character hexadecimal).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_PROJECTS_USERSTool to get project users by project ID. Use when you need to list all users associated with a specific project.

Input Parameters

string
required
The project ID (MongoDB ObjectId format, 24-character hexadecimal string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the session to retrieve. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the session to retrieve activities for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_SESSION_CHARGEBEE_INFOTool 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.

Input Parameters

string
required
The unique identifier of the session. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique MongoDB ObjectId of the session (24-character hexadecimal string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the session to retrieve events for. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_SESSION_LEMON_SQUEEZY_INFOTool to retrieve LemonSqueezy subscription and payment information for a specific session. Use when you need to fetch LemonSqueezy data associated with a user session.

Input Parameters

string
required
The unique identifier of the session. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_SESSION_SHOPIFY_INFORetrieve 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.

Input Parameters

string
required
The unique MongoDB ObjectId of the session (24-character hexadecimal string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_SHARED_HELPCENTER_ANSWERRetrieves 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.

Input Parameters

string
required
The question to answer from the help center. This should be a clear, specific question that can be matched against help center articles and documentation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination. Use with limit to paginate through results.
integer
Maximum number of records to return. Use with skip for pagination.
string
End date for filtering statistics (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’). Only statistics up to this date will be included.
string
Type of aggregation to perform on the statistics data.
string
Timezone for date calculations (e.g., ‘America/New_York’, ‘Europe/London’, ‘UTC’). Used to properly calculate date-based statistics in the specified timezone.
string
Filter by creation timestamp (ISO 8601 format).
string
Field to group statistics by. Allows grouping data by specific dimensions.
string
Start date for filtering statistics (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’). Only statistics from this date onwards will be included.
string
Filter by last update timestamp (ISO 8601 format).
string ("day" | "month" | "year")
Group interval for statistics aggregation.
string
Filter statistics by specific email server key. Use to get bounce statistics for a particular email server configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination. Use with limit for paginated results.
integer
Maximum number of records to return. Use with skip for pagination.
string
End date for filtering statistics in ISO 8601 format (e.g., ‘2024-12-31T23:59:59.999Z’). Highly recommended to provide this parameter.
string
Type of aggregation to apply to the statistics (e.g., ‘sum’, ‘avg’, ‘count’).
string
Timezone for date calculations (e.g., ‘America/New_York’, ‘Europe/London’, ‘UTC’).
string
Filter by creation date in ISO 8601 format.
string
Field to group statistics by (e.g., ‘emailClient’, ‘browser’).
string
Start date for filtering statistics in ISO 8601 format (e.g., ‘2024-01-01T00:00:00.000Z’). Highly recommended to provide this parameter.
string
Filter by last update date in ISO 8601 format.
string ("day" | "month" | "year")
Time interval for grouping statistics data.
string
Filter statistics by specific email server key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination. Use skip=(page-1)*limit for page-based pagination.
integer
Maximum number of records to return. Use together with skip for pagination.
string
End date for filtering statistics in ISO 8601 format (e.g., ‘2024-12-31T23:59:59.999Z’). Only statistics up to this date will be included.
string
Aggregation type for the statistics. Defines how data should be aggregated across the specified grouping.
string
Timezone for date calculations (e.g., ‘America/New_York’, ‘Europe/London’). If not specified, uses server default timezone.
string
Filter by creation timestamp in ISO 8601 format. Used to filter records based on when they were created.
string
Field to group the statistics by. Can be used to aggregate data by specific dimensions.
string
Start date for filtering statistics in ISO 8601 format (e.g., ‘2024-01-01T00:00:00.000Z’). Only statistics from this date onwards will be included.
string
Filter by last update timestamp in ISO 8601 format. Used to filter records based on when they were last modified.
string ("day" | "month" | "year")
Time interval for grouping statistics data.
string
Specific email server key to filter statistics for a particular email server configuration. Use to get statistics for a specific email integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination. Use with limit for paginated results.
integer
Maximum number of records to return. Use with skip for pagination.
string
End date for filtering statistics data. Use ISO 8601 format (YYYY-MM-DD or full timestamp). Only data up to this date will be included.
string
Aggregation type for calculations. Supported values: ‘MEDIAN’ or ‘AVERAGE’. Determines how metrics are calculated across time periods.
string
Timezone for date calculations. Use standard timezone identifiers like ‘America/New_York’ or ‘Europe/London’. Affects how date ranges are interpreted.
string ("MEDIAN_FIRST_RESPONSE_TIME" | "MEDIAN_TIME_TO_CLOSE" | "TICKET_CLOSE_COUNT" | "MEDIAN_CONVERSATION_RATING" | "TICKET_MEDIAN_REPLY_TIME" | "MEDIAN_FIRST_ASSIGNMENT_TIME" | "NEW_TICKETS_COUNT" | "TICKET_COUNT_BY_QUERY" | "TICKET_REPLIES_COUNT" | "TICKET_WORKED_ON_COUNT" | "TICKETS_WITH_OTHER_STATUS_THEN_OPEN_OR_CLOSED_COUNT" | "HELP_CENTER_ARTICLE_VIEW_COUNT" | "NEWS_VIEW_COUNT" | "KAI_ANSWERED_COUNT" | "KAI_NO_ANSWER_COUNT" | "KAI_ROUTED_TO_AGENT_RATE_COUNT" | "KAI_DEFLECTION_RATE" | "KAI_DEFLECTION_RATE_UNIQUE_USERS" | "KAI_ROUTED_TO_AGENT_RATE_UNIQUE_USERS" | "KAI_ROUTED_TO_AGENT_RATE" | "KAI_POSITIVE_FEEDBACK_RATE" | "KAI_NEGATIVE_FEEDBACK_RATE" | "KAI_POSITIVE_FEEDBACK_PERCENTAGE" | "SNAPSHOT_AGENTS_ONLINE_COUNT" | "SNAPSHOT_OPEN_TICKETS" | "MESSAGE_COUNT" | "AI_QUESTIONS_ASKED_COUNT" | "SLA_BREACHES_COUNT" | "SLA_COMPLIANCE" | "SLA_NOT_COMPLIANCE" | "SLA_NO_BREACHES_COUNT" | "TICKETS_WITHOUT_COMMENTS_RATE" | "KAI_DEFLECTION_COUNT" | "KAI_ROUTED_TO_AGENT_COUNT")
required
Type of fact data to retrieve. Determines what statistics are returned (e.g., NEW_TICKETS_COUNT for new ticket statistics, MEDIAN_TIME_TO_CLOSE for time-to-close metrics).
string
Filter by creation timestamp. Format and usage may vary based on API requirements.
string
Field to group statistics by. Allows segmentation of data by specific attributes.
string
Start date for filtering statistics data. Use ISO 8601 format (YYYY-MM-DD or full timestamp). Only data from this date onwards will be included.
string
Filter by update timestamp. Format and usage may vary based on API requirements.
string ("day" | "month" | "year")
Enumeration of time grouping intervals for statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination. Use skip=(page-1)*limit for page-based pagination.
integer
Maximum number of records to return. Use with skip for pagination.
string
End date for filtering data (ISO 8601 format, e.g., ‘2024-12-31T23:59:59Z’). Only data up to this date is included.
string
Aggregation type for data calculation. Determines how data points are combined.
string
Timezone for date calculations (e.g., ‘America/New_York’, ‘Europe/London’, ‘UTC’). Affects how timestamps are interpreted.
string ("BUSIEST_HOURS_PER_WEEKDAY" | "BUSIEST_COMMENTS_PER_WEEKDAY")
required
Type of heatmap data to retrieve. BUSIEST_HOURS_PER_WEEKDAY shows activity patterns across hours and weekdays. BUSIEST_COMMENTS_PER_WEEKDAY shows comment activity patterns. Required.
string
Filter by creation timestamp. Can be used for precise timestamp filtering.
string
Field to group results by. Allows additional data segmentation beyond the chart type.
string
Start date for filtering data (ISO 8601 format, e.g., ‘2024-01-01T00:00:00Z’). Only data from this date onwards is included.
string
Filter by last update timestamp. Can be used to find recently modified data.
string ("day" | "month" | "year")
Time interval for grouping data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination
integer
Maximum number of records to return
string
End date for filtering statistics (ISO 8601 format)
string
Type of aggregation to apply to the statistics
string
Timezone for date calculations (e.g., ‘America/New_York’, ‘Europe/London’, ‘UTC’)
string ("AVERAGE_RATING_PER_USER_RESULT_LIST" | "TEAM_PERFORMANCE_LIST" | "ARTICLE_SEARCH_RESULT_LIST" | "ARTICLE_SEARCH_WITH_NO_RESULT_LIST" | "ARTICLE_VIEW_STATISTICS_LIST" | "TICKETS_WITH_RATING_LIST" | "LIVE_AGENTS_TEAM" | "SNAPSHOT_TICKETS" | "LATEST_NEGATIVE_AI_FEEDBACK" | "SLA_REPORTS_LIST")
required
Type of statistics list data to retrieve (e.g., TEAM_PERFORMANCE_LIST, ARTICLE_VIEW_STATISTICS_LIST)
string
Filter by creation date (ISO 8601 format)
string
Field to group results by
string
Start date for filtering statistics (ISO 8601 format)
string
Filter by last update date (ISO 8601 format)
string ("day" | "month" | "year")
Time grouping interval for statistics.
boolean
Whether to use working hours for time calculations (excludes weekends/holidays)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of records to skip for pagination. Use with limit for paginated results.
string
Type of raw data to retrieve. Specifies the category or kind of statistics data to fetch.
integer
Maximum number of records to return. Use with skip for pagination.
string
End date for filtering raw statistics data. Use ISO 8601 format (YYYY-MM-DD or full timestamp). Only data up to this date will be included.
string
Aggregation type for calculations. Determines how metrics are calculated across time periods or groups.
string
Timezone for date calculations. Use standard timezone identifiers like ‘America/New_York’, ‘Europe/London’, or ‘UTC’. Affects how date ranges and timestamps are interpreted.
string
Filter by creation timestamp. Format and usage may vary based on API requirements.
string
Field to group statistics by. Allows segmentation of raw data by specific attributes or dimensions.
string
Start date for filtering raw statistics data. Use ISO 8601 format (YYYY-MM-DD or full timestamp). Only data from this date onwards will be included.
string
Filter by update timestamp. Format and usage may vary based on API requirements.
string ("day" | "month" | "year")
Time grouping interval for statistics data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of tickets to skip for pagination. Use skip=(page-1)*limit for page-based pagination.
string
Email address to search for tickets. Finds tickets associated with sessions that have this email.
integer
Maximum number of tickets to return. Maximum is 1000.
string
Phone number to search for tickets. Finds tickets associated with sessions that have this phone number.
string
User ID to search for tickets. Finds tickets associated with sessions that have this user ID.
string
Custom data TIN field to search for tickets. Finds tickets associated with sessions that have this TIN in custom data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of tickets to skip for pagination.
string
Sort order for exported tickets. Examples: ‘-createdAt’ (newest first), ‘createdAt’ (oldest first), ‘priority’, ‘-priority’, ‘-updatedAt’.
string
Filter exported tickets by type. Examples: ‘BUG’, ‘FEATURE_REQUEST’. Can specify multiple comma-separated: ‘BUG,FEATURE_REQUEST’.
integer
Maximum number of tickets to export. Default varies by API.
boolean
Filter by spam classification. Set to false to exclude spam tickets from export.
string
Filter exported tickets by status. Examples: ‘OPEN’, ‘DONE’, ‘INPROGRESS’. Can specify multiple comma-separated: ‘OPEN,DONE’.
boolean
Filter by archived state. Set to false to exclude archived tickets from export.
string
Filter exported tickets by priority level. Examples: ‘HIGH’, ‘MEDIUM’, ‘LOW’. Can specify multiple comma-separated: ‘HIGH,MEDIUM’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_TICKETS_EXPORT_FIELDSRetrieve 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.

Input Parameters

string
Filter by export type. Optional parameter to specify the type of export fields to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The search term to query tickets. This will search across ticket titles, descriptions, and other relevant fields. Required parameter for ticket search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_TICKETS_TICKETSCOUNTRetrieve ticket count details for a Gleap project without fetching full tickets. When the API response contains nested count details, the tool returns those details rather than a computed total.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_GET_USERS_ME_PERMISSIONSTool to retrieve the current user’s role permissions. Use when you need to check what permissions the authenticated user has.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Starts at 1. Use this to navigate through multiple pages of tickets.
string
Filter tickets by type. Common values include ‘BUG’, ‘FEATURE_REQUEST’, ‘FEEDBACK’, ‘QUESTION’, ‘CRASH’. Leave empty to fetch all ticket types.
integer
Number of tickets to return per page. Maximum 100. Use this to control the number of results returned.
string
Filter tickets by specific project ID. Use this to view tickets from a particular project only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ID) of the unified inbox ticket to retrieve. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
User’s full name.
string
User’s email address.
string
User’s phone number.
number
Monetary or lifetime value associated with the user.
string
required
Unique identifier of the user. This will create a new user if the ID doesn’t exist, or update an existing user’s information.
string
Explicit user creation timestamp (ISO 8601).
boolean
If true, prevents updating the user’s last activity timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of session objects to import. Must contain at least one session. Each session represents a user and their associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Intercom API access token for authentication. This key must have read permissions for contacts in your Intercom workspace.
string
required
Intercom API endpoint URL to fetch contacts from. Typically ‘https://api.intercom.io/contacts’ for retrieving contact data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether the user is currently typing. Set to true to indicate typing is in progress, false to indicate typing has stopped.
string
required
The unique identifier (ID) of the ticket. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether the user is currently viewing the ticket. Set to true to indicate the user is viewing the ticket, false to indicate the user has stopped viewing.
string
required
The unique identifier (ID) of the ticket. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_MARK_SURVEY_RESPONSES_READTool 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.

Input Parameters

string
required
Unique identifier of the survey whose responses should be marked as read

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The ID of the target ticket to merge into (required if shouldCreateNewTicket is false). This is the ticket that will contain all merged data. Must be a 24-character hexadecimal string.
boolean
required
Whether to merge tasks from all tickets. Set to true to combine tasks from the merged tickets, or false to keep only the target ticket’s tasks.
array
required
Array of ticket IDs to merge into the target ticket. These tickets will be merged and their data combined into the target ticket. Each ID is a 24-character hexadecimal string.
boolean
required
Whether to merge contact information from all tickets. Set to true to combine contacts from the merged tickets, or false to keep only the target ticket’s contacts.
boolean
required
Whether to create a new ticket as the merge target. Set to true to create a new ticket for the merged data, or false to merge into an existing targetTicketId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the bug/ticket to add a comment to. This is a 24-character hexadecimal string.
string
required
The text content of the comment message to post on the bug/ticket. Supports unicode characters, emojis, and special characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_POST_ENGAGEMENT_NEWSCreate an engagement news article in Gleap with scheduling, audience, and display-frequency settings.

Input Parameters

string
required
Name/title of the news article
boolean
required
Whether the news article has been sent/published to users
string
required
Type of engagement item, typically ‘news’ for news articles
boolean
required
Whether to play a notification sound when displaying the news article
string
required
Display format for the news article (e.g., ‘standard’, ‘widget’, ‘modal’)
boolean
required
Whether the news article is hidden from users. Set to true to hide, false to show
string
required
Publication status: ‘draft’ or ‘active’. Use ‘draft’ for unpublished articles, ‘active’ for published
string
required
ISO 8601 timestamp when the article was created (e.g., ‘2026-02-14T10:00:00Z’)
string
required
Frequency at which the news article is shown: ‘once’, ‘always’, ‘daily’, etc.
string
required
ISO 8601 timestamp when the article was last updated (e.g., ‘2026-02-14T10:00:00Z’)
boolean
required
Whether this is a new trigger for the news article
integer
required
Number of days for frequency calculation (e.g., 0 for immediate, 7 for weekly)
string
required
Type of frequency calculation: ‘daily’, ‘weekly’, ‘monthly’, etc.
string ("is" | "contains" | "isnot" | "notcontains" | "startswith" | "endswith" | "empty" | "notempty")
required
Type of page filtering to apply: ‘is’ for exact match, ‘contains’ for partial match, ‘isnot’ for exclusion, etc.
string
required
Target audience for the news article: ‘all’ for everyone, ‘specific’ for filtered audience
string
required
ISO 8601 timestamp when to stop sending/displaying the news article (e.g., ‘2026-12-31T23:59:59Z’)
string
required
ISO 8601 timestamp when to start sending/displaying the news article (e.g., ‘2026-02-14T10:00:00Z’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the survey (required)
string
Description of the survey

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name of the WhatsApp message. Defaults to ‘New whatsapp message’ if not specified
boolean
Whether the message has been sent to users. Defaults to false if not specified
string
Type of engagement element. Defaults to ‘WHATSAPP’ if not specified
boolean
Whether to play a notification sound. Defaults to true if not specified
string
Display format for the message. Defaults to ‘widget’ if not specified
boolean
Whether the message is hidden from users. Defaults to false if not specified
string
Message status: ‘draft’ or ‘active’. Defaults to ‘draft’ if not specified
string
Frequency at which the message is shown: ‘once’, ‘always’, ‘daily’, etc. Defaults to ‘once’ if not specified
boolean
Whether this is a new trigger for the message
integer
Number of days for frequency calculation. Defaults to 0 if not specified
string
Type of frequency calculation: ‘dynamic’, ‘daily’, ‘weekly’, etc. Defaults to ‘dynamic’ if not specified
string
Type of page filtering to apply: ‘all’, ‘specific’, ‘exclude’, etc.
string
Target audience for the message: ‘all’, ‘specific’, etc. Determines who receives the message
string
ISO 8601 timestamp when to stop sending the message (e.g., ‘2026-12-31T23:59:59Z’)
string
ISO 8601 timestamp when to start sending the message (e.g., ‘2026-02-14T10:00:00Z’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_REASSIGN_ALL_TICKETS_TO_USERTool to reassign all tickets to the authenticated user. Use when you need to bulk reassign tickets to yourself for handling or review.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_RESUBSCRIBE_A_SESSIONTool to resubscribe a session. Use when you need to re-enable notifications or tracking for a previously unsubscribed session.

Input Parameters

string
required
Identifier of the session to resubscribe

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter sessions by language code (e.g., ‘en’, ‘de’, ‘fr’). Use to find sessions in a specific language.
string
Filter sessions by user name. Searches for sessions where the user’s name matches this value.
string
Filter sessions by user email address. Use to find sessions associated with a specific email.
string
Filter sessions by user ID. Use to find all sessions for a specific user.
boolean
Filter sessions by blocked status. Set to true to find blocked users, false for non-blocked users.
string
Filter by unique Gleap session identifier. Use to find a specific session by its Gleap ID.
string
Filter by Gleap session hash. Use to find sessions by their hash value.
boolean
Filter sessions by unsubscribed status. Set to true to find unsubscribed users, false for subscribed users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The search term to query messages. Required parameter for filtering messages by content or metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the project to search sessions in. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Language code for the email preview (e.g., ‘en’, ‘de’, ‘fr’). If not specified, uses the default language
array
required
List of email addresses to send the preview to. Must contain at least one valid email address
string
required
Unique identifier of the engagement email to preview. Must be a valid 24-character MongoDB ObjectId (hexadecimal string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of email addresses to send the ticket conversation transcript to. Each email must be a valid email address.
string
required
The unique identifier (ID) of the ticket whose transcript should be sent. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
required
Duration in seconds to snooze the ticket. After this time, the ticket will be automatically unsnoozed.
string
required
Identifier of the ticket to snooze

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether to accept the FAQ suggestion. Set to true to accept the FAQ suggestion or false to reject it.
string
required
Unique identifier of the message to suggest a FAQ for. Must be a valid message ID from the Gleap project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether to unpublish the collection. Set to true to unpublish (hide) the collection, or false to publish (show) it
string
required
Unique identifier of the help center collection to toggle publish status

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of event objects to track. Must contain at least one event. Use this to batch multiple events in a single API call for efficiency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UNARCHIVE_A_TICKETTool to unarchive a ticket. Use when you need to restore a previously archived ticket after validation.

Input Parameters

string
required
Identifier of the ticket to unarchive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UNSUBSCRIBE_SESSIONSTool to unsubscribe one or more user sessions from communications. Use when users request to stop receiving messages or notifications.

Input Parameters

string
Optional reason for unsubscribing the sessions. Helps track why users were unsubscribed.
array
required
List of sessions to unsubscribe. Each session must include either an email or userId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_AI_CONTENT_BY_CONTENT_IDTool to update AI content by content ID. Use when modifying existing AI-powered content entries in Gleap.

Input Parameters

string
required
Type of the AI content (e.g., ‘text’, ‘html’, ‘markdown’)
string
required
Title of the AI content
string
Batch identifier for grouping multiple AI content updates together
string
required
Content body for AI processing
string
required
ID of the AI content to update
string
URL for additional information related to this AI content
string
Label text for the ‘read more’ link

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the team
string
required
The unique identifier (ID) of the team to update. This is a 24-character hexadecimal string (MongoDB ObjectId format).
array
required
List of user IDs to include in the team
number
Maximum number of tickets when limit_ticket_amount is enabled
boolean
Whether the ticket queue needs to be rerun after this update
string ("random" | "balanced" | "manual" | "circular")
required
Method used to assign tickets within the team. ‘random’ assigns tickets randomly, ‘balanced’ distributes evenly across members, ‘manual’ requires manual assignment, and ‘circular’ rotates through members in order
boolean
Whether to limit the number of tickets that can be assigned to this team
boolean
Whether to only consider online members for ticket assignments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (ID) of the ticket to update. This is a 24-character hexadecimal string.
array
Array of tag strings for categorizing and organizing tickets. Updates the ticket tags.
string
Type of ticket (e.g., BUG, INQUIRY, FEATURE_REQUEST, CRASH). Updates the ticket type.
string
Status of the ticket (e.g., OPEN, INPROGRESS, TOTEST, DONE). Updates the current status of the ticket.
string
Due date for ticket resolution in ISO 8601 format (e.g., ‘2026-02-15T10:00:00Z’). Updates the due date.
boolean
Whether the ticket is snoozed. Set to true to snooze or false to unsnooze.
boolean
Whether the ticket is archived. Set to true to archive or false to unarchive.
string
Lexorank position for ticket ordering. Used for custom sorting in kanban boards.
string
Outbound reference or identifier. Updates the outbound field.
string
Priority level: ‘LOW’, ‘MEDIUM’, or ‘HIGH’. Updates the priority of the ticket.
string
Detailed description of the ticket/bug. Updates the description text.
string
ID of the ticket this is a duplicate of. Updates the duplicate reference.
string
URL to a screenshot associated with the ticket. Updates the screenshot URL.
string
User ID assigned to process the ticket. Updates the assigned user.
string
Date when the screenshot broke in ISO 8601 format. Updates the screenshot broke date.
boolean
Whether there are unread notifications for this ticket. Updates the notification status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_A_USER_FOR_A_PROJECTTool to update a user’s role in a project. Use when you need to change a user’s permissions.

Input Parameters

string
required
The new role to assign to the user (e.g., ‘admin’, ‘member’)
string
required
The unique identifier of the user to update in the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
JSON object containing the fields to update. Common fields include: - content (str): The message text content - status (str): Message status (e.g., ‘draft’, ‘active’) - hidden (bool): Whether the message is hidden - sound (bool): Whether to play sound - name (str): Display name/title for the message Example: {‘content’: ‘Updated message’, ‘status’: ‘active’}
string
required
The unique MongoDB ObjectId of the chat message to update (24-character hex string)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_CHECKLISTTool to update an engagement checklist by its ID. Use to modify checklist properties such as name, description, status, items, and other configuration options.

Input Parameters

string
Name of the checklist
array
Checklist items
boolean
Whether sound is enabled
array
Steps in the checklist
string
Title of the checklist
string
Format of the checklist (e.g., ‘widget’)
boolean
Whether the checklist is hidden
string
Status of the checklist (e.g., ‘draft’, ‘active’)
string
Frequency of the checklist
string
required
Unique identifier of the checklist to update
string
Description of the checklist
string
Target audience for the checklist

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_ENGAGEMENT_BANNERTool to update an engagement banner. Use when modifying banner properties like name, status, targeting, or scheduling.

Input Parameters

string
Name of the banner
string
Type of engagement (e.g., BANNER)
boolean
Whether sound is enabled
string
Display format (e.g., widget)
boolean
Whether the banner is hidden
string
Status of the banner (e.g., draft, active)
string
required
Unique identifier of the banner to update
string
Frequency setting (e.g., once)
boolean
Whether this is a new trigger
integer
Number of days for frequency
string
Type of frequency (e.g., dynamic)
string
Type of page filter (e.g., contains)
string
Target audience (e.g., all)
string
Stop sending after this date/time in ISO 8601 format
string
Start sending after this date/time in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_ENGAGEMENT_COBROWSETool 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.

Input Parameters

string
Name of the cobrowse product tour
string ("TOUR")
Type of engagement, typically ‘TOUR’
boolean
Whether sound is enabled for the tour
object
Configuration object for cobrowse type
string ("widget")
Display format
boolean
Whether the tour is hidden from users
string ("draft" | "active" | "paused")
Status of the tour
string ("once")
How often to show
string
Description of the cobrowse product tour
string ("dynamic")
Frequency type
string ("contains")
Page filter type
string ("all")
Target audience selection
string
required
Unique identifier of the cobrowse product tour to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_ENGAGEMENT_EMAILTool 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.

Input Parameters

string
Name of the engagement email
string
Type of engagement, typically ‘EMAIL’
string
Display format of the email
string
Status of the email (e.g., draft, active, paused)
string
Content body of the email (HTML or plain text)
string
Subject line of the email
string
How often the email is sent (e.g., once, daily, weekly)
integer
Number of days for frequency calculation
string
Frequency type for sending the email (e.g., dynamic, static)
string
Type of page filtering applied
string
Target audience for the email (e.g., all, specific)
string
Stop sending after this date/time in ISO 8601 format
string
required
Unique identifier of the engagement email to update
string
Start sending after this date/time in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_ENGAGEMENT_MODALTool to update an existing engagement modal. Use when you need to modify properties like name, status, format, or targeting configuration of a modal dialog.

Input Parameters

string
Name of the modal
string ("MODAL")
Type of engagement, typically ‘MODAL’
boolean
Whether sound is enabled for the modal
string ("widget")
Display format
boolean
Whether the modal is hidden from users
string ("DRAFT" | "ACTIVE" | "PAUSED")
Status of the modal
string
required
Unique identifier of the modal to update
string
How often the modal is shown (e.g., once)
integer
Number of days for frequency calculation
string
Frequency type for displaying the modal (e.g., dynamic)
string
Type of page filtering applied (e.g., contains)
string
Target audience for the modal (e.g., all)
string
ISO 8601 timestamp when to stop sending the modal
string
ISO 8601 timestamp when to start sending the modal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name of the news article
boolean
Whether the news has been sent
string
Type of engagement (e.g., NEWS)
boolean
Whether to play sound
string
Format of the news article display (e.g., BANNER)
boolean
Whether the news is hidden
string
required
The unique identifier (ObjectId) of the news article to update. Must be a valid news ID from the project’s engagement news list.
string
Status of the news article (e.g., DRAFT, PUBLISHED)
string
Frequency of display (e.g., ONCE)
boolean
Whether to use new trigger
string
Page URL or pattern to filter
integer
Number of days for frequency
string
Type of frequency
string ("is" | "isnot" | "contains" | "notcontains" | "startswith" | "endswith" | "empty" | "notempty")
Enum for page filter types.
string
Target audience for the news article
string
End date for displaying the news in ISO 8601 format
string
Start date for displaying the news in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_ENGAGEMENT_PRODUCT_TOURTool to update an existing product tour. Use when you need to modify properties like name, status, configuration, or targeting of a product tour.

Input Parameters

string
Name of the product tour
string
Type of engagement (e.g., TOUR)
boolean
Whether sound is enabled
object
Configuration object for the product tour
string
Format of the product tour (e.g., widget)
boolean
Whether the tour is hidden
string ("draft" | "published")
Status of the product tour
string
Frequency setting (e.g., once)
boolean
Whether new trigger is enabled
integer
Number of days for frequency
string
Type of frequency (e.g., dynamic)
string
required
Unique identifier of the product tour to update
string
Page filter type (e.g., contains)
string
Target audience (e.g., all)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_ENGAGEMENT_PUSH_NOTIFICATIONTool to update an existing push notification. Use when you need to modify properties like title, message, status, targeting, or scheduling of a push notification.

Input Parameters

string
Name of the push notification
string
Type of engagement (e.g., PUSH)
boolean
Whether to play sound with the push notification
string
Title of the push notification
string
Display format of the notification (e.g., widget)
boolean
Whether the notification is hidden
string
Status of the push notification (e.g., draft, active)
string
Message content of the push notification
string
Frequency of the notification (e.g., once)
integer
Number of days for frequency calculation
string
Type of frequency (e.g., dynamic)
string
Type of page filter (e.g., contains)
string
Target audience (e.g., all)
string
Stop sending after this date/time in ISO 8601 format
string
Start sending after this date/time in ISO 8601 format
string
required
Unique identifier of the push notification to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name of the survey
string
Type of engagement element (e.g., SURVEY)
boolean
Whether sound is enabled for the survey
string
Display format of the survey (e.g., widget)
boolean
Whether the survey is hidden
string
Status of the survey (e.g., draft, active)
string
required
Unique identifier of the survey to update (24-character hexadecimal string)
string
Frequency setting for displaying the survey (e.g., once)
boolean
Whether a new trigger is enabled
integer
Number of days for frequency configuration
string
Frequency type configuration (e.g., dynamic)
string
Page filter type configuration (e.g., contains)
string
Target audience configuration (e.g., all, authenticated)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_ENGAGEMENT_TOOLTIPSTool to update an engagement tooltip. Use when modifying tooltip properties like name, active status, targeting, or frequency settings.

Input Parameters

string
Name of the tooltip
string
Type of engagement (typically auto-set to TOOLTIP)
boolean
Whether sound is enabled
boolean
Whether the tooltip is active
string
Display format (e.g., widget)
boolean
Whether the tooltip is hidden
string
Status of the tooltip (e.g., draft, active)
string
Frequency setting (e.g., once)
string
required
Unique identifier of the tooltip to update. Must be a valid tooltip ID from the project’s engagement tooltips list.
integer
Number of days for frequency
string
Type of frequency (e.g., dynamic)
string
Type of page filter (e.g., contains)
string
Target audience (e.g., all)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_ENGAGEMENT_WHATSAPP_MESSAGETool 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.

Input Parameters

string
Name of the WhatsApp message
string
Type of engagement, typically ‘WHATSAPP’
boolean
Whether sound notification is enabled
string
Display format of the message
boolean
Whether the message is hidden
string
Status of the message (e.g., draft, active)
string
How often the message is sent (e.g., once, daily, weekly)
boolean
Whether this creates a new trigger
integer
Number of days for frequency calculation
string
Frequency type for sending the message (e.g., dynamic, static)
string
Type of page filtering applied
string
Target audience for the message (e.g., all, specific)
string
Stop sending after this date/time in ISO 8601 format
string
Start sending after this date/time in ISO 8601 format
string
required
Unique identifier of the WhatsApp message to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Numeric document ID this collection belongs to, if applicable
string
Title of the help center collection
string
Identifier of the parent collection for nesting
string
URL to an icon representing the collection
string
Project ID the collection belongs to
string
String used to order this collection among its peers
string
External identifier for syncing with other systems
string
Detailed description of the collection
string
Audience for this collection (e.g., ‘all’)
object
Base filter criteria object to limit the audience
object
Additional filter criteria to extend the base audience
string
required
ID of the help center collection to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The new URL path to redirect to. This is the destination URL for the redirect.
string
required
The old URL path to redirect from. This is the source URL that should be matched.
string ("exact" | "pattern")
required
The type of URL matching to use. ‘exact’ for exact URL match, ‘pattern’ for pattern-based matching.
string
required
The unique identifier of the redirect to update. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Title of the message template
array
Array of user IDs who have access to this template. Only applicable when isPublic is false.
array
Array of action items for the template (e.g., buttons, links)
string
required
Content of the message template. Can be plain text, HTML, or structured data depending on template type.
boolean
Whether the template is publicly accessible. Set to true for public templates or false for restricted access.
string
required
Lexorank position for template ordering. Used for custom sorting in template lists.
array
Array of attachment objects associated with the template
string
required
Unique identifier of the message template to update. This is a 24-character hexadecimal string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the project to update. This is a 24-character hexadecimal string.
string
Project name to update
string
URL of the project picture/logo
string
Project description to update
string
Contact phone number for the project
array
Array of feedback tags with label and color properties for categorizing feedback
boolean
Enable or disable general bug notifications. When true, team members receive notifications for bug-related events.
boolean
Enable or disable secure session identification. When true, additional security measures are applied to session identification.
string
Email address or user identifier to receive bug notifications
boolean
Enable or disable hiding detail tabs on shared bugs. When true, detail tabs are hidden when bugs are shared externally.
boolean
Enable or disable bug assignment notifications. When true, team members receive notifications when bugs are assigned to them.
boolean
Enable or disable feedback received notifications. When true, team members receive notifications when new feedback is received.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GLEAP_UPDATE_QA_ANSWERUpdates 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.

Input Parameters

array
Tags for categorizing the snippet. Provide to update tags.
string
The answer text for the snippet. Provide this to update the answer.
boolean
Whether the snippet is skipped. Set to true to mark as skipped.
string
The question text for the snippet. Provide this to update the question.
string
required
The unique identifier of the project containing the QA answer
string
required
The unique identifier of the QA answer/snippet to update
boolean
Whether the snippet is acknowledged. Set to true to mark as acknowledged.
boolean
Whether to prevent chunking of this snippet in AI processing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Service level agreement value.
string
Language code (e.g., ‘en’, ‘de’, ‘fr’).
string
User’s full name.
string
Subscription plan.
array
Array of tag strings for categorizing and organizing sessions.
string
User’s email address.
string
User’s phone number.
number
Monetary or lifetime value associated with the user.
string
URL to user avatar image.
string
User identifier for the session.
boolean
Whether the user is blocked.
string
Unique Gleap session identifier.
string
Project ID.
string
Platform (e.g., web, ios, android).
number
Number of sessions.
string
Company identifier.
boolean
Whether user is email-only.
string
Hash of the Gleap session.
object
Custom metadata attached to the session (key-value pairs).
string
Device type (e.g., mobile, desktop, tablet).
string
Facebook ID.
string
required
The unique identifier (ID) of the session to update. This is a 24-character hexadecimal string.
string
Company name.
string
Instagram ID.
string
Organisation ID.
boolean
Whether user is unsubscribed.
string
Instagram username.
string
Reason for unsubscription.
number
Count of feedback reports.
number
Count of feedback comments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user to update. Use ‘me’ to update the authenticated user’s profile.
string
User’s last name. Updates the last name field.
string
The user’s role designation. Updates the role field.
boolean
Whether the user is currently available. Set to true for available or false for unavailable.
string
User’s first name. Updates the first name field.
string
Description of how the user intends to use Gleap. Updates the usage field.
string
Current password (required when changing password). Must be provided along with new password in notification settings.
string
How the user found out about Gleap. Updates the referral source.
string
URL to the user’s profile image. Updates the profile picture.
boolean
Whether the user has completed onboarding. Set to true when onboarding is complete.
array
List of project IDs where the user is marked as unavailable. Updates the unavailable projects list.
object
Notification settings object containing global notification configuration. Updates the notification settings.
object
Notification preferences object containing settings for different notification types (e.g., {‘personal-ticket-messages’: {‘push’: true, ‘email’: false}}). Updates the notification preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
Email address of the user casting the vote. Used to track votes and prevent duplicate voting.
string
required
The unique identifier (ID) of the ticket to vote for. This is a 24-character hexadecimal string.

Output

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