A custom event lets your process tell your website or app that something happened in the conversation. Nothing is shown to the customer. Your own code receives the event and decides what to do, for example open a page, update the cart or show a banner.

Send an event from a process

In a Script Block, call ui.sendEvent with the event name and optional parameters. All parameter values must be strings.

ui.sendEvent("meetingBooked", {
  meetingId: "MTG-2041",
  date: "2026-11-20T10:00:00Z",
});

See UI methods.

Receive the event

On the website, register a handler with on. The handler receives the parameters as an object:

ZowieWidget.on("meetingBooked", (params) => {
  window.location.href = `/meetings/${params.meetingId}`;
});

For Embedded, use ZowieEmbedded.on in the same way.

In mobile apps, custom events arrive as a GenericEvent with the event name and parameters. See the documentation of your SDK in Mobile.