Version: 3.x

WebhookEventTypeEnum

Enum determining type of webhook.

enum WebhookEventTypeEnum {
  ANY_EVENTS
  ACCOUNT_CONFIRMATION_REQUESTED
  ACCOUNT_CHANGE_EMAIL_REQUESTED
  ACCOUNT_EMAIL_CHANGED
  ACCOUNT_SET_PASSWORD_REQUESTED
  ACCOUNT_CONFIRMED
  ACCOUNT_DELETE_REQUESTED
  ACCOUNT_DELETED
  ADDRESS_CREATED
  ADDRESS_UPDATED
  ADDRESS_DELETED
  APP_INSTALLED
  APP_UPDATED
  APP_DELETED
  APP_STATUS_CHANGED
  ATTRIBUTE_CREATED
  ATTRIBUTE_UPDATED
  ATTRIBUTE_DELETED
  ATTRIBUTE_VALUE_CREATED
  ATTRIBUTE_VALUE_UPDATED
  ATTRIBUTE_VALUE_DELETED
  CATEGORY_CREATED
  CATEGORY_UPDATED
  CATEGORY_DELETED
  CHANNEL_CREATED
  CHANNEL_UPDATED
  CHANNEL_DELETED
  CHANNEL_STATUS_CHANGED
  CHANNEL_METADATA_UPDATED
  GIFT_CARD_CREATED
  GIFT_CARD_UPDATED
  GIFT_CARD_DELETED
  GIFT_CARD_SENT
  GIFT_CARD_STATUS_CHANGED
  GIFT_CARD_METADATA_UPDATED
  GIFT_CARD_EXPORT_COMPLETED
  MENU_CREATED
  MENU_UPDATED
  MENU_DELETED
  MENU_ITEM_CREATED
  MENU_ITEM_UPDATED
  MENU_ITEM_DELETED
  ORDER_CREATED
  ORDER_CONFIRMED
  ORDER_PAID
  ORDER_FULLY_PAID
  ORDER_REFUNDED
  ORDER_FULLY_REFUNDED
  ORDER_UPDATED
  ORDER_CANCELLED
  ORDER_EXPIRED
  ORDER_FULFILLED
  ORDER_METADATA_UPDATED
  ORDER_BULK_CREATED
  FULFILLMENT_CREATED
  FULFILLMENT_CANCELED
  FULFILLMENT_APPROVED
  FULFILLMENT_METADATA_UPDATED
  FULFILLMENT_TRACKING_NUMBER_UPDATED
  DRAFT_ORDER_CREATED
  DRAFT_ORDER_UPDATED
  DRAFT_ORDER_DELETED
  SALE_CREATED
  SALE_UPDATED
  SALE_DELETED
  SALE_TOGGLE
  PROMOTION_CREATED
  PROMOTION_UPDATED
  PROMOTION_DELETED
  PROMOTION_STARTED
  PROMOTION_ENDED
  PROMOTION_RULE_CREATED
  PROMOTION_RULE_UPDATED
  PROMOTION_RULE_DELETED
  INVOICE_REQUESTED
  INVOICE_DELETED
  INVOICE_SENT
  CUSTOMER_CREATED
  CUSTOMER_UPDATED
  CUSTOMER_DELETED
  CUSTOMER_METADATA_UPDATED
  COLLECTION_CREATED
  COLLECTION_UPDATED
  COLLECTION_DELETED
  COLLECTION_METADATA_UPDATED
  PRODUCT_CREATED
  PRODUCT_UPDATED
  PRODUCT_DELETED
  PRODUCT_METADATA_UPDATED
  PRODUCT_EXPORT_COMPLETED
  PRODUCT_MEDIA_CREATED
  PRODUCT_MEDIA_UPDATED
  PRODUCT_MEDIA_DELETED
  PRODUCT_VARIANT_CREATED
  PRODUCT_VARIANT_UPDATED
  PRODUCT_VARIANT_DELETED
  PRODUCT_VARIANT_METADATA_UPDATED
  PRODUCT_VARIANT_OUT_OF_STOCK
  PRODUCT_VARIANT_BACK_IN_STOCK
  PRODUCT_VARIANT_STOCK_UPDATED
  CHECKOUT_CREATED
  CHECKOUT_UPDATED
  CHECKOUT_FULLY_PAID
  CHECKOUT_METADATA_UPDATED
  NOTIFY_USER
  PAGE_CREATED
  PAGE_UPDATED
  PAGE_DELETED
  PAGE_TYPE_CREATED
  PAGE_TYPE_UPDATED
  PAGE_TYPE_DELETED
  PERMISSION_GROUP_CREATED
  PERMISSION_GROUP_UPDATED
  PERMISSION_GROUP_DELETED
  SHIPPING_PRICE_CREATED
  SHIPPING_PRICE_UPDATED
  SHIPPING_PRICE_DELETED
  SHIPPING_ZONE_CREATED
  SHIPPING_ZONE_UPDATED
  SHIPPING_ZONE_DELETED
  SHIPPING_ZONE_METADATA_UPDATED
  STAFF_CREATED
  STAFF_UPDATED
  STAFF_DELETED
  STAFF_SET_PASSWORD_REQUESTED
  TRANSACTION_ITEM_METADATA_UPDATED
  TRANSLATION_CREATED
  TRANSLATION_UPDATED
  WAREHOUSE_CREATED
  WAREHOUSE_UPDATED
  WAREHOUSE_DELETED
  WAREHOUSE_METADATA_UPDATED
  VOUCHER_CREATED
  VOUCHER_UPDATED
  VOUCHER_DELETED
  VOUCHER_METADATA_UPDATED
  VOUCHER_CODE_EXPORT_COMPLETED
  OBSERVABILITY
  THUMBNAIL_CREATED
  SHOP_METADATA_UPDATED
  PAYMENT_LIST_GATEWAYS
  PAYMENT_AUTHORIZE
  PAYMENT_CAPTURE
  PAYMENT_REFUND
  PAYMENT_VOID
  PAYMENT_CONFIRM
  PAYMENT_PROCESS
  CHECKOUT_CALCULATE_TAXES
  ORDER_CALCULATE_TAXES
  TRANSACTION_CHARGE_REQUESTED
  TRANSACTION_REFUND_REQUESTED
  TRANSACTION_CANCELATION_REQUESTED
  SHIPPING_LIST_METHODS_FOR_CHECKOUT
  CHECKOUT_FILTER_SHIPPING_METHODS
  ORDER_FILTER_SHIPPING_METHODS
  PAYMENT_GATEWAY_INITIALIZE_SESSION
  TRANSACTION_INITIALIZE_SESSION
  TRANSACTION_PROCESS_SESSION
  LIST_STORED_PAYMENT_METHODS
  STORED_PAYMENT_METHOD_DELETE_REQUESTED
  PAYMENT_GATEWAY_INITIALIZE_TOKENIZATION_SESSION
  PAYMENT_METHOD_INITIALIZE_TOKENIZATION_SESSION
  PAYMENT_METHOD_PROCESS_TOKENIZATION_SESSION
}
Expand ▼

