ChargebeeAPI
Using AI coding agents like Claude Code or Cursor? Try the official Chargebee Agent Skills to speed up your development.Try now

Create an offer event

Try in API Explorer

The Create Offer Event API records user interactions with an offer for tracking and analytics purposes.
Use this API to log user-triggered engagement events such as:

  • viewed - when an offer is displayed to the user.
  • dismissed - when the user closes or ignores the offer. These events are essential for accurate offer performance reporting and funnel analysis. Make sure to send them as they happen.

Note: System-driven events like accepted and fulfilled are captured automatically by the growth system through fulfillment workflows. You do not need to post these.

Sample Request

204: No ContentSTATUS

URL Format

POST https://[site].grow.chargebee.com/api/v2/offer_events

Input Parameters

personalized_offer_id
required, string, max chars=50

The ID of the personalized offer the event pertains to.

type
required, enumerated string

The type of engagement event to be recorded.

Possible Enum Values
viewed

Logged when the user's UI renders or displays the offer

dismissed

Logged when the user closes or ignores the offer without accepting