Handling Component Events

Check Components emit events to signal important state changes. When instantiating the Check Component SDK, your app can listen for these events by passing an onEvent handler.

const handler = window.CheckComponent.create({
  link: componentLink,
  onEvent: (event, data) => {
    // handle Check Component events
  },
});

Below is a list of arguments the onEvent function takes in:

Component events can be used to trigger another workflow or spin up other Components. For example, you can tie together the Tax Setup and Payment Setup Components by surfacing the Payment Setup Component only after the check-component-tax-setup-complete event is detected.

📘

Testing SDK Events

Frontend tip: if you want visibility into the SDK events dispatched by Check Components, simply drop this line in the web console: window.addEventListener('message', e => console.log(e.data))

Default Component Events

Each Component will always emit the following event(s):

Common Component Events

Additional Component Events

Some Components emit additional events to signal changes such as a form submission or a bank account update. Below is a list of Events and the Components that emit them: