WebhookEventTypeAsyncEnum Enum

Enum determining type of webhook.

Values

`ACCOUNT_CONFIRMATION_REQUESTED`

An account confirmation is requested.

`ACCOUNT_CHANGE_EMAIL_REQUESTED`

An account email change is requested.

`ACCOUNT_SET_PASSWORD_REQUESTED`

Setting a new password for the account is requested.

An order is confirmed (status change unconfirmed -> unfulfilled) by a staff user using the OrderConfirm mutation. It also triggers when the user completes the checkout and the shop setting automatically_confirm_all_new_orders is enabled.

`ORDER_PAID`

Payment has been made. The order may be partially or fully paid.

`ORDER_FULLY_PAID`

Payment is made and an order is fully paid.

`ORDER_REFUNDED`

The order received a refund. The order may be partially or fully refunded.

`ORDER_FULLY_REFUNDED`

The order is fully refunded.

`ORDER_UPDATED`

An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED.

`ORDER_CANCELLED`

An order is cancelled.

`ORDER_EXPIRED`

An order is expired.

`ORDER_FULFILLED`

An order is fulfilled.

`ORDER_METADATA_UPDATED`

An order metadata is updated.

`ORDER_BULK_CREATED`

Orders are imported.

`FULFILLMENT_CREATED`

A new fulfillment is created.

`FULFILLMENT_CANCELED`

A fulfillment is cancelled.

`FULFILLMENT_APPROVED`

A fulfillment is approved.

`FULFILLMENT_METADATA_UPDATED`

A fulfillment metadata is updated.

`FULFILLMENT_TRACKING_NUMBER_UPDATED`

`DRAFT_ORDER_CREATED`

A draft order is created.

`DRAFT_ORDER_UPDATED`

A draft order is updated.

`DRAFT_ORDER_DELETED`

A draft order is deleted.

`SALE_CREATED`

A sale is created.

`SALE_UPDATED`

A sale is updated.

`SALE_DELETED`

A sale is deleted.

`SALE_TOGGLE`

A sale is activated or deactivated.

`PROMOTION_CREATED`

A promotion is created.

`PROMOTION_UPDATED`

A promotion is updated.

`PROMOTION_DELETED`

A promotion is deleted.

`PROMOTION_STARTED`

A promotion is activated.

`PROMOTION_ENDED`

A promotion is deactivated.

`PROMOTION_RULE_CREATED`

A promotion rule is created.

`PROMOTION_RULE_UPDATED`

A promotion rule is updated.

`PROMOTION_RULE_DELETED`

A promotion rule is deleted.

`INVOICE_REQUESTED`

An invoice for order requested.

`INVOICE_DELETED`

An invoice is deleted.

`INVOICE_SENT`

Invoice has been sent.

`CUSTOMER_CREATED`

A new customer account is created.

`CUSTOMER_UPDATED`

A customer account is updated.

`CUSTOMER_DELETED`

A customer account is deleted.

`CUSTOMER_METADATA_UPDATED`

A customer account metadata is updated.

`COLLECTION_CREATED`

A new collection is created.

`COLLECTION_UPDATED`

A collection is updated.

`COLLECTION_DELETED`

A collection is deleted.

`COLLECTION_METADATA_UPDATED`

A collection metadata is updated.

`PRODUCT_CREATED`

A new product is created.

`PRODUCT_UPDATED`

A product is updated.

`PRODUCT_DELETED`

A product is deleted.

`PRODUCT_METADATA_UPDATED`

A product metadata is updated.

`PRODUCT_EXPORT_COMPLETED`

A product export is completed.

`PRODUCT_MEDIA_CREATED`

A new product media is created.

`PRODUCT_MEDIA_UPDATED`

A product media is updated.

`PRODUCT_MEDIA_DELETED`

A product media is deleted.

`PRODUCT_VARIANT_CREATED`

A new product variant is created.

`PRODUCT_VARIANT_UPDATED`

A product variant is updated.

`PRODUCT_VARIANT_DELETED`

A product variant is deleted. Warning: this event will not be executed when parent product has been deleted. Check PRODUCT_DELETED.

`PRODUCT_VARIANT_METADATA_UPDATED`

A product variant metadata is updated.

`PRODUCT_VARIANT_OUT_OF_STOCK`

A product variant is out of stock.

`PRODUCT_VARIANT_BACK_IN_STOCK`

A product variant is back in stock.

`PRODUCT_VARIANT_STOCK_UPDATED`

A product variant stock is updated

`CHECKOUT_CREATED`

A new checkout is created.

`CHECKOUT_UPDATED`

A checkout is updated. It also triggers all updates related to the checkout.

`CHECKOUT_FULLY_AUTHORIZED`

A checkout was fully authorized (its authorizeStatus is FULL).

This event is emitted only for checkouts whose payments are processed through the Transaction API.

`CHECKOUT_FULLY_PAID`

A checkout was fully paid (its chargeStatus is FULL or OVERCHARGED). This event is not sent if payments are only authorized but not fully charged.

This event is emitted only for checkouts whose payments are processed through the Transaction API.