Overview

A product in the platform can have many purposes. Sometimes, a product is just a set of questions with the purpose of collecting data. Other times, a product may do many other things - for example, sell and issue a policy to the client. It can also be a bundle with many purposes all built and mixed together.

Basically, you can use your imagination when it comes to how you want to use your product.

To accommodate this variety, Events and Actions provide the means.

What is an event?#

During and after user interaction with a product (answering of the questions), a variety of options can be presented to the user. For example, a user could have an option to: save their progress, request contact by 3rd party, request a quote or purchase coverage.

These options are represented by Events, and when a user initiates an event, we refer to that as Firing an event.

What is an action?#

After an event has been fired, any number of things can happen. Each of those "things" that happen is called an Action.

Actions can perform a variety of tasks. For example, there's an action that will: Map client intake to a PDF document and send it via email to address(es) you specify. Some actions will take a payload of data collected and send it to some remote web-endpoint.

Tip: Each event could have multiple, same or different actions.

How are events and actions added to the product?#

Events are added to a specific workflow on a product. To start, select a product and a workflow. To add an event, click + Add new event link.

Select the event to configure its actions. An event can have multiple actions, subject to the action types supported by that event.

Once an event is added and selected, to the right of it you can click + Add new action to add a new action.

How are events fired?#

Events may be fired either programmatically via API, or from one of the products themselves.

Firing an event in a Storefront and CoPilot#

Storefront and CoPilot interactions can submit events from configured workflows. The events exposed by a particular interface depend on that application and the product configuration.

The simplest example of an event firing in a Storefront/CoPilot is "Get Quotes" button. An integration can submit a "GET_QUOTES" event when a user requests quotes. Product configuration and enabled actions determine the resulting workflow. See GET_QUOTES for its payload.

Firing an event via API#

Use Firing an Event for the shared request envelope, execution modes, and trigger response. Event-specific processing and webhook payload mappings depend on the configured actions.