Values

`WebhookEventTypeEnum.ANY_EVENTS`

All the events.

DEPRECATED: this value will be removed in Saleor 4.0.

`WebhookEventTypeEnum.ACCOUNT_CONFIRMATION_REQUESTED`

An account confirmation is requested.

`WebhookEventTypeEnum.ACCOUNT_CHANGE_EMAIL_REQUESTED`

An account email change is requested.

`WebhookEventTypeEnum.ACCOUNT_EMAIL_CHANGED`

An account email was changed

`WebhookEventTypeEnum.ACCOUNT_SET_PASSWORD_REQUESTED`

Setting a new password for the account is requested.

`WebhookEventTypeEnum.ACCOUNT_CONFIRMED`

An account is confirmed.

`WebhookEventTypeEnum.ACCOUNT_DELETE_REQUESTED`

An account delete is requested.

`WebhookEventTypeEnum.ACCOUNT_DELETED`

An account is deleted.

`WebhookEventTypeEnum.ADDRESS_CREATED`

A new address created.

`WebhookEventTypeEnum.ADDRESS_UPDATED`

An address updated.

`WebhookEventTypeEnum.ADDRESS_DELETED`

An address deleted.

`WebhookEventTypeEnum.APP_INSTALLED`

A new app installed.

`WebhookEventTypeEnum.APP_UPDATED`

An app updated.

`WebhookEventTypeEnum.APP_DELETED`

An app deleted.

`WebhookEventTypeEnum.APP_STATUS_CHANGED`

An app status is changed.

`WebhookEventTypeEnum.ATTRIBUTE_CREATED`

A new attribute is created.

`WebhookEventTypeEnum.ATTRIBUTE_UPDATED`

An attribute is updated.

`WebhookEventTypeEnum.ATTRIBUTE_DELETED`

An attribute is deleted.

`WebhookEventTypeEnum.ATTRIBUTE_VALUE_CREATED`

A new attribute value is created.

