Supported Event Types
You have the option of specifying which object events your webhook should be notified about. These event types are declared in the type
field of the parsed data
string in the event payload. In our example in the Webhook payload format tab, it's customer.updated
.
We emit created
, updated
, and deleted
events for each of your objects, which means you will receive events such as coupon.created
and customer.updated
as these operations happen. The supported objects are:
-
account
-
api_token
-
charge
-
In addition to
created
,updated
, anddeleted
, we also emitsucceeded
,failed
,pending
andrefunded
for different statuses ofcharge
lifecycle.
-
-
coupon
-
credit_note
-
credit_note_item
-
customer
-
customer_balance_transaction
-
discount
-
invite
-
invite_item_discount
-
invoice
-
In addition to
created
,updated
, anddeleted
, we also emitupcoming
,finalized
,paid
,past_due
,voided
anduncollectible
for different statuses ofinvoice
lifecycle.
-
-
invoice_discount
-
invoice_item
-
payment_intent
-
In addition to
created
,updated
, anddeleted
, we also emitsucceeded
,processing
,requires_action
andfailed
for different statuses ofpayment_intent
lifecycle.
-
-
payment_method
-
payment_processor
-
price
-
product
-
promotion_code
-
refund
-
customer.subscription
-
In addition to
created
,updated
, anddeleted
, we also emittrial_will_end
,trialing
,activated
,past_due
,paused
,resumed
andcanceled
for different statuses ofsubscription
lifecycle. -
Note:
customer.subscription.created
will be emitted for mere creation of a subscription in incomplete state. If the intention to listen to an event is customer successfully subscribing to a product, then one should listen forcustomer.subscription.trialing
andcustomer.subscription.activated
according to respective subscription status.
-
-
subscription_item
-
user
-
user_login
-
user_record
-
user_record_summary
-
webhook_endpoint