Event types

Every event has an eventType. The built-in types are listed below. To see available types, including custom types, use GET /v1/event-types (MCP tool list_event_types), with a JSON schema summary for each type.

curl -s "https://api.vyg.app/v1/event-types" \
  -H "Authorization: Bearer $VYG_API_KEY"

This endpoint lists collection event types; it does not register new types. To define webhook events for a data source (a custom integration), see Custom Events.

Storefront events

Sent by the web pixels from shoppers' browsers.

`eventType`	When it is sent
`page_viewed`	A shopper views a page.
`product_viewed`	A shopper views a product.
`collection_viewed`	A shopper views a collection.
`search_submitted`	A shopper runs a search.
`cart_viewed`	A shopper views their cart.
`product_added_to_cart`	A shopper adds a product to their cart.
`product_removed_from_cart`	A shopper removes a product from their cart.
`checkout_started`	A shopper starts checkout.
`checkout_contact_info_submitted`	A shopper submits contact details in checkout.
`checkout_address_info_submitted`	A shopper submits an address in checkout.
`checkout_shipping_info_submitted`	A shopper submits shipping details in checkout.
`payment_info_submitted`	A shopper submits payment details in checkout.
`checkout_completed`	A shopper completes checkout.
`link_clicked`	A shortened link in a message is clicked.
`updateProperties`	Identity details (email, phone) are attached to a visitor.
`view`	A generic page or screen view.
`modifyConsent`	A visitor changes their consent choices.

Store and messaging events

Recorded by VYG from your connected store and from messaging.

`eventType`	When it is recorded
`order_created`	An order is paid.
`checkout_abandoned`	A checkout is abandoned.
`checkout_recovered`	An abandoned checkout is completed after VYG messaged the shopper.
`cart_updated`	A cart changes.
`customer_updated`	A customer is created or updated in the store.
`consent_updated`	A customer's marketing consent changes.
`subscription_changed`	A subscription starts, stops or restarts.
`refund_issued`	A refund is processed on an order.
`fulfillment_updated`	A fulfillment's status changes.

Your own events

Server-side events can use any eventType made of a letter followed by letters, digits or underscores, up to 64 characters, for example orderShipped or supportTicketClosed. Custom integrations define their event types with event definitions; see Custom Integration.

Storefront events

Store and messaging events

Your own events

On this page