API Version
Product Catalog
Library
Offer events are used to record and list user interactions with personalized offers. By logging events such as views and dismissals, these APIs enable growth and analytics teams to measure the effectiveness of offers and optimize the offer funnel based on real usage data.

API Index URL

https://{site}.grow.chargebee.com/api/v2/offer_events

Model Class

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.

Notes

Sample Request
Try in API Explorer
curl  https://{site}.grow.chargebee.com/api/v2/offer_events \
     -u {site_api_key}:\
     --header 'Content-Type: application/json;charset=UTF-8' \
     --data '{
     "type": "viewed",
     "personalized_offer_id": "a52ge40b"
}'
copy
Click to Copy
204:
No Content
STATUS

Sample Response [ JSON ]

URL Format POST

https://{site}.grow.chargebee.com/api/v2/offer_events

Method

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 values are
viewedLogged when the user's UI renders or displays the offerdismissedLogged when the user closes or ignores the offer without accepting
Show all values[+]

Sample admin console URL

https://{site}.chargebee.com/admin-console/offer_events/123x