Events | Chargebee API documentation

API Version

Product Catalog

Library

All Events

Triggered when a new gift is created.

Event Schema

id

string
Unique identifier for the event

occurred_at

integer (unix timestamp)
Timestamp when the event occurred

source

string
Source that triggered the event (e.g., admin_console, api, scheduled_job)

object

string
Always "event" for webhook events

api_version

string
API version used for this event

event_type

string
Type of the webhook event

webhook_status

string
Status of the webhook delivery

content
Hide attributes [-]

object
Content of the event

gift

object
The gift object affected by this event

Sample Payload

{
    "id": "ev_16B4pHj5oQjtHHxQ",
    "occurred_at": 1755864600,
    "source": "admin_console",
    "object": "event",
    "api_version": "v2",
    "event_type": "gift_scheduled",
    "webhook_status": "not_applicable",
    "content": {
        "gift": {
            "auto_claim": false,
            "claim_expiry_date": 1525277496,
            "gift_receiver": {
                "customer_id": "receiver",
                "email": "james@user.com",
                "first_name": "James",
                "last_name": "William",
                "object": "gift_receiver",
                "...": "..."
            },
            "gift_timelines": [
                {
                    "object": "gift_timeline",
                    "occurred_at": 1517501491,
                    "status": "scheduled"
                }
            ],
            "gifter": {
                "customer_id": "gifter",
                "invoice_id": "__demo_inv__6",
                "object": "gifter",
                "signature": "John"
            },
            "...": "..."
        }
    }
}