`WebhookEventTypeEnum.ATTRIBUTE_VALUE_UPDATED`

An attribute value is updated.

`WebhookEventTypeEnum.ATTRIBUTE_VALUE_DELETED`

An attribute value is deleted.

`WebhookEventTypeEnum.CATEGORY_CREATED`

A new category created.

`WebhookEventTypeEnum.CATEGORY_UPDATED`

A category is updated.

`WebhookEventTypeEnum.CATEGORY_DELETED`

A category is deleted.

`WebhookEventTypeEnum.CHANNEL_CREATED`

A new channel created.

`WebhookEventTypeEnum.CHANNEL_UPDATED`

A channel is updated.

`WebhookEventTypeEnum.CHANNEL_DELETED`

A channel is deleted.

`WebhookEventTypeEnum.CHANNEL_STATUS_CHANGED`

A channel status is changed.

`WebhookEventTypeEnum.CHANNEL_METADATA_UPDATED`

A channel metadata is updated.

`WebhookEventTypeEnum.GIFT_CARD_CREATED`

A new gift card created.

`WebhookEventTypeEnum.GIFT_CARD_UPDATED`

A gift card is updated.

`WebhookEventTypeEnum.GIFT_CARD_DELETED`

A gift card is deleted.

`WebhookEventTypeEnum.GIFT_CARD_SENT`

A gift card has been sent.
Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

`WebhookEventTypeEnum.GIFT_CARD_STATUS_CHANGED`

A gift card status is changed.

`WebhookEventTypeEnum.GIFT_CARD_METADATA_UPDATED`

A gift card metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.GIFT_CARD_EXPORT_COMPLETED`

A gift card export is completed.
Added in Saleor 3.16

`WebhookEventTypeEnum.MENU_CREATED`

A new menu created.

`WebhookEventTypeEnum.MENU_UPDATED`

A menu is updated.

`WebhookEventTypeEnum.MENU_DELETED`

A menu is deleted.

`WebhookEventTypeEnum.MENU_ITEM_CREATED`

A new menu item created.

`WebhookEventTypeEnum.MENU_ITEM_UPDATED`

A menu item is updated.

`WebhookEventTypeEnum.MENU_ITEM_DELETED`

A menu item is deleted.

`WebhookEventTypeEnum.ORDER_CREATED`

A new order is placed.

`WebhookEventTypeEnum.ORDER_CONFIRMED`

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.

`WebhookEventTypeEnum.ORDER_PAID`

Payment has been made. The order may be partially or fully paid.
Added in Saleor 3.14
This API is currently in Feature Preview and can be subject to changes at later point.

`WebhookEventTypeEnum.ORDER_FULLY_PAID`

Payment is made and an order is fully paid.

`WebhookEventTypeEnum.ORDER_REFUNDED`

The order received a refund. The order may be partially or fully refunded.
Added in Saleor 3.14
This API is currently in Feature Preview and can be subject to changes at later point.

`WebhookEventTypeEnum.ORDER_FULLY_REFUNDED`

The order is fully refunded.
Added in Saleor 3.14
This API is currently in Feature Preview and can be subject to changes at later point.

`WebhookEventTypeEnum.ORDER_UPDATED`

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

`WebhookEventTypeEnum.ORDER_CANCELLED`

An order is cancelled.

`WebhookEventTypeEnum.ORDER_EXPIRED`

An order is expired.

`WebhookEventTypeEnum.ORDER_FULFILLED`

An order is fulfilled.

`WebhookEventTypeEnum.ORDER_METADATA_UPDATED`

An order metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.ORDER_BULK_CREATED`

Orders are imported.
Added in Saleor 3.14
This API is currently in Feature Preview and can be subject to changes at later point.

`WebhookEventTypeEnum.FULFILLMENT_CREATED`

A new fulfillment is created.

`WebhookEventTypeEnum.FULFILLMENT_CANCELED`

A fulfillment is cancelled.

`WebhookEventTypeEnum.FULFILLMENT_APPROVED`

A fulfillment is approved.

`WebhookEventTypeEnum.FULFILLMENT_METADATA_UPDATED`

