This article provides a list of Events that occur in WooCommerce which are then forwarded to Intercom. The Event Names follow a standard of beginning with order-
or subscription-
, followed by the current status of the Order or Subscription when the event occurs in WooCommerce; e.g., order-processing
, order-completed
.
The Events described here will show up inside Intercom when viewing a User's details, under the "Their activity" section. Here's an example of what this might look like inside your Intercom account when viewing a User's details:
Orders
Covers Orders of any Type, excluding shop_subscription
Order Type.
* Shop Subscriptions are handled separately; see below.
order-processing
order-completed
order-on-hold
order-cancelled
order-refunded
order-failed
- And others added by WooCommerce extensions.
Order statuses explained in greater detail below.
order-processing
- Payment received & stock reduced. Awaiting review/fulfillment.
order-on-hold
- Stock is reduced. Awaiting payment.
order-completed
- Order fulfilled and complete.
order-cancelled
- Cancelled by an admin or the customer.
order-refunded
- Refunded by an admin or via a payment gateway notification.
order-failed
- Payment failed or was declined (unpaid). Note that this status may not show immediately and instead show as pending until verified (e.g., PayPal).
Subscriptions
Specifically for shop_subscription
Order Type.
subscription-active
subscription-on-hold
subscription-cancelled
subscription-switched
subscription-expired
subscription-pending-cancel
- And others added by WooCommerce extensions.
Subscription statuses explained in greater detail below.
subscription-active
- The subscription becomes
active
; i.e., like acomplete
order status. Also occurs during a renewal; i.e.,on-hold
toactive
when payment goes through.
subscription-on-hold
- Also occurs before a renewal is processed, which could fail. If a renewal fails the
on-hold
status remains and it does not becomeactive
again. This is also another word forsuspend
; i.e., suspending a subscription puts iton-hold
.
subscription-cancelled
- Cancelled by an admin or user in one way or another, e.g., when a subscription reaches the end of a trial and there is no payment.
- A cancellation event may also occur after a
pending-cancel
status, e.g., when a cancellation occurs but prepaid time still remains. - Also occurs before a subscription is trashed/deleted.
- Also occurs when a parent order is trashed/deleted.
- Also occurs on max failed payments.
subscription-switched
- Via
woocommerce_subscriptions_switched_item
. A subscription item was switched to another.
subscription-expired
- This is a lot like
cancelled
, except this occurs whenever a subscription reaches a fixed end date; e.g., valid from A until B (expires on B date).
subscription-pending-cancel
- Cancelled by an admin or user in one way or another, e.g., when a cancellation occurs but prepaid time still remains. See official docs here: http://jas.xyz/1X0r6oC