← Tools Reference

Gleap

Gleap integration (Communication, Productivity). Imported from open-connector.

API key11 toolshttps://api.gleap.io/v3
GET
gleap_get_current_user
Get the current Gleap user for the connected API key.

/users/me

GET
gleap_list_contacts
List Gleap contact sessions for the connected project.

/sessions

GET
gleap_get_contact_by_user_id
Get a Gleap contact session by external user ID.

/sessions/by-user-id/{userId}

1 parameter
ParamTypeRequiredDescription
userIdstringrequiredExternal user ID associated with the contact.
POST
gleap_create_contact
Create a Gleap contact session in the connected project.

/sessions

14 parameters
ParamTypeRequiredDescription
userIdstringoptionalExternal user ID for the contact.
emailstringoptionalContact email address.
namestringoptionalContact display name.
phonestringoptionalContact phone number.
avatarstringoptionalContact avatar URL.
companyIdstringoptionalCompany ID associated with the contact.
companyNamestringoptionalCompany name associated with the contact.
planstringoptionalPlan name associated with the contact.
valuenumberoptionalNumeric customer value associated with the contact.
tagsarrayoptionalTags associated with the Gleap resource.
blockedbooleanoptionalWhether the contact is blocked.
unsubscribedbooleanoptionalWhether the contact is unsubscribed.
customDataobjectoptionalCustom data object accepted by Gleap.
eventDataobjectoptionalCustom data object accepted by Gleap.
PUT
gleap_update_contact
Update a Gleap contact session by session ID.

/sessions/{sessionId}

15 parameters
ParamTypeRequiredDescription
sessionIdstringrequiredGleap session ID to update.
userIdstringoptionalUpdated external user ID.
emailstringoptionalUpdated contact email address.
namestringoptionalUpdated contact display name.
phonestringoptionalUpdated contact phone number.
avatarstringoptionalUpdated contact avatar URL.
companyIdstringoptionalUpdated company ID.
companyNamestringoptionalUpdated company name.
planstringoptionalUpdated plan name.
valuenumberoptionalUpdated numeric customer value.
tagsarrayoptionalTags associated with the Gleap resource.
blockedbooleanoptionalUpdated blocked state.
unsubscribedbooleanoptionalUpdated unsubscribe state.
customDataobjectoptionalCustom data object accepted by Gleap.
eventDataobjectoptionalCustom data object accepted by Gleap.
GET
gleap_list_tickets
List Gleap tickets with documented filters, sorting, and pagination.

/tickets

10 parameters
ParamTypeRequiredDescription
typestringoptionalTicket type filter, such as BUG or comma-separated types.
statusstringoptionalTicket status filter, such as OPEN.
prioritystringoptionalTicket priority filter, such as HIGH or comma-separated priorities.
archivedbooleanoptionalWhether to include only archived or non-archived tickets.
ignoreArchivedbooleanoptionalWhether Gleap should ignore archived tickets.
isSpambooleanoptionalWhether to include only spam or non-spam tickets.
sortstringoptionalSort order accepted by Gleap.
limitintegeroptionalMaximum number of tickets to return.
skipintegeroptionalNumber of tickets to skip for offset pagination.
filtersobjectoptionalAdditional Gleap document filters forwarded as query parameters.
GET
gleap_get_ticket
Get a Gleap ticket by ID.

/tickets/{ticketId}

1 parameter
ParamTypeRequiredDescription
ticketIdstringrequiredGleap ticket ID.
POST
gleap_create_ticket
Create a Gleap ticket with native ticket fields.

/tickets

17 parameters
ParamTypeRequiredDescription
titlestringrequiredTicket title.
typestringoptionalTicket type accepted by Gleap.
statusstringoptionalTicket status accepted by Gleap.
prioritystringoptionalTicket priority accepted by Gleap.
descriptionstringoptionalTicket description.
plainContentstringoptionalPlain text ticket content.
sessionstringoptionalGleap session ID linked to the ticket.
processingUserstringoptionalGleap user ID assigned to the ticket.
processingTeamstringoptionalGleap team ID assigned to the ticket.
tagsarrayoptionalTags associated with the Gleap resource.
formDataobjectoptionalForm data object accepted by Gleap.
customDataobjectoptionalCustom data object accepted by Gleap.
attributesobjectoptionalTicket attributes object accepted by Gleap.
attachmentsarrayoptionalTicket attachments accepted by Gleap.
archivedbooleanoptionalWhether the ticket is archived.
isSpambooleanoptionalWhether the ticket is marked as spam.
preventAutoReplybooleanoptionalWhether Gleap should prevent automatic replies.
POST
gleap_create_ticket_with_message
Create a Gleap ticket with an optional initial message.

/tickets/compose

12 parameters
ParamTypeRequiredDescription
typestringrequiredTicket type accepted by Gleap.
titlestringrequiredTicket title.
messagestringoptionalInitial ticket message.
prioritystringoptionalTicket priority accepted by Gleap.
statusstringoptionalTicket status accepted by Gleap.
processingUserstringoptionalGleap user ID assigned to the ticket.
processingTeamstringoptionalGleap team ID assigned to the ticket.
tagsarrayoptionalTags associated with the Gleap resource.
sessionstringoptionalGleap session ID linked to the ticket.
emailstringoptionalEmail address used when composing the ticket.
formDataobjectoptionalForm data object accepted by Gleap.
preventAutoReplybooleanoptionalWhether Gleap should prevent automatic replies.
PUT
gleap_update_ticket
Update a Gleap ticket by ID.

/tickets/{ticketId}

19 parameters
ParamTypeRequiredDescription
ticketIdstringrequiredGleap ticket ID to update.
titlestringoptionalTicket title.
typestringoptionalTicket type accepted by Gleap.
statusstringoptionalTicket status accepted by Gleap.
prioritystringoptionalTicket priority accepted by Gleap.
descriptionstringoptionalTicket description.
plainContentstringoptionalPlain text ticket content.
sessionstringoptionalGleap session ID linked to the ticket.
processingUserstringoptionalGleap user ID assigned to the ticket.
processingTeamstringoptionalGleap team ID assigned to the ticket.
tagsarrayoptionalTags associated with the Gleap resource.
formDataobjectoptionalForm data object accepted by Gleap.
customDataobjectoptionalCustom data object accepted by Gleap.
attributesobjectoptionalTicket attributes object accepted by Gleap.
attachmentsarrayoptionalTicket attachments accepted by Gleap.
archivedbooleanoptionalWhether the ticket is archived.
isSpambooleanoptionalWhether the ticket is marked as spam.
preventAutoReplybooleanoptionalWhether Gleap should prevent automatic replies.
forceCloseOverridebooleanoptionalWhether Gleap should force close behavior overrides.
DELETE
gleap_delete_ticket
Delete a Gleap ticket by ID.

/tickets/{ticketId}

1 parameter
ParamTypeRequiredDescription
ticketIdstringrequiredGleap ticket ID.