Customer Feedback

Gleap

Learn how to use Gleap with Composio

Overview

SLUG: GLEAP

Description

Gleap is an all-in-one customer feedback tool for apps and websites, enabling direct communication with users to build better software by discovering their everyday pain points.

Authentication Details

bearer_token
stringRequired
generic_id
stringRequired

Connecting to Gleap

Create an auth config

Use the dashboard to create an auth config for the Gleap toolkit. This allows you to connect multiple Gleap accounts to Composio for agents to use.

1

Select App

Navigate to Gleap.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Gleap Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4gleap_auth_config_id = "ac_YOUR_GLEAP_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Gleap for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, gleap_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Gleap toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["GLEAP"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Archive a Ticket

Description

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

Action Parameters

ticketId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a Collection

Description

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

Action Parameters

baseAudienceFilter
object
description
string
docId
integer
extendedAudienceFilter
object
externalId
string
iconUrl
string
lexorank
string
parent
string
targetAudience
stringDefaults to all
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a new chat message

Description

Tool to create a new chat message. Use when sending a message in an active chat session.

Action Parameters

content
stringRequired
role
stringRequired
sessionId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a new team

Description

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

Action Parameters

assignmentMethod
stringRequired
members
arrayRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a new ticket

Description

Tool to create a new ticket. Use when you have ticket details ready to open a support ticket.

Action Parameters

attachments
array
description
string
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a User from a Project

Description

Tool to remove a user from a project. Use when you need to revoke a user's access by their ID.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get a Checklist

Description

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

Action Parameters

checklistId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get a Collection

Description

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

Action Parameters

helpcenterCollectionId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all articles

Description

Tool to retrieve all articles in a help center collection. Use when you have a helpcenterCollectionId and want to list its articles.

Action Parameters

helpcenterCollectionId
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get all chat messages

Description

Tool to retrieve all chat messages. Use when you need to list full conversation history.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get All Collections

Description

Tool to retrieve all help center collections. Use when you need to list all collections for the authenticated project.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get All Invitations for a Project

Description

Tool to retrieve all invitations for a project. Use when you need to list every pending or accepted invitation within the current project context.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get all sessions

Description

Tool to retrieve all sessions for the current project. Use after project context is confirmed. Fetches all user sessions for analysis or reporting.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get All Teams

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get All Tickets

Description

Tool to retrieve all tickets. Use when you need to list all tickets for the authenticated project.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get All Users for a Project

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a ticket

Description

Tool to retrieve a specific ticket by its ID. Use after confirming the ticket ID. Returns full ticket details.

Action Parameters

ticketId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get current user

Description

Tool to retrieve the currently authenticated user's details. Use when you need the user's profile and settings.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Help Center Sources

Description

Tool to retrieve available help center sources. Use when you need to list all help center sources for a project.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get notification ticket

Description

Tool to retrieve a notification ticket using its share token. Use when you have a share token and need to fetch ticket details.

Action Parameters

shareToken
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get session checklists

Description

Tool to retrieve checklists for a given session. Use after confirming a valid sessionId. Returns all checklists associated with the specified session.

Action Parameters

sessionId
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Identify or update user

Description

Tool to identify or update user information. Use when you need to sync server-side user profile after authentication.

Action Parameters

createdAt
string
email
string
name
string
phone
string
preventLastActivityUpdate
boolean
userId
stringRequired
value
number

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search for Tickets

Description

Tool to search for tickets. Use when needing to find tickets based on search criteria.

Action Parameters

path
string
q
string
query
string
term
string
type
string
value
string

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Track events

Description

Tool to track server-side customer events. Use when you have collected a batch of events and want to send them to Gleap via the /admin/track endpoint.

Action Parameters

events
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unarchive a Ticket

Description

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

Action Parameters

ticketId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a User for a Project

Description

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

Action Parameters

role
stringRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Chat Message

Description

Tool to update a chat message. Use when you need to modify the content of an existing chat message after obtaining its ID.

Action Parameters

body
objectRequired
chatMessageId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired