Methods and Event hooks

Use the Web SDK with several useful methods and listen to lifecycle event hooks for deeper integrations

Use Methods for the SDK widget + configure for deeper integrations with Lifecycle Event hooks

Available Methods

Option
Description

setEmail()

Update the email of the bug reporter

setStyles()

Update the styles of the widget

getStyles()

Get the styles of the widget

show()

Show the floating widget

hide()

Hide the floating widget

openWidget()

Open the bug reporting widget

closeWidget()

Close the bug reporting widget

setMetadata()

Update the attached metadata

captureScreenshot()

Trigger screenshot capture

startRecording()

Start session recording

stopRecording()

Stop the ongoing recording

on()

Register an event listener

off()

Unregister an event listener

destroy()

Destroy the BetterBugs instance

Available Lifecycle Event hooks

You can also listen to lifecycle events of the SDK widget and use it for deeper integrations in your apps:

Lifecycle event
Trigger description

emailUpdate

Triggered when the email is updated

screenshot

Triggered after the screenshot is captured

recordingStart

Triggered when the recording starts

recordingStop

Triggered when the recording stops

bugSubmit

Triggered after the bug report/feedback is submitted

metaDataUpdate

Triggered when the metadata is updated

positionUpdate

Triggered when the widget position changes

widgetOpen

Triggered when the widget opens

widgetClose

Triggered when the widget closes

showActionButton

Triggered when the action button gets displayed

hideActionButton

Triggered when the action button hides

sessionCreated

Triggered when a new session is created

Last updated

Was this helpful?