Settings
API Version
Product Catalog
Library

Offer events

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 GET

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

Model Class

  
 
Event types
 

      This is a list of the event types we currently support. We will continue
      to add more events moving forward. All events follow a uniform pattern -
      <resource>_<event_name>. The resources that will be
      present in the event content are provided beneath each event type's
      description.
    
 
Note: If consolidated invoicing is enabled, the
      attributes invoice.subscription_id and
      credit_note.subscription_id should not be used
      (as it will not be present if the invoice / credit note has lines from
      multiple subscriptions). Instead to know the related subscriptions,
      their line_items' subscription_id attribute should be referred.
    
 
 
 
 
Consent Fields for Offer event
 
 
Custom Fields for Offer event
 
  

      Create an offer event
      
  
 
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 '{
     &quot;type&quot;: &quot;viewed&quot;,
     &quot;personalized_offer_id&quot;: &quot;a52ge40b&quot;
}'
 

      copy
      
Click to Copy
 
 
204:
 
No Content
 
STATUS
 

    Sample Response [ JSON ]
  

      URL Format
      POST
 

      https://{site}.grow.chargebee.com/api/v2/offer_events
    
 
Method
 
 
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 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