---
title: "SDK Events"
slug: "sdk-events"
updated: 2025-07-17T12:16:39Z
published: 2025-07-17T13:18:21Z
canonical: "docs.bigid.com/sdk-events"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bigid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK Events

As mentioned before, throughout the [SDK lifecycle](/consent/docs/getting-started#lifecycle-of-the-sdk-and-events) some events will be fired. These will be in the form of [Custom Events](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent), supported by all the browsers. Also, some of them will carry data within the `detail` property that will enable you to deepen any integration you need to do. You can listen to any of them with a regular listener added at the `window` object:

```json
window.addEventListener(
  'bigidcmp:widget_ready',
  (event) => console.log('The widget is ready!', event.detail),
);
```

You will find here the full list of events fired by the SDK. Remember that all data objects will always be included in the `detail` property of the event:

### bigidcmp:widget_ready[​](/consent/docs/sdk-events#illowwidget_ready)

It is fired when the UI and SDK are loaded and ready.

#### Data[​](/consent/docs/sdk-events#data)

| Property | Type | Required? | Description |
| --- | --- | --- | --- |
| isOpen | boolean | Yes | True if the UI is being shown. False if the icon or nothing at all is rendered. |
| hasPreviousConsent | boolean | Yes | True if there is an existing consent given when loading the widget. |
| gpc | boolean | No | True if the [Global Privacy Control](https://globalprivacycontrol.org/) is enabled. False if it is disabled. Undefined if the setting does not exist. |
| bannerType | string | Yes | The type of banner loaded. It can be 'global', 'gdprBanner', 'ccpaBanner'. |
| isIabEnabled | boolean | Yes | True if IAB TCF v2.2 and Google Additional Consent Mode are enabled. |
| uiSettings | [uiSettings Object](/consent/docs/sdk-events#uisettings-object​) | Yes | Some of the UI settings such as positioning, blur background, etc. |

#### uiSettings Object[​](/consent/docs/sdk-events#uisettings-object)

| Property | Type | Required? | Description |
| --- | --- | --- | --- |
| positioning | string | Yes | The widget's position. Can be 'top', 'bottom', 'squaredLeft', 'squaredRight', 'squaredCentered'. |
| isIconEnabled | boolean | Yes | True if the icon will be shown when the widget is closed. False otherwise. |
| isNoticeMode | boolean | Yes | True if the widget will not be shown on page load and the only way of opening it is by calling [showWidget](/consent/docs/sdk-methods#showwidget) |
| isBlurBackgroundEnabled | boolean | Yes | True if the background blurs when the widget is open. |
| language | string | Yes | The two-lowered-cased-letter ISO code of the language used. |

### bigidcmp:widget_opened[​](/consent/docs/sdk-events#illowwidget_opened)

It is fired when the UI is opened by clicking the icon or calling the [showWidget](/consent/docs/sdk-methods#showwidget) method.

### bigidcmp:widget_closed[​](/consent/docs/sdk-events#illowwidget_closed)

It is fired when the UI is closed.

### bigidcmp:consent_set[​](/consent/docs/sdk-events#illowconsent_set)

It is fired when the consent is set by the user.

#### Data[​](/consent/docs/sdk-events#data-1)

| Property | Type | Required? | Description |
| --- | --- | --- | --- |
| consent-id | string | Yes | The auto-generated ID created when the consent was given. |
| userId | string | No | The User ID added when identifying the user. |
| marketing | boolean | Yes | True if consent for marketing purposes was given. |
| preferences | boolean | Yes | True if consent for preferences purposes was given. |
| statistics | boolean | Yes | True if consent for statistics purposes was given. |
| optedIn | boolean | Yes | True if consent for 'Don't sell my data' purposes was given. |

### bigidcmp:identity_added[​](/consent/docs/sdk-events#illowidentity_added)

It is fired when the [identify](/consent/docs/sdk-methods#identify) method is called and the consent is now cross-device.

#### Data[​](/consent/docs/sdk-events#data-2)

| Property | Type | Required? | Description |
| --- | --- | --- | --- |
| userId | string | Yes | The User ID added when identifying the user. |

### bigidcmp:identity_removed[​](/consent/docs/sdk-events#illowidentity_removed)

It is fired when the [removeIdentity](/consent/docs/sdk-methods#removeidentity) method is called and the identity is removed.

### bigidcmp:language_changed[​](/consent/docs/sdk-events#illowlanguage_changed)

It is fired when the [setLanguage](/consent/docs/sdk-methods#setlanguage) method is called and the language is changed.

#### Data[​](/consent/docs/sdk-events#data-3)

| Property | Type | Required? | Description |
| --- | --- | --- | --- |
| language | string | Yes | The two-lowered-cased-letter ISO code of the language used. |

### bigidcmp:widget_refreshed[​](/consent/docs/sdk-events#illowwidget_refreshed)

It is fired when the [refreshWidget](/consent/docs/sdk-methods#refreshwidget) method is called and the UI is refreshed.