A fulfillment metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.FULFILLMENT_TRACKING_NUMBER_UPDATED`

`WebhookEventTypeEnum.DRAFT_ORDER_CREATED`

A draft order is created.

`WebhookEventTypeEnum.DRAFT_ORDER_UPDATED`

A draft order is updated.

`WebhookEventTypeEnum.DRAFT_ORDER_DELETED`

A draft order is deleted.

`WebhookEventTypeEnum.SALE_CREATED`

A sale is created.

`WebhookEventTypeEnum.SALE_UPDATED`

A sale is updated.

`WebhookEventTypeEnum.SALE_DELETED`

A sale is deleted.

`WebhookEventTypeEnum.SALE_TOGGLE`

A sale is activated or deactivated.

`WebhookEventTypeEnum.PROMOTION_CREATED`

A promotion is created.

`WebhookEventTypeEnum.PROMOTION_UPDATED`

A promotion is updated.

`WebhookEventTypeEnum.PROMOTION_DELETED`

A promotion is deleted.

`WebhookEventTypeEnum.PROMOTION_STARTED`

A promotion is activated.

`WebhookEventTypeEnum.PROMOTION_ENDED`

A promotion is deactivated.

`WebhookEventTypeEnum.PROMOTION_RULE_CREATED`

A promotion rule is created.

`WebhookEventTypeEnum.PROMOTION_RULE_UPDATED`

A promotion rule is updated.

`WebhookEventTypeEnum.PROMOTION_RULE_DELETED`

A promotion rule is deleted.

`WebhookEventTypeEnum.INVOICE_REQUESTED`

An invoice for order requested.

`WebhookEventTypeEnum.INVOICE_DELETED`

An invoice is deleted.

`WebhookEventTypeEnum.INVOICE_SENT`

Invoice has been sent.

`WebhookEventTypeEnum.CUSTOMER_CREATED`

A new customer account is created.

`WebhookEventTypeEnum.CUSTOMER_UPDATED`

A customer account is updated.

`WebhookEventTypeEnum.CUSTOMER_DELETED`

A customer account is deleted.

`WebhookEventTypeEnum.CUSTOMER_METADATA_UPDATED`

A customer account metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.COLLECTION_CREATED`

A new collection is created.

`WebhookEventTypeEnum.COLLECTION_UPDATED`

A collection is updated.

`WebhookEventTypeEnum.COLLECTION_DELETED`

A collection is deleted.

`WebhookEventTypeEnum.COLLECTION_METADATA_UPDATED`

A collection metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.PRODUCT_CREATED`

A new product is created.

`WebhookEventTypeEnum.PRODUCT_UPDATED`

A product is updated.

`WebhookEventTypeEnum.PRODUCT_DELETED`

A product is deleted.

`WebhookEventTypeEnum.PRODUCT_METADATA_UPDATED`

A product metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.PRODUCT_EXPORT_COMPLETED`

A product export is completed.
Added in Saleor 3.16

`WebhookEventTypeEnum.PRODUCT_MEDIA_CREATED`

A new product media is created.
Added in Saleor 3.12

`WebhookEventTypeEnum.PRODUCT_MEDIA_UPDATED`

A product media is updated.
Added in Saleor 3.12

`WebhookEventTypeEnum.PRODUCT_MEDIA_DELETED`

A product media is deleted.
Added in Saleor 3.12

`WebhookEventTypeEnum.PRODUCT_VARIANT_CREATED`

A new product variant is created.

`WebhookEventTypeEnum.PRODUCT_VARIANT_UPDATED`

A product variant is updated.

`WebhookEventTypeEnum.PRODUCT_VARIANT_DELETED`

A product variant is deleted.

`WebhookEventTypeEnum.PRODUCT_VARIANT_METADATA_UPDATED`

A product variant metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.PRODUCT_VARIANT_OUT_OF_STOCK`

A product variant is out of stock.

`WebhookEventTypeEnum.PRODUCT_VARIANT_BACK_IN_STOCK`

A product variant is back in stock.

`WebhookEventTypeEnum.PRODUCT_VARIANT_STOCK_UPDATED`

A product variant stock is updated

`WebhookEventTypeEnum.CHECKOUT_CREATED`

A new checkout is created.

`WebhookEventTypeEnum.CHECKOUT_UPDATED`

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

`WebhookEventTypeEnum.CHECKOUT_FULLY_PAID`

`WebhookEventTypeEnum.CHECKOUT_METADATA_UPDATED`

A checkout metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.NOTIFY_USER`

User notification triggered.

DEPRECATED: this value will be removed in Saleor 4.0. See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/docs/next/upgrade-guides/notify-user-deprecation

`WebhookEventTypeEnum.PAGE_CREATED`

A new page is created.

`WebhookEventTypeEnum.PAGE_UPDATED`

A page is updated.

`WebhookEventTypeEnum.PAGE_DELETED`

A page is deleted.

`WebhookEventTypeEnum.PAGE_TYPE_CREATED`

A new page type is created.

