User Auth Data & Events

The User Auth drop-in uses the event bus to emit and listen to events for communication between drop-ins and external integrations.

Version: 3.2.0

Events reference

Event	Direction	Description
auth/adobe-commerce-optimizer	Emits	Emitted when Adobe Commerce Optimizer data is loaded or updated.
auth/error	Emits	Emitted when an error occurs.
auth/group-uid	Emits	Emitted when the customer group UID is set or changes.
auth/permissions	Emits	Emitted when permissions are updated.

Event details

The following sections provide detailed information about each event, including its direction, event payload, and usage examples.

auth/adobe-commerce-optimizer (emits)

Emitted when Adobe Commerce Optimizer data is loaded or updated.

Event payload

AdobeCommerceOptimizerModel

See AdobeCommerceOptimizerModel for full type definition.

Example

import { events } from '@dropins/tools/event-bus.js';

events.on('auth/adobe-commerce-optimizer', (payload) => {
  console.log('auth/adobe-commerce-optimizer event received:', payload);
  // Add your custom logic here
});

auth/error (emits)

Emitted when an error occurs.

Event payload

{ source: string; type: string; error: Error | string }

Example

import { events } from '@dropins/tools/event-bus.js';

events.on('auth/error', (payload) => {
  console.log('auth/error event received:', payload);
  // Add your custom logic here
});

auth/group-uid (emits)

Emitted when the customer group UID is set or changes.

Event payload

string

Example

import { events } from '@dropins/tools/event-bus.js';

events.on('auth/group-uid', (payload) => {
  console.log('auth/group-uid event received:', payload);
  // Add your custom logic here
});

auth/permissions (emits)

Emitted when permissions are updated.

Event payload

PermissionsModel

See PermissionsModel for full type definition.

Example

import { events } from '@dropins/tools/event-bus.js';

events.on('auth/permissions', (payload) => {
  console.log('auth/permissions event received:', payload);
  // Add your custom logic here
});

Data Models

The following data models are used in event payloads for this drop-in.

AdobeCommerceOptimizerModel

Used in: auth/adobe-commerce-optimizer.

interface AdobeCommerceOptimizerModel {
  priceBookId: string;
}

PermissionsModel

Used in: auth/permissions.

interface PermissionsModel {
  all?: boolean;
  admin?: boolean;
  [key: string]: boolean;
}