Types of events

Learn about the types of events.

The following table lists the event types we currently support. We will update the table as new event types become available.

Every event type uses the following format: resource.event. Coding is easier when you know the event types use a consistent format.

Note: When an event occurs on a subresource like checkout.customer, it does not trigger the parent's update event.

Event

Description

checkout.created Defines a new checkout

This occurs whenever you create a checkout.

checkout.updated Defines a updated checkout

This occurs whenever you update a checkout.

checkout.deleted Defines a deleted checkout

This occurs whenever you delete a checkout.

customer.created Defines a new customer

This occurs whenever you create a customer.

customer.updated Defines an updated customer

This occurs whenever you update a customer.

customer.deleted Defines a deleted customer

This occurs whenever you delete a customer.

customer.source.created Defines a new customer source

This occurs whenever you attach a source to a customer.

customer.source.deleted Defines a deleted customer source

This occurs whenever you delete a source from a customer.

file.created Defines a new file

This occurs whenever you create a file.

file.deleted Defines a deleted file

This occurs whenever you delete a file.

fileLink.created Defines a new file link

This occurs whenever you create a file link.

fileLink.updated Defines an updated file link

This occurs whenever you update a file link.

fileLink.deleted Defines a deleted file link

This occurs whenever you delete a file link.

fulfillment.created Defines a new fulfillment

This occurs whenever you create a fulfillment.

manufacturer.created Defines a new manufacturer

This occurs whenever you create a manufacturer.

manufacturer.updated Defines an updated manufacturer

This occurs whenever you update a manufacturer.

manufacturer.deleted Defines a deleted manufacturer

This occurs whenever you delete a manufacturer.

order.created Defines a new order

This occurs whenever you create an order.

order.blocked Defines a blocked order

This occurs whenever you block an order.

order.charge.completed Defines a charge completed for an order

This occurs whenever a charge for an order has completed.

order.charge.capture.completed Defines charge capture completed for an order

This occurs whenever a charge for an order is captured and completed.

order.fulfilled Defines a fulfilled order

This occurs whenever you fulfill an order.

order.refunded Defines a refunded order

This occurs whenever you refund an order.

order.review_opened Defines an open review for an order

This occurs whenever you open a review for an order.

order.review_closed Defines a closed review for an order

This occurs whenever you close a review for an order.

order.updated Defines an updated order

This occurs whenever you update an order.

refund.created Defines a new refund

This occurs whenever you create a refund.

refund.updated Defines an updated refund

This occurs whenever you update a refund.

refund.succeeded Defines an updated refund

This occurs whenever a refund succeeds.

refund.failed Defines a failed refund

This occurs whenever a refund fails.

return.created Defines a new return

This occurs whenever you create a return.

return.updated Defines an updated return

This occurs whenever you update a return.

return.accepted Defines an accepted return

This occurs whenever you accept a return.

sku.created Defines a new SKU

This occurs whenever you create a SKU.

sku.deleted Defines a deleted SKU

This occurs whenever you delete a SKU.