Company Management data & events

The Company Management drop-in uses the Event Bus to emit and listen to events for communication between drop-ins and external integrations. For common events shared across multiple drop-ins (such as locale, error, authenticated, etc.), see the Common Events Reference.

Auto-generated on 2025-10-21. Do not edit this page directly.

Emits Reference

Events produced by this drop-in that you can subscribe to.

Event	Direction	Description
company/updated	Emits	Fired when company data is updated

Listens Reference

Events this drop-in listens for from external sources.

Event	Direction	Description
company/form-field-changed	Listens	Fired when any form field value changes 🚧
company/form-submitted	Listens	Fired when registration form is submitted 🚧
company/form-validation-error	Listens	Fired when form validation fails 🚧
company/loaded	Listens	Fired when company data is loaded 🚧
company/update-failed	Listens	Fired when update fails 🚧
company/update-started	Listens	Fired when update process begins 🚧
companyContext/changed	Listens	Cache reset and refetch using the updated GraphQL headers

Emits and Listens Reference

Note

No bidirectional events. See Common Events for shared events.

Event Details

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

company/updated (emits)

Fired when company data is updated

Data payload

{ company?: any; message?: string; error?: any }

Property	Type	Description
company	any (optional)	See type definition in source code
message	string (optional)	See type definition in source code
error	any (optional)	See type definition in source code

Usage

Listen to this event in your storefront:

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

const companyUpdatedListener = events.on('company/updated', (data) => {
  console.log('company/updated event received:', data);
  // Add your custom logic here
});

// Later, when you want to stop listening
companyUpdatedListener.off();

company/form-field-changed (listens)

Fired when any form field value changes

Planned Event

This event is documented but not yet implemented in the current version. The API may change before implementation.

Data payload

Note

Payload structure will be defined when this event is implemented. Check the documentation or source code for the most current information.

Usage

Listen to this event in your storefront:

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

const companyFormFieldChangedListener = events.on('company/form-field-changed', (data) => {
  console.log('company/form-field-changed event received:', data);
  // Add your custom logic here
});

// Later, when you want to stop listening
companyFormFieldChangedListener.off();

company/form-submitted (listens)

Fired when registration form is submitted

Planned Event

This event is documented but not yet implemented in the current version. The API may change before implementation.

Data payload

Note

Payload structure will be defined when this event is implemented. Check the documentation or source code for the most current information.

Usage

Listen to this event in your storefront:

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

const companyFormSubmittedListener = events.on('company/form-submitted', (data) => {
  console.log('company/form-submitted event received:', data);
  // Add your custom logic here
});

// Later, when you want to stop listening
companyFormSubmittedListener.off();

company/form-validation-error (listens)

Fired when form validation fails

Planned Event

This event is documented but not yet implemented in the current version. The API may change before implementation.

Data payload

Note

Payload structure will be defined when this event is implemented. Check the documentation or source code for the most current information.

Usage

Listen to this event in your storefront:

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

const companyFormValidationErrorListener = events.on('company/form-validation-error', (data) => {
  console.log('company/form-validation-error event received:', data);
  // Add your custom logic here
});

// Later, when you want to stop listening
companyFormValidationErrorListener.off();

company/loaded (listens)

Fired when company data is loaded

Planned Event

This event is documented but not yet implemented in the current version. The API may change before implementation.

Data payload

Note

Payload structure will be defined when this event is implemented. Check the documentation or source code for the most current information.

Usage

Listen to this event in your storefront:

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

const companyLoadedListener = events.on('company/loaded', (data) => {
  console.log('company/loaded event received:', data);
  // Add your custom logic here
});

// Later, when you want to stop listening
companyLoadedListener.off();

company/update-failed (listens)

Fired when update fails

Planned Event

This event is documented but not yet implemented in the current version. The API may change before implementation.

Data payload

Note

Payload structure will be defined when this event is implemented. Check the documentation or source code for the most current information.

Usage

Listen to this event in your storefront:

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

const companyUpdateFailedListener = events.on('company/update-failed', (data) => {
  console.log('company/update-failed event received:', data);
  // Add your custom logic here
});

// Later, when you want to stop listening
companyUpdateFailedListener.off();

company/update-started (listens)

Fired when update process begins

Planned Event

This event is documented but not yet implemented in the current version. The API may change before implementation.

Data payload

Note

Payload structure will be defined when this event is implemented. Check the documentation or source code for the most current information.

Usage

Listen to this event in your storefront:

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

const companyUpdateStartedListener = events.on('company/update-started', (data) => {
  console.log('company/update-started event received:', data);
  // Add your custom logic here
});

// Later, when you want to stop listening
companyUpdateStartedListener.off();

companyContext/changed (listens)

Cache reset and refetch using the updated GraphQL headers

Data payload

string | null | undefined

Usage

Listen to this event in your storefront:

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

const companyContextChangedListener = events.on('companyContext/changed', (data) => {
  console.log('companyContext/changed event received:', data);
  // Add your custom logic here
});

// Later, when you want to stop listening
companyContextChangedListener.off();