`WebhookEventTypeEnum.PAGE_TYPE_UPDATED`

A page type is updated.

`WebhookEventTypeEnum.PAGE_TYPE_DELETED`

A page type is deleted.

`WebhookEventTypeEnum.PERMISSION_GROUP_CREATED`

A new permission group is created.

`WebhookEventTypeEnum.PERMISSION_GROUP_UPDATED`

A permission group is updated.

`WebhookEventTypeEnum.PERMISSION_GROUP_DELETED`

A permission group is deleted.

`WebhookEventTypeEnum.SHIPPING_PRICE_CREATED`

A new shipping price is created.

`WebhookEventTypeEnum.SHIPPING_PRICE_UPDATED`

A shipping price is updated.

`WebhookEventTypeEnum.SHIPPING_PRICE_DELETED`

A shipping price is deleted.

`WebhookEventTypeEnum.SHIPPING_ZONE_CREATED`

A new shipping zone is created.

`WebhookEventTypeEnum.SHIPPING_ZONE_UPDATED`

A shipping zone is updated.

`WebhookEventTypeEnum.SHIPPING_ZONE_DELETED`

A shipping zone is deleted.

`WebhookEventTypeEnum.SHIPPING_ZONE_METADATA_UPDATED`

A shipping zone metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.STAFF_CREATED`

A new staff user is created.

`WebhookEventTypeEnum.STAFF_UPDATED`

A staff user is updated.

`WebhookEventTypeEnum.STAFF_DELETED`

A staff user is deleted.

`WebhookEventTypeEnum.STAFF_SET_PASSWORD_REQUESTED`

Setting a new password for the staff account is requested.

`WebhookEventTypeEnum.TRANSACTION_ITEM_METADATA_UPDATED`

Transaction item metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.TRANSLATION_CREATED`

A new translation is created.

`WebhookEventTypeEnum.TRANSLATION_UPDATED`

A translation is updated.

`WebhookEventTypeEnum.WAREHOUSE_CREATED`

A new warehouse created.

`WebhookEventTypeEnum.WAREHOUSE_UPDATED`

A warehouse is updated.

`WebhookEventTypeEnum.WAREHOUSE_DELETED`

A warehouse is deleted.

`WebhookEventTypeEnum.WAREHOUSE_METADATA_UPDATED`

A warehouse metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.VOUCHER_CREATED`

A new voucher created.

`WebhookEventTypeEnum.VOUCHER_UPDATED`

A voucher is updated.

`WebhookEventTypeEnum.VOUCHER_DELETED`

A voucher is deleted.

`WebhookEventTypeEnum.VOUCHER_METADATA_UPDATED`

A voucher metadata is updated.
Added in Saleor 3.8

`WebhookEventTypeEnum.VOUCHER_CODE_EXPORT_COMPLETED`

A voucher code export is completed.
Added in Saleor 3.18

`WebhookEventTypeEnum.OBSERVABILITY`

An observability event is created.

`WebhookEventTypeEnum.THUMBNAIL_CREATED`

A thumbnail is created.
Added in Saleor 3.12

`WebhookEventTypeEnum.SHOP_METADATA_UPDATED`

Shop metadata is updated.
Added in Saleor 3.15

`WebhookEventTypeEnum.PAYMENT_LIST_GATEWAYS`

Listing available payment gateways.

`WebhookEventTypeEnum.PAYMENT_AUTHORIZE`

Authorize payment.

`WebhookEventTypeEnum.PAYMENT_CAPTURE`

Capture payment.

`WebhookEventTypeEnum.PAYMENT_REFUND`

Refund payment.

`WebhookEventTypeEnum.PAYMENT_VOID`

Void payment.

`WebhookEventTypeEnum.PAYMENT_CONFIRM`

Confirm payment.

`WebhookEventTypeEnum.PAYMENT_PROCESS`

Process payment.

`WebhookEventTypeEnum.CHECKOUT_CALCULATE_TAXES`

Event called for checkout tax calculation.
Added in Saleor 3.6

`WebhookEventTypeEnum.ORDER_CALCULATE_TAXES`

Event called for order tax calculation.
Added in Saleor 3.6

`WebhookEventTypeEnum.TRANSACTION_CHARGE_REQUESTED`

Event called when charge has been requested for transaction.
Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

`WebhookEventTypeEnum.TRANSACTION_REFUND_REQUESTED`

Event called when refund has been requested for transaction.
Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

`WebhookEventTypeEnum.TRANSACTION_CANCELATION_REQUESTED`

Event called when cancel has been requested for transaction.
Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.