An index of the JavaScript SDK, grouped by what you're trying to do. Signatures and per-platform equivalents live in the developer docs at docs.gleap.io — this is here so you know which method to look up.
The other SDKs carry the same concepts under their own naming conventions.
initialize, destroy, setApiUrl, setFrameUrl, setWSApiUrl, setCSPNonce, setLiveSite, setEnvironment, setAppVersionCode, setAppBuildNumber.
You need initialize and, if you run more than one deployment, setEnvironment. The URL setters exist for self-hosted setups.
identify, updateContact, clearIdentity, getIdentity, isUserIdentified, setTags, setLanguage.
Identify on login, clear on logout. isUserIdentified is the one to reach for when you're debugging why a contact shows as a guest.
setCustomData, attachCustomData, removeCustomData, clearCustomData, trackEvent.
Custom data describes the person; events describe what they did. logEvent is the old name for trackEvent and still works.
open, close, isOpened, hide, showFeedbackButton, openConversations, openConversation, startConversation, openHelpCenter, openHelpCenterArticle, openHelpCenterCollection, searchHelpCenter, openNews, openNewsArticle, openFeatureRequests, openChecklists, openChecklist.
This is how you wire your own buttons: a “Help” item in your menu can open the help center directly rather than dropping people at the messenger home.
startBot, startAgent, startClassicForm, startFeedbackFlow, startProductTour, startChecklist, showSurvey, preFillForm.
Use these when your app knows something the widget doesn't — launching the tour after a specific action, or opening a form with fields already filled in.
askAI, showAiChatbar, hideAiChatbar, setAiChatbarQuickActions, registerAgentTool, registerAgentToolAction, createAgentChat, sendAgentMessage, clearAgentConversation.
The agent tools are the interesting pair: they let an AI agent call a function in your frontend and use the result in its answer.
log, startNetworkLogger, attachNetworkLogs, setMaxNetworkRequests, setNetworkLogsBlacklist, setNetworkLogPropsToIgnore, disableConsoleLogOverwrite, setReplayOptions, sendSilentCrashReport, sendSilentCrashReportWithFormData.
The blacklist and props-to-ignore pair is what keeps tokens and personal data out of captured requests. setReplayOptions does the same for the replay, by class or selector.
on, registerCustomAction, setUrlHandler.
The right method here is Gleap.on(event, callback) — events include initialized, open, close, flow-started, the checklist events, and the agent ones. setUrlHandler takes over link opening, which matters inside a native app.
on — look for the “Events” page of your platform.setTicketAttribute, unsetTicketAttribute, clearTicketAttributes.
For pre-filling fields on the ticket that gets created — which screen they were on, which plan they're on — so an agent doesn't have to ask.
setStyles, setLanguage, setUseCookies, setDisablePageTracking, setDisableInAppNotifications, showTabNotificationBadge, enableShortcuts, playSound, closeModal, setModalUrl, setBannerUrl, closeBanner.
Most of these have a dashboard equivalent; the code versions exist for cases where the value only exists at runtime — a theme the user picked, a language your app already knows.