Skip to main content
The API accepts any event name that follows the format (lowercase letters, digits, and underscores). This catalog is a convention, not a rule: nothing here is validated, and you can send events and properties that are not on the list. Following the catalog is worth it for two reasons:
  • The same names and properties across all events keep flows and messages predictable: {{event.order_number}} works the same in order_shipped and in order_delivered.
  • An event with a name from the catalog starts with the nature shown in the table (utility or marketing), returned by GET /v1/event-types.
  • Some events have a ready-made flow in the Bevits recipes: Order shipped for order_shipped (reads tracking_code, tracking_url and carrier) and Pix generated for pix_generated (reads pix_code and order_url, reminds the customer 15 minutes later and stops when payment_confirmed arrives with the same order_number), and Points expiring for points_expiring (reads points).
See how to send them in Custom events.

Common properties

Use these properties, with the same name, in every event where they make sense: In events about a product, product is an object with sku, name, price_in_cents, image_url, url, and category.

Catalog

In the API, the nature shows as utility or marketing. Events without a nature (review_submitted, nps_answered) usually generate no message: they record the customer’s answer. Dates and times go as ISO 8601 text (2026-11-22 or 2026-11-22T14:00:00-03:00). Monetary values go in cents.

Three rules

1. Nature of the event

Utility is an event about something the customer already did: an order, a payment, a delivery. Marketing is an event used to sell, such as back_in_stock or coupon_issued, and the message it generates requires the customer’s consent. The nature is a property of the event type. Names from the catalog start with the nature from the table; a name outside the catalog starts without a nature and follows the marketing rule. The nature can be changed in Settings → Events. A utility event reaches customers who never accepted marketing, but not those who asked to leave; on official WhatsApp, the template must be utility too. Details in Who receives the flow’s messages.

2. Product events are sent per customer

back_in_stock and price_dropped happen to a product, but the API links each event to a customer. Send one event per interested customer, using bulk sending.

3. Left out of the catalog on purpose

Password resets and verification codes are not in the catalog. They are time-critical messages and do not belong in a marketing flow.

If your store has no native integration

The native Bevits integrations already generate the events for an order being created, paid, shipped, and cancelled, for an abandoned cart, and for a new customer. If you send those facts through the API because you do not use a native integration, use the names from the catalog: order_placed, payment_confirmed, order_shipped, order_cancelled, checkout_started, and